144 Commits

Author	SHA1	Message	Date
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
Andrew David Wong	6cc2f9932b	Update QSB page link	2021-06-22 10:50:12 -07:00
Andrew David Wong	1a4365fadb	Clarify intention and context of coding conventions	2021-06-22 06:05:53 -07:00
Andrew David Wong	c8752a2a57	Add "Coding conventions" section	2021-06-22 05:21:02 -07:00
Andrew David Wong	f86d6c58c6	Move "Research" page to main repo ... This file no longer contains any significant content.	2021-06-21 22:10:09 -07:00
Andrew David Wong	673629c976	Update doc index link	2021-06-21 21:03:28 -07:00
Andrew David Wong	527a2eb339	Update links	2021-06-21 00:38:18 -07:00
Andrew David Wong	2dbc8865e1	Use doc layout instead of sidebar layout ... There appears to be no strong reason that these pages are using a different layout, and having this separate layout significantly increases the ongoing doc maintenance burden.	2021-06-19 20:39:34 -07:00
Andrew David Wong	07c130df00	Wrap text and miscellaneous cleanup	2021-06-18 06:25:06 -07:00
Andrew David Wong	e451f92cde	Update attachment paths	2021-06-18 05:46:02 -07:00
Andrew David Wong	60bd80ad25	Revert "Update attachment paths" ... This reverts commit e5a21f7488.	2021-06-18 05:39:47 -07:00
Andrew David Wong	863f0ee9bd	Revert "Fix image example; wrap text" ... This reverts commit 7d7ca0c592.	2021-06-18 05:39:28 -07:00
Andrew David Wong	7d7ca0c592	Fix image example; wrap text	2021-06-18 05:27:55 -07:00
Andrew David Wong	b1d6139120	Restore hard wrapping at 80 characters ... Turns out it's not a problem for localization, and it has significant benefits. See the discussion on QubesOS/qubes-issues#2639 for details.	2021-06-18 05:17:57 -07:00
Andrew David Wong	e5a21f7488	Update attachment paths	2021-06-18 05:02:02 -07:00
Andrew David Wong	d2614cbd5f	Fix links	2021-06-17 09:23:17 -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
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
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
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
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
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
Andrew David Wong	7610a66873	Update doc guidelines to reflect completed migration ... https://github.com/QubesOS/qubes-issues/issues/4693	2020-12-07 22:57:40 -08:00
Andrew David Wong	c02686c6df	Update guidance regarding relative vs. absolute links	2020-12-07 17:09:34 -08:00
Andrew David Wong	30e7112f4a	Convert absolute to relative links ... Absolute links break automatic onion redirection: https://groups.google.com/g/qubes-users/c/NJdzP27wvmM/	2020-12-07 17:04:29 -08:00
Andrew David Wong	c1f1ee902c	Update image linking syntax; use syntax on same page	2020-12-01 21:37:45 -08:00
Andrew David Wong	d33cd36170	Update examples; fix typo	2020-12-01 21:29:22 -08:00
Andrew David Wong	2c3293ddd1	Add missing link	2020-11-29 12:47:10 -08:00
Andrew David Wong	fa826f6066	Add guidelines on duplication and core vs. external docs ... - Add new "Organizationl guidelines" section - Add some relevant links in other sections - Update heading syntax to account for new h3s - Normalize heading case	2020-11-29 12:43:48 -08:00
Andrew David Wong	63379e80c6	Remove reference-style link guideline ... Closes #1096	2020-11-23 10:17:10 -08:00
Andrew David Wong	3df2ffa6f6	Add guideline on syntactically distinguishing variables in commands	2020-11-23 07:08:35 -08:00
Andrew David Wong	17021f6cb7	Update doc guidelines regarding HTML, CSS, and images	2020-11-18 22:26:22 -08:00
Andrew David Wong	0e5a97785c	Add information about doc review security	2020-10-27 19:23:57 -07:00
Andrew David Wong	e87bb670ee	Add instructions for installing contributed packages	2020-10-19 11:39:51 -07:00
Andrew David Wong	9b9d291256	Recommend universal Atx-style headings	2020-08-29 15:42:03 -05:00
Mostafa Bestawy	9187fed18e	Update gsod.md ... fixing a grammar mistake.	2020-07-16 23:56:45 +09:00
Mostafa Bestawy	5756ccb2f2	Update gsod.md ... Adding project idea for Installation guide for virtual machines.	2020-07-15 05:39:37 +09:00
Frédéric Pierret (fepitre)	da5f688cbd	contrib: add link to example package qubes-skeleton	2020-07-09 18:14:04 +02:00
3hhh	0238a41934	added Admin API Fuzzer idea	2020-06-18 17:14:12 +02:00
Andrew David Wong	d0bbce3967	Remove reference to deleted section	2020-05-18 09:29:34 -05:00
Andrew David Wong	39895d552a	Merge branch 'first-patch' of https://github.com/sarru1291/qubes-doc into sarru1291-first-patch	2020-05-14 07:50:13 -05:00
Marek Marczykowski-Górecki	a27bbfc8b2	Remove completed GSoD projects	2020-05-13 14:22:59 +02:00
Sarvottam Kumar	a68bef9933	fix incorrect self-link in gsod.md	2020-05-12 23:57:56 +05:30
Andrew David Wong	a15c7e7f46	Merge branch 'patch-22' of https://github.com/mfc/qubes-doc into mfc-patch-22	2020-04-15 04:55:40 -05:00
Michael Carbone	3e783a4fcc	updated to 2020 GSoD ... removed 2019 project, updated links, added links to 2019 project.	2020-04-14 10:36:44 -04:00
Michael Carbone	696f507fc3	update link to 2020 GSoC Qubes page	2020-04-14 09:58:40 -04:00
Marek Marczykowski-Górecki	c254b11a85	GSoC: link one more issue to template manager idea	2020-02-16 21:00:23 +01:00
Marta Marczykowska-Górecka	6ced25e79b	Updates for GSC 2020 ... Commented out various obsolete projects, removed one that is genuinely done.	2020-01-30 22:59:42 +01:00
Frédéric Pierret (fepitre)	96069def46	contrib: improvements from Marek's comments	2019-11-11 17:37:12 +01:00
Andrew David Wong	a550680600	Fix typos	2019-11-08 21:27:16 -06:00
Frédéric Pierret (fepitre)	e5bfb48f8d	contrib: improvements from Marek's suggestions	2019-11-08 22:01:59 +01:00
Frédéric Pierret (fepitre)	20d8da525b	contrib: precise QCR review procedure	2019-11-08 19:58:10 +01:00
Andrew David Wong	35e7f92bc7	Do not strictly require Atx-style headings on both sides ... Having the headings on both the left and right sides is more difficult to edit and maintain, and not much is gained from having them on both sides. It's still fine to have them on both sides, but this is a stylistic choice left to the author.	2019-08-09 22:01:50 -05:00
Andrew David Wong	d31c786942	Reorganize files to account for new "External" section ... QubesOS/qubes-issues#4693	2019-05-26 19:32:45 -05:00