- Add info about major, minor, and patch releases
- Add info about common abbreviations
- Add links
- Improve language
- Improve formatting
- Fix typos
- Convert table from HTML to Markdown
I just copy & pasted this part of the page into an [answer on the forum](https://forum.qubes-os.org/t/6189/) and realized it would be nice if "External documentation" would also be hyperlinked. If there is a reason this was not done, please just ignore this PR.
I'm still not sure why these files have to be in qubes-doc in order to
appear in the doc index, but they do, so I'm moving them back even
though they're mostly empty.
The existing doc guidelines page attempts to combine too many different
topics at once and includes information that does not pertain directly
to the documentation. This reorganization is intended to make each type
of information easier to find. For example, some have found it difficult
to find the documentation style guidelines (see, e.g.,
QubesOS/qubes-issues#6701#issuecomment-875875610). This reorganization
allows us to assign more specific titles to each page.
General changes:
- Create new page for contribution instructions
- Create new page for website style guide
- Create new page for continuous integration
- Rename existing "style guide" to "visual style guide" in order to
avoid ambiguity with new doc and website style guides
- Retain existing page solely for doc style guide
- Update page names and permalinks
- Update existing links
- Improve language
Doc style guide changes:
- Add section on using sentence case in headings
(see QubesOS/qubes-issues#6756 and #1173)
- Improve section organization
- Clarify language
In order to better preserve the Git history of each file, file renames
will be handled in a separate commit.
- Update contribution steps and first two images
- Improve source formatting and consistency
- Add information
- Improve organization and add subheadings
- Clarify and improve wording
Those are redundant, and yaml parser strips them in fact. By removing
them, loading and saving yaml file without any change indeed produce the
same output. This is useful for prepare_for_translation.py script (which
adds lang and ref tags) - to produce only change that indeed was made.
