Publishing Principles of the Website
🌄 Overview
The website administrator will release a new or modified page. Each page have been versioned and timestamped. This is important especially for the pages that update due to new set of dependencies, new standards, or changes in the industry. The website itself also has a version which can be seen on its release page. Below are set of guidelines on versioning of the contents.
📃 Guidelines for Web Pages
A page's version increases mathematically. A version that is mathematically highest is considered to be the latest version. This was inspired from mechanism of determining the page version base from a meta tag.
Page version consists of a major version (indicated by whole part), minor version (indicated by the fractional part), and optional suffix to override to a certain status.
🔁 List of Page Statuses
The page version is used to determine the status of the page. The pages alternate between the two statuses below.
📄 Draft
All pages start from 0.1-dev. Similar to the meta tag specification for page-version, any version that is mathematically smaller than one is also considered as draft. Any version with -dev suffix are considered to be in draft and are still being developed.
📰 Published
If a page is in published status, changes for that specific version have been applied. A page may update in the future in case there are changes in topic(s) it discusses, corrections in grammar or spellings, and other kinds of improvements in the content.
🔼 Update Triggers of Page Version
Page version increases depending on the size and influence of the change. Only text contents or properties inside the main structured data will be considered as changes. Changes in the shell and other components (with generalized text) will be ignored. Below is a non-exhaustive list of possible triggers.
🦐 Minor Update Triggers
Page version increase by 0.001 for every minor change. Due to this mechanism, a page is allowed to have 1000 minor versions starting from x. 000 until x. 999 where x is the major version. Below are examples that trigger a minor change.
- Correction in grammar and spellings
- Additions of information
- Removal of outdated information
- Updates of certain package(s) that is part of prerequisite to an article
🦣 Major Update Triggers
For invoked triggers to do a major update, the page version would be rounded up to the nearest whole number, regardless if there is a minor change included in the new version.
- Change in main data structure type
- Change in title, thus affecting URL, and other links.
📅 Notes about Timestamps
The date and time of a page, whether to indicate when it was published or modified, may be set up to 15 minutes into the future. The reason is to take account for the bundling time. Should a reader see that one of the dates and/or times is set into the future, the page is also in draft status until the time specified has arrived.
👉🏽 Referencing Others
For the articles, an attribution should be given to different individuals and groups of people. The components for attribution should be present as much as possible. Texts should be paraphrased as much as possible.
🕸️ Guidelines for the Whole Website
The website follows Semantic Versioning v2.0.0 because its code could be reused by other developers. A breaking change would happen if there is a change in the required properties of an interface.
References
Some portions in this article were based on third-party work(s) for educational purposes. They are copyright of the respective groups, organizations, companies, or persons that have been attributed below. Note that these works may have been shared under different licenses and may have notices (e.g. disclaimer of warranties) in the linked licenses. Should a work has no existing license(s), a link to the work have been still provided.