Commit Graph

136 Commits

Author SHA1 Message Date
Andrew David Wong
83c93a3c2a
Add section on English language conventions 2023-05-05 13:08:33 -07:00
Andrew David Wong
3def6f0aa6
Update line wrapping policy
See https://github.com/QubesOS/qubes-issues/issues/2639#issuecomment-1536615048
2023-05-05 12:59:07 -07:00
Andrew David Wong
2857445c6d
Unwrap text 2023-05-05 12:55:34 -07:00
resulin
2ea6c5a550
Update usability-ux.md
www.kde.org redirects to kde.org
2023-04-26 17:00:53 +00:00
resulin
92bf06636c
Update usability-ux.md: Bump mentioned Qubes OS version and fix/update some links
http://learndesignprinciples.com is now defunct, replaced it with a wayback machine link: https://web.archive.org/web/20180101172357/http://learndesignprinciples.com
2023-04-26 16:33:58 +00:00
Andrew David Wong
acc710bc8c
Update GSoD 2023 project idea 2023-03-04 17:35:20 -08:00
Andrew David Wong
da7794d9be
Add section on the capitalization of "qube"
Related to QubesOS/qubes-issues#8057
2023-03-04 15:29:43 -08:00
Andrew David Wong
fd0b5d83c3
Update and clean up GSoD page for 2023 2023-02-15 21:38:00 -08:00
Andrew David Wong
e357e817e8
Update and clean up GSoD page for 2023 2023-02-15 21:21:11 -08:00
Andrew David Wong
365d923493
Improve wording 2023-02-02 16:27:32 -08:00
Andrew David Wong
231021a2dd
Add sections on alerts and using Markdown syntax for styling 2023-02-02 16:19:31 -08:00
Andrew David Wong
a3bbdfc35e
Add missing forward slash to URL
The link is not actually broken. It already works, since your browser
just adds the missing forward slash automatically. This just makes it
technically syntactically correct.

https://groups.google.com/g/qubes-devel/c/ASj7tehn1G0/m/jhLmFjdMBwAJ
2022-09-08 16:56:51 -07:00
Andrew David Wong
b80628e2cf
Remove unused, deprecated page
https://groups.google.com/g/qubes-devel/c/ASj7tehn1G0/m/jhLmFjdMBwAJ
2022-09-08 16:56:16 -07:00
Marek Marczykowski-Górecki
a1a6e80d84
Document PipelineRetryFailed
https://github.com/fepitre/qubes-g2g-continuous-integration/pull/3
2022-07-22 15:31:01 +02:00
Marek Marczykowski-Górecki
35a7fc5736
GSoC: fill in project difficulties and size 2022-02-25 20:53:20 +01:00
Marek Marczykowski-Górecki
5ac871d85a
gsoc: update projects list
- wayland is in progress
- add system health monitor
- remove qvm-create-windows-qube - already exists in the community
- add link to GSoC 2021 archive
2022-02-21 17:07:52 +01:00
Michael Carbone
8cb3af767a
updated language gsoc
updated "student" -> "contributor", made accurate timeline.

