Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-12-24 06:49:34 -05:00
Code Issues Packages Projects Releases Wiki Activity
All Qubes OS Project documentation pages are stored as plain text files in this dedicated repository. By cloning and regularly pulling from this repo, users can maintain their own up-to-date offline copy of all Qubes documentation rather than relying solely on the Web.
6,345 Commits 5 Branches 2,526 Tags 87 MiB
Makefile 51.8%
Python 48.2%
c29cf40910
Go to file
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
_dev Use HTTPS everywhere (mechanical edit using util from https-everywhere) 2020-12-19 19:57:07 +01:00
developer Reorganize doc guidelines into multiple pages; update style guide 2021-07-08 08:08:57 -07:00
external Revert "Remove instances of title: from YAML headers" 2021-06-15 23:19:45 -07:00
introduction Reorganize doc guidelines into multiple pages; update style guide 2021-07-08 08:08:57 -07:00
project-security Update Qubes Forum URLs 2021-07-01 07:03:05 -07:00
user Reorganize doc guidelines into multiple pages; update style guide 2021-07-08 08:08:57 -07:00
.gitlab-ci.yml gitlab-ci: use local project reference 2020-11-27 03:55:05 +01:00
.travis.yml Update travis to bionic 2020-09-29 15:12:04 +02:00
CONTRIBUTING.md Reorganize doc guidelines into multiple pages; update style guide 2021-07-08 08:08:57 -07:00
doc.md Update layout 2021-06-22 04:27:32 -07:00
README.md Reorganize doc guidelines into multiple pages; update style guide 2021-07-08 08:08:57 -07:00

README.md

Qubes OS Documentation

Canonical URL: https://www.qubes-os.org/doc/

All Qubes OS Project documentation pages are stored as plain text files in this dedicated repository. By cloning and regularly pulling from this repo, users can maintain their own up-to-date offline copy of all Qubes documentation rather than relying solely on the Web.

To contribute, please see how to edit the documentation.