Commit Graph

7 Commits

Author SHA1 Message Date
Dave Smith
d01ad9c33e
Fix htmlproofer errors in PRs #1176 & #1177...
caused by hcl.md file rename in qubes-doc commit 7d894a59.
2021-07-16 01:15:15 -05:00
unman
d0bc9e70a2
Sentence case for titles 2021-07-09 01:06:41 +00:00
Andrew David Wong
c29cf40910
Reorganize doc guidelines into multiple pages; update style guide
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.
2021-07-08 08:08:57 -07:00
Andrew David Wong
65c3dd0f5e
Update "Issue Tracking"
- Reorder sections (https://github.com/QubesOS/qubes-doc/pull/1170#issuecomment-874019640)
- Add explanatory text
- Improve wording
- Append periods to complete declarative sentence headings
2021-07-05 05:05:56 -07:00
Andrew David Wong
308fadf650
Improve language and links 2021-06-21 18:50:25 -07:00
Andrew David Wong
0c3c2aa82d
Update "Issue Tracking"
- Improve section organization
- Improve new issue instructions
- Add section on "projects"
- Convert final section into "How issues get closed"
- Add section on backports (closes QubesOS/qubes-issues#6655)
2021-06-21 01:43:38 -07:00
Andrew David Wong
f860726c93
Rename file to match new title 2021-06-21 00:31:01 -07:00