see https://opensource.googleblog.com/2021/11/expanding-google-summer-of-code-in-2022.html for more info.
2022-02-21 04:30:54 -05:00
Andrew David Wong
4634c8c7d9
Update links (QubesOS/qubes-issues#7119) 2022-02-02 19:46:02 -08:00
Andrew David Wong
3da0cd8e8e
Fix link URL and title; wrap text 2021-09-06 15:59:45 -07:00
Sven Semmler
c00bdec059
add link to external documentation
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.
2021-09-06 16:40:54 -05:00
Andrew David Wong
a3364eed21
Remove specific Qubes version refs and warn against this mistake 2021-08-13 02:45:58 -07:00
Andrew David Wong
a605052c80
Add "videos" 2021-08-03 15:11:12 -07:00
Andrew David Wong
ee309abd0a
Attempt to document PipelineRefresh
See https://github.com/QubesOS/qubes-posts/pull/82#issuecomment-888231099
2021-07-28 22:20:39 -07:00
Andrew David Wong
db56549748
Move files back to qubes-doc so they can appear in index
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.
2021-07-14 11:20:16 -07:00
Andrew David Wong
6eea2bf394
Fix typo 2021-07-10 15:03:56 -07:00
Andrew David Wong
e89bc971ae
Update terminology 2021-07-10 14:47:15 -07:00
Andrew David Wong
a1967f09ad
Fix typo 2021-07-10 14:19:45 -07:00
Andrew David Wong
ef3440228f
Cross-link doc style guide and how-to pages 2021-07-10 13:49:27 -07:00
Andrew David Wong
b9bf32e6f8
Add section on serving website locally 2021-07-10 13:19:24 -07:00
Andrew David Wong
6de3d7f75f
Fix typo 2021-07-10 13:16:07 -07:00
Andrew David Wong
473f1075c8
Update example to reflect current style guide 2021-07-10 13:08:13 -07:00
Andrew David Wong
f608865417
Update doc style guide and instructions
- Explain why image linking is important
- Improve wording
- Fix link
- Minor improvements
2021-07-10 12:52:48 -07:00
Andrew David Wong
294e433b3d
Remove note about QubesOS/qubes-issues#6769 (fixed) 2021-07-09 05:19:05 -07:00
Andrew David Wong
a18174dc5e
Fix capitalization; update terms (QubesOS/qubes-issues#6769)
Thank you to @unman for the initial sentence case pass.
2021-07-09 05:10:44 -07:00
Andrew David Wong
ad2c60d91d
Merge branch '6769' of https://github.com/unman/qubes-doc into unman-6769 2021-07-09 04:23:31 -07:00
unman
d0bc9e70a2
Sentence case for titles 2021-07-09 01:06:41 +00:00
Andrew David Wong
e09d2d4c7a
Use shorter anchor text for doc index link 2021-07-08 10:17:34 -07:00
Andrew David Wong
bc5276a290
Improve section organization, formatting; fix link 2021-07-08 10:14:31 -07:00
Andrew David Wong
a867dbe06a
Add note about QubesOS/qubes-issues#6769 2021-07-08 08:24:13 -07:00
Andrew David Wong
d9ce14a1d0
Rename files in accordance with commit 676a13b 2021-07-08 08:09:41 -07: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
07da69bc0e
Revamp "Documentation Guidelines"
- Update contribution steps and first two images
- Improve source formatting and consistency
- Add information
- Improve organization and add subheadings
- Clarify and improve wording
2021-07-06 06:25:33 -07:00
Andrew David Wong
5220089b53
Update references to "Getting Started"
QubesOS/qubes-issues#6756
2021-07-03 03:46:27 -07:00
Andrew David Wong
fd6c8e28f8
Document wwwtest vs. wwwpreview
QubesOS/qubes-issues#6747
2021-06-29 15:44:02 -07:00
Andrew David Wong
3253b6b91e
Update TestDeploy documentation
QubesOS/qubes-issues#6747
2021-06-29 14:58:18 -07:00
Andrew David Wong
dc22de87ab
Document TestDeploy 2021-06-29 14:23:26 -07:00
Andrew David Wong
decc4135f9
Add CI section; document PipelineRetry command (#1149) 2021-06-27 22:35:56 -07:00
Andrew David Wong
1c5aab4340
Add guidelines regarding angled brackets around variables
Added in response to:
https://qubes-os.discourse.group/t/how-can-i-create-a-template-hvm-of-any-os/4676

Also updates terminology and clarifies wording.
2021-06-27 22:25:46 -07:00
Marek Marczykowski-Górecki
3806ecf338
Remove extra newlines at the beginning/end of files
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.
2021-06-24 16:07:23 +02:00
Andrew David Wong
d145143261
Update Qubes Canary page link 2021-06-22 10:55:21 -07:00