Commit Graph

181 Commits

Author SHA1 Message Date
Andrew David Wong
d2614cbd5f
Fix links 2021-06-17 09:23:17 -07:00
Andrew David Wong
76150ac9d3
Fix links 2021-06-17 07:01:53 -07:00
Andrew David Wong
6d81f95cc2
Update and reorganize documentation
- Convert "Common Tasks" to "How-to Guides"
  (QubesOS/qubes-issues#6694)
- Make title capitalization consistent across docs
- Fix leftover h1 headings
- Reorganize various pages and topics
- Update permalinks to better match titles
- Create redirects for changed permalinks
- Miscellaneous cleanup

QubesOS/qubes-issues#6701
2021-06-17 05:16:22 -07:00
Andrew David Wong
12408884dd
Clean up YAML titles and create redirect stubs
QubesOS/qubes-issues#6701
2021-06-17 02:40:43 -07:00
Andrew David Wong
84d3334325
Update doc guidelines about h1 headings and titles
QubesOS/qubes-issues#6701
2021-06-16 21:49:49 -07:00
Andrew David Wong
2c473241a8
Revert "Remove all instances of permalink: in YAML frontmatter"
This reverts commit c815e4c54c.

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862822827
2021-06-16 19:56:25 -07:00
Andrew David Wong
4ff7430960
Remove redundant h1 titles using # syntax
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-16 00:29:28 -07:00
Andrew David Wong
a4cbb51092
Remove vestigial '====' heading syntax
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:53:27 -07:00
Andrew David Wong
f822b70435
Remove redundant titles
First pass for all titles still using the old '=====' syntax

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:48:48 -07:00
Andrew David Wong
0c95b3ae4d
Revert "Remove instances of title: from YAML headers"
This reverts commit 24e6a8a616.

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:19:45 -07:00
Andrew David Wong
c815e4c54c
Remove all instances of permalink: in YAML frontmatter
Converts existing permalink paths into redirect_from entries.

QubesOS/qubes-issues#6701
2021-06-15 22:33:51 -07:00
Andrew David Wong
aca8ed14c7
Normalize instances of redirect_from:
QubesOS/qubes-issues#6701
2021-06-15 22:24:44 -07:00
Andrew David Wong
24e6a8a616
Remove instances of title: from YAML headers
QubesOS/qubes-issues#6701
2021-06-15 22:16:59 -07:00
Andrew David Wong
6043c6e51d
Improve documentation guidelines page
- Create separate section for editing doc index
- Link to how-to-edit-doc-index section in contrib guide
- Link to how-to-edit-doc-index section in core vs. external section
- Link to how-to-add-images section in contrib guide
- Add "PR" abbreviation for those unfamiliar (not used on this
  page but often used elsewhere and when linking to this page)

See QubesOS/qubes-issues#6694
2021-06-13 21:08:10 -07:00
herypt
90cf4497e4
Fix outdated documentation 2021-05-13 11:54:02 +02:00
Andrew David Wong
a660a92634
Merge branch 'resolve-transifex-issues' of https://github.com/tokideveloper/qubes-doc into tokideveloper-resolve-transifex-issues 2021-04-19 16:00:14 -07:00
Andrew David Wong
593f728ed6
Fix typo 2021-04-17 14:54:26 -07:00
Tobias Killer
190b740e32
Resolve open issues mentioned on Transifex 2021-04-17 10:31:11 +02:00
Tobias Killer
617330d026
Resolve open issues mentioned on Transifex 2021-04-16 19:45:56 +02:00
deeplow
bf64b68bcb
typo 2021-04-16 16:22:32 +00:00
Andrew David Wong
d2fa42c1e9
Merge branch 'md-refactoring-links' of https://github.com/tokideveloper/qubes-doc into tokideveloper-md-refactoring-links 2021-04-15 08:57:06 -07:00
Andrew David Wong
26f3a6567b
Fix broken link syntax cases
Thank you to Tokidev for pointing these out.
2021-04-12 13:40:09 -07:00
Tobias Killer
b6cb04c297
Refactor links in order to obey the new convention rule 2021-04-11 00:09:05 +02:00
Andrew David Wong
b546de3b8d
Merge branch 'md-convention-fullreflinks' of https://github.com/tokideveloper/qubes-doc into tokideveloper-md-convention-fullreflinks 2021-04-09 15:26:52 -07:00
Tobias Killer
7250daea53
Rewrite Markdown convention rule: Do not allow reference links 2021-04-09 09:30:39 +02:00
Andrew David Wong
248673e25e
Update instructions for adding doc index links
Discussed in QubesOS/qubes-issues#6426
2021-04-08 06:37:48 -07:00
Tobias Killer
ada42d7023
Add Markdown convention rule about full reference links 2021-04-08 11:25:36 +02:00
Marek Marczykowski-Górecki
16d88ced36
Add ref/lang to GSoD page
Commit this manually until CI is set for this task
2021-03-29 06:20:25 +02:00
Marek Marczykowski-Górecki
cbfdf2d7ca
Fix broken links on GSoD page 2021-03-29 02:33:16 +02:00
Marek Marczykowski-Górecki
752f1d4ddc
Fix over indented code blocks 2021-03-28 20:58:39 +02:00
Andrew David Wong
d328b1b1c9
Merge branch 'translation-prepare' of https://github.com/marmarek/qubes-doc into marmarek-translation-prepare 2021-03-26 20:46:10 -07:00
Michael Carbone
9c87e51d9c
fix formatting, remove duplicate past projects 2021-03-25 08:05:05 -04:00
Michael Carbone
84df7767fe
update GSoD page to follow application instructions
see instructions: https://developers.google.com/season-of-docs/docs/org-proposal-template
2021-03-25 07:28:11 -04:00
Maya
820af56761
Add lang + ref tags to frontmatter
Those are fields used by the language switcher to correlate pages across
different languages, even if they have different names/paths/titles.
They are generated with the prepare_for_translation.py script.
2021-03-14 16:18:11 +01:00
Maya
1a92224f8b
Remove content from pages dynamically filled in by a relevant layout
In fact, right now those pages content is duplicated - once included
here and once inserted by the doc-content (or hcl) layout.
2021-03-14 16:18:11 +01:00
Maya
8f8a8e50ea
Normalize frontmatter
- sort keys
- remove permalink from redirects
2021-03-14 16:18:10 +01:00
Maya
67a92614aa
Markdown formatting fixes
- mark all code blocks with ```
- unify empty lines between sections
- adjust list syntax (no space before dash)
- adjust headers to use Atx-style syntax
- remove trailing spaces
2021-03-14 16:18:10 +01:00
Maya
2bde7d07e0
Rename files to avoid dots in the path
This is problematic for Transifex API and also ease building
language-specific links.
2021-03-13 20:11:39 +01:00
Andrew David Wong
b55ef9ee68
Merge branch 'update-gsod' of https://github.com/PROTechThor/qubes-doc into PROTechThor-update-gsod 2021-03-10 21:47:46 -08:00
Marek Marczykowski-Górecki
948525f97a
Add some new projects for GSOC 2021 2021-02-18 02:17:59 +01:00
Marek Marczykowski-Górecki
a240458a8c
GSOC: Remove completed projects, hide in progress ones 2021-02-18 01:37:47 +01:00
Marek Marczykowski-Górecki
b2f5ff7ce5
Merge remote-tracking branch 'origin/pr/1116'
* origin/pr/1116:
  Updates for GSoC 2021
2021-02-18 01:34:09 +01:00
E. Cleopatra
b43e72a82c
Updates for GSoC 2021 2021-02-18 00:33:55 +01:00
E. Cleopatra
ff38102071
Update for GSoD 2021, Show past projects 2021-02-17 23:17:18 +01:00
Crsi
fae89440aa Removed a doubled 'placed' 2021-02-15 19:11:19 +01:00
deeplow
f9bc36676d
undo second link 2021-01-06 15:06:25 +00:00
deeplow
58cf8aecc8
fix broken links to github 2021-01-06 15:02:24 +00:00
Andrew David Wong
6e9d015c50
Add info on adding and updating community links in ToC
QubesOS/qubes-issues#4693
2020-12-25 08:21:46 -08:00
Robin Schneider
a14070badc
Update URL with 301 permanently moved HTTP status code 2020-12-21 17:38:17 +01:00
Robin Schneider
ec70076361
Use HTTPS everywhere (mechanical edit using util from https-everywhere)
Ref: https://github.com/EFForg/https-everywhere/tree/master/utils/rewriter

```Shell
~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js .
```
2020-12-19 19:57:07 +01:00