diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1167191a..85508883 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -4,3 +4,6 @@ include: build:website: extends: .website + script: + - git clone https://gitlab.com/${CI_PROJECT_PATH%%/*}/qubesos.github.io ~/qubesos.github.io -b test + - ~/qubesos.github.io/_utils/gitlabci.sh diff --git a/.gitmodules b/.gitmodules index 7b7703fa..edc87fe8 100644 --- a/.gitmodules +++ b/.gitmodules @@ -4,9 +4,6 @@ [submodule "_posts"] path = _posts url = https://github.com/QubesOS/qubes-posts -[submodule "_doc"] - path = _doc - url = https://github.com/QubesOS/qubes-doc [submodule "_hcl"] path = _hcl url = https://github.com/QubesOS/qubes-hcl diff --git a/_data/architecture.yml b/_data/architecture.yml index 5ca55358..c9d1c9a8 100644 --- a/_data/architecture.yml +++ b/_data/architecture.yml @@ -59,25 +59,25 @@ icon: fa-book sub-pages: - title: Introduction - url: /doc/#introduction + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#introduction - title: Choosing hardware - url: /doc/#choosing-your-hardware + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#choosing-your-hardware - title: Installing and upgrading - url: /doc/#downloading-installing-and-upgrading-qubes + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#downloading-installing-and-upgrading-qubes - title: How-to guides - url: /doc/#how-to-guides + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#how-to-guides - title: Templates - url: /doc/#templates + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#templates - title: Troubleshooting - url: /doc/#troubleshooting + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#troubleshooting - title: Security in Qubes - url: /doc/#security-in-qubes + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#security-in-qubes - title: Project security - url: /doc/#project-security + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#project-security - title: Developer docs - url: /doc/#developer-documentation + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#developer-documentation - title: External docs - url: /doc/#external-documentation + url: https://qubes-doc-rst.readthedocs.io/en/latest/index.html#external-documentation - title: News url: /news/ diff --git a/_data/downloads-page.yml b/_data/downloads-page.yml index 79248e0b..9c52190a 100644 --- a/_data/downloads-page.yml +++ b/_data/downloads-page.yml @@ -40,5 +40,5 @@ - column: Location - column: URL links: - - url: /downloads/mirrors/#instructions-for-mirror-operators + - url: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/download-mirrors.html#instructions-for-mirror-operators text: How to contribute a download mirror diff --git a/_data/hcl.yml b/_data/hcl.yml index a47565b0..15974adb 100644 --- a/_data/hcl.yml +++ b/_data/hcl.yml @@ -10,7 +10,7 @@ - url: '#hardware-motherboards' text: Motherboards id: 3 - - url: /doc/how-to-use-the-hcl/#generating-and-submitting-new-reports + - url: https://qubes-doc-rst.readthedocs.io/en/latest/user/hardware/how-to-use-the-hcl.html#generating-and-submitting-new-reports text: Add your device id: 4 @@ -20,7 +20,7 @@ - url: /doc/how-to-use-the-hcl/ text: What is the hardware compatibility list (HCL)? id: 1 - - url: /doc/how-to-use-the-hcl/#generating-and-submitting-new-reports + - url: https://qubes-doc-rst.readthedocs.io/en/latest/user/hardware/how-to-use-the-hcl.html#generating-and-submitting-new-reports text: How do I submit a report? id: 2 - url: /doc/system-requirements/ diff --git a/_doc b/_doc deleted file mode 160000 index 206f7f20..00000000 --- a/_doc +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 206f7f20865ede1af6ae80495831128bcee6d04d diff --git a/_doc/_dev/.gitignore b/_doc/_dev/.gitignore new file mode 100644 index 00000000..e35d8850 --- /dev/null +++ b/_doc/_dev/.gitignore @@ -0,0 +1 @@ +_build diff --git a/_doc/_dev/Makefile b/_doc/_dev/Makefile new file mode 100644 index 00000000..642e3223 --- /dev/null +++ b/_doc/_dev/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://www.sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/QubesOSDeveloper.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/QubesOSDeveloper.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/QubesOSDeveloper" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/QubesOSDeveloper" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/_doc/_dev/_static/.gitignore b/_doc/_dev/_static/.gitignore new file mode 100644 index 00000000..e69de29b diff --git a/_doc/_dev/_templates/.gitignore b/_doc/_dev/_templates/.gitignore new file mode 100644 index 00000000..e69de29b diff --git a/_doc/_dev/conf.py b/_doc/_dev/conf.py new file mode 100644 index 00000000..c643b145 --- /dev/null +++ b/_doc/_dev/conf.py @@ -0,0 +1,193 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Qubes OS developer's documentation build configuration file, created by +# sphinx-quickstart on Tue May 30 16:30:03 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import os +import sys +import datetime + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Qubes OS' +copyright = '2010-{:%Y}, Invisible Things Lab'.format(datetime.date.today()) + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = 'R4' +# The full version, including alpha/beta/rc tags. +release = 'R4.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +today_fmt = '%Y-%m-%d' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'QubesOSdev' + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'python': ('https://docs.python.org/', None), +# 'core-admin': ('https://dev.qubes-os.org/projects/core-admin/en/latest/', None), +} + +# vim: ts=4 sts=4 sw=4 et diff --git a/_doc/_dev/index.rst b/_doc/_dev/index.rst new file mode 100644 index 00000000..39488eb6 --- /dev/null +++ b/_doc/_dev/index.rst @@ -0,0 +1,9 @@ +Welcome to Qubes OS developer's documentation! +============================================== + +This is documentation for the source code. Please choose specific repostitory: + +* `core-admin `_ +* `core-admin-client `_ + +Or see `the main Qubes OS documentation `_. diff --git a/_doc/developer/building/development-workflow.md b/_doc/developer/building/development-workflow.md new file mode 100644 index 00000000..9a01361f --- /dev/null +++ b/_doc/developer/building/development-workflow.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/development-workflow/ +redirect_from: +- /en/doc/development-workflow/ +- /doc/DevelopmentWorkflow/ +- /wiki/DevelopmentWorkflow/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/building/development-workflow.html +ref: 66 +title: Development workflow +--- \ No newline at end of file diff --git a/_doc/developer/building/qubes-builder-details.md b/_doc/developer/building/qubes-builder-details.md new file mode 100644 index 00000000..73e87729 --- /dev/null +++ b/_doc/developer/building/qubes-builder-details.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/qubes-builder-details/ +redirect_from: +- /en/doc/qubes-builder-details/ +- /doc/QubesBuilderDetails/ +- /wiki/QubesBuilderDetails/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/building/qubes-builder-details.html +ref: 65 +title: Qubes builder details +--- \ No newline at end of file diff --git a/_doc/developer/building/qubes-builder.md b/_doc/developer/building/qubes-builder.md new file mode 100644 index 00000000..8bc47b3c --- /dev/null +++ b/_doc/developer/building/qubes-builder.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/qubes-builder/ +redirect_from: +- /en/doc/qubes-builder/ +- /doc/QubesBuilder/ +- /wiki/QubesBuilder/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/building/qubes-builder.html +ref: 64 +title: Qubes builder +--- \ No newline at end of file diff --git a/_doc/developer/building/qubes-iso-building.md b/_doc/developer/building/qubes-iso-building.md new file mode 100644 index 00000000..8a7b8bc5 --- /dev/null +++ b/_doc/developer/building/qubes-iso-building.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/qubes-iso-building/ +redirect_from: +- /doc/qubes-r3-building/ +- /en/doc/qubes-r3-building/ +- /en/doc/qubes-iso-building/ +- /doc/QubesR3Building/ +- /wiki/QubesR3Building/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/building/qubes-iso-building.html +ref: 63 +title: Qubes ISO building +--- \ No newline at end of file diff --git a/_doc/developer/building/qubes-template-configs.md b/_doc/developer/building/qubes-template-configs.md new file mode 100644 index 00000000..b6f815de --- /dev/null +++ b/_doc/developer/building/qubes-template-configs.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/qubes-template-configs/ +redirect_to: https://github.com/QubesOS/qubes-template-configs +ref: 248 +title: Qubes template configs +--- \ No newline at end of file diff --git a/_doc/developer/code/code-signing.md b/_doc/developer/code/code-signing.md new file mode 100644 index 00000000..fcae34de --- /dev/null +++ b/_doc/developer/code/code-signing.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/code-signing/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/code/code-signing.html +ref: 51 +title: Code signing +--- \ No newline at end of file diff --git a/_doc/developer/code/coding-style.md b/_doc/developer/code/coding-style.md new file mode 100644 index 00000000..a323d8a7 --- /dev/null +++ b/_doc/developer/code/coding-style.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/coding-style/ +redirect_from: +- /en/doc/coding-style/ +- /doc/CodingStyle/ +- /wiki/CodingStyle/ +- /trac/wiki/CodingStyle/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/code/coding-style.html +ref: 53 +title: Coding style +--- \ No newline at end of file diff --git a/_doc/developer/code/license.md b/_doc/developer/code/license.md new file mode 100644 index 00000000..22bb881b --- /dev/null +++ b/_doc/developer/code/license.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/license/ +redirect_from: +- /en/doc/license/ +- /doc/QubesLicensing/ +- /wiki/QubesLicensing/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/code/license.html +ref: 52 +title: Software license +--- \ No newline at end of file diff --git a/_doc/developer/code/source-code.md b/_doc/developer/code/source-code.md new file mode 100644 index 00000000..c344a8f6 --- /dev/null +++ b/_doc/developer/code/source-code.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/source-code/ +redirect_from: +- /en/doc/source-code/ +- /doc/SourceCode/ +- /wiki/SourceCode/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/code/source-code.html +ref: 54 +title: Source code +--- \ No newline at end of file diff --git a/_doc/developer/debugging/automated-tests.md b/_doc/developer/debugging/automated-tests.md new file mode 100644 index 00000000..a5b4c806 --- /dev/null +++ b/_doc/developer/debugging/automated-tests.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/automated-tests/ +redirect_from: +- /en/doc/automated-tests/ +- /doc/AutomatedTests/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/debugging/automated-tests.html +ref: 45 +title: Automated tests +--- \ No newline at end of file diff --git a/_doc/developer/debugging/mount-lvm-image.md b/_doc/developer/debugging/mount-lvm-image.md new file mode 100644 index 00000000..d66e3ac5 --- /dev/null +++ b/_doc/developer/debugging/mount-lvm-image.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/mount-lvm-image/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/debugging/mount-lvm-image.html +ref: 46 +title: How to mount LVM images +--- \ No newline at end of file diff --git a/_doc/developer/debugging/safe-remote-ttys.md b/_doc/developer/debugging/safe-remote-ttys.md new file mode 100644 index 00000000..a4e821e4 --- /dev/null +++ b/_doc/developer/debugging/safe-remote-ttys.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/safe-remote-ttys/ +redirect_from: +- /en/doc/safe-remote-ttys/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/debugging/safe-remote-ttys.html +ref: 49 +title: Safe remote dom0 terminals +--- \ No newline at end of file diff --git a/_doc/developer/debugging/test-bench.md b/_doc/developer/debugging/test-bench.md new file mode 100644 index 00000000..9e96cb8b --- /dev/null +++ b/_doc/developer/debugging/test-bench.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/test-bench/ +redirect_from: +- /en/doc/test-bench/ +- /doc/TestBench/ +- /wiki/TestBench/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/debugging/test-bench.html +ref: 44 +title: How to set up a test bench +--- \ No newline at end of file diff --git a/_doc/developer/debugging/vm-interface.md b/_doc/developer/debugging/vm-interface.md new file mode 100644 index 00000000..a2c1d883 --- /dev/null +++ b/_doc/developer/debugging/vm-interface.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/vm-interface/ +redirect_from: +- /en/doc/vm-interface/ +- /doc/VMInterface/ +- /doc/SystemDoc/VMInterface/ +- /wiki/SystemDoc/VMInterface/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/debugging/vm-interface.html +ref: 47 +title: Qube configuration interface +--- \ No newline at end of file diff --git a/_doc/developer/debugging/windows-debugging.md b/_doc/developer/debugging/windows-debugging.md new file mode 100644 index 00000000..d3f8b2fa --- /dev/null +++ b/_doc/developer/debugging/windows-debugging.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/windows-debugging/ +redirect_from: +- /en/doc/windows-debugging/ +- /doc/WindowsDebugging/ +- /wiki/WindowsDebugging/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/debugging/windows-debugging.html +ref: 50 +title: Windows debugging +--- \ No newline at end of file diff --git a/_doc/developer/general/continuous-integration.md b/_doc/developer/general/continuous-integration.md new file mode 100644 index 00000000..0d64a8b8 --- /dev/null +++ b/_doc/developer/general/continuous-integration.md @@ -0,0 +1,7 @@ +--- +lang: en +layout: doc +permalink: /doc/continuous-integration/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/continuous-integration.html +title: Continuous integration (CI) +--- \ No newline at end of file diff --git a/_doc/developer/general/devel-books.md b/_doc/developer/general/devel-books.md new file mode 100644 index 00000000..259ebb15 --- /dev/null +++ b/_doc/developer/general/devel-books.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/devel-books/ +redirect_from: +- /en/doc/devel-books/ +- /doc/DevelBooks/ +- /wiki/DevelBooks/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/devel-books.html +ref: 32 +title: Developer books +--- \ No newline at end of file diff --git a/_doc/developer/general/developing-gui-applications.md b/_doc/developer/general/developing-gui-applications.md new file mode 100644 index 00000000..d73c01fa --- /dev/null +++ b/_doc/developer/general/developing-gui-applications.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/developing-gui-applications/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/developing-gui-applications.html +ref: 333 +title: Developing Qubes OS GUI tools +--- \ No newline at end of file diff --git a/_doc/developer/general/documentation-style-guide.md b/_doc/developer/general/documentation-style-guide.md new file mode 100644 index 00000000..d8c33300 --- /dev/null +++ b/_doc/developer/general/documentation-style-guide.md @@ -0,0 +1,355 @@ +--- +lang: en +layout: doc +permalink: /doc/documentation-style-guide/ +redirect_from: +- /doc/doc-guidelines/ +- /en/doc/doc-guidelines/ +- /wiki/DocStyle/ +- /doc/DocStyle/ +ref: 30 +title: Documentation style guide +--- + +_Also see [how to edit the documentation](/doc/how-to-edit-the-documentation/)._ + +Qubes OS documentation pages are stored as plain text Markdown files in the [qubes-doc](https://github.com/QubesOS/qubes-doc) 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. + +The documentation is a volunteer community effort. People like you are constantly working to make it better. If you notice something that can be fixed or improved, please [edit the documentation](/doc/how-to-edit-the-documentation/)! + +This page explains the standards we follow for writing, formatting, and organizing the documentation. Please follow these guidelines and conventions when editing the documentation. For the standards governing the website as a whole, please see the [website style guide](/doc/website-style-guide). + +## Markdown conventions + +All the documentation is written in Markdown for maximum accessibility. When making contributions, please observe the following style conventions. If you're not familiar with Markdown syntax, [this](https://daringfireball.net/projects/markdown/) is a great resource. + +### Hyperlink syntax + +Use non-reference-style links like `[website](https://example.com/)`. Do *not* use reference-style links like `[website][example]`, `[website][]` or `[website]`. This facilitates the localization process. + +### Relative vs. absolute links + +Always use relative rather than absolute paths for internal website links. For example, use `/doc/documentation-style-guide/` instead of `https://www.qubes-os.org/doc/documentation-style-guide/`. + +You may use absolute URLs in the following cases: + +- External links +- URLs that appear inside code blocks (e.g., in comments and document templates, and the plain text reproductions of [QSBs](/security/qsb/) and [Canaries](/security/canary/)), since they're not hyperlinks +- Git repo files like `README.md` and `CONTRIBUTING.md`, since they're not part of the website itself but rather of the auxiliary infrastructure supporting the website + +This rule is important because using absolute URLs for internal website links breaks: + +- Serving the website offline +- Website localization +- Generating offline documentation +- Automatically redirecting Tor Browser visitors to the correct page on the onion service mirror + +### Image linking + +See [how to add images](https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/how-to-edit-the-documentation.html#how-to-add-images) for the required syntax. This will make the image a hyperlink to the image file, allowing the reader to click on the image in order to view the full image by itself. This is important. Following best practices, our website has a responsive design, which allows the website to render appropriately across all screen sizes. When viewing this page on a smaller screen, such as on a mobile device, the image will automatically shrink down to fit the screen. If visitors cannot click on the image to view it in full size, then, depending on their device, they may have no way see the details in the image clearly. + +In addition, make sure to link only to images in the [qubes-attachment](https://github.com/QubesOS/qubes-attachment) repository. Do not attempt to link to images hosted on other websites. + +### HTML and CSS + +Do not write HTML inside Markdown documents (except in rare, unavoidable cases, such as [alerts](#alerts)). In particular, never include HTML or CSS for styling, formatting, or white space control. That belongs in the (S)CSS files instead. + +### Headings + +Do not use `h1` headings (single `#` or `======` underline). These are automatically generated from the `title:` line in the YAML front matter. + +Use Atx-style syntax for headings: `##h2`, `### h3`, etc. Do not use underlining syntax (`-----`). + +### Indentation + +Use spaces instead of tabs. Use hanging indentations where appropriate. + +### Lists + +If appropriate, make numerals in numbered lists match between Markdown source and HTML output. Some users read the Markdown source directly, and this makes numbered lists easier to follow. + +### Code blocks + +When writing code blocks, use [syntax highlighting](https://github.github.com/gfm/#info-string) where possible (see [here](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers) for a list of supported languages). Use `[...]` for anything omitted. + +### Line wrapping + +Do not hard wrap text, except where necessary (e.g., inside code blocks). + +### Do not use Markdown syntax for styling + +For example, there is a common temptation to use block quotations (created by beginning lines with the `>` character) in order to stylistically distinguish some portion of text from the rest of the document, e.g.: + +``` +> Note: This is an important note! +``` + +This renders as: + +> Note: This is an important note! + +There are two problems with this: + +1. It is a violation of the [separation of content and presentation](https://en.wikipedia.org/wiki/Separation_of_content_and_presentation), since it abuses markup syntax in order to achieve unintended stylistic results. The Markdown (and HTML, if any) should embody the *content* of the documentation, while the *presentation* is handled by (S)CSS. + +2. It is an abuse of quotation syntax for text that is not actually a quotation. (You are not quoting anyone here. You're just telling the reader to note something and trying to draw their attention to your note visually.) + +Instead, an example of an appropriate way to stylistically distinguish a portion of text is by using [alerts](#alerts). Consider also that extra styling and visual distinction may not even be necessary. In most cases, traditional writing methods are perfectly sufficient, e.g.,: + +``` +**Note:** This is an important note. +``` + +This renders as: + +**Note:** This is an important note. + +### Alerts + +Alerts are sections of HTML used to draw the reader's attention to important information, such as warnings, and for stylistic purposes. They are typically styled as colored text boxes, usually accompanied by icons. Alerts should generally be used somewhat sparingly, so as not to cause [alert fatigue](https://en.wikipedia.org/wiki/Alarm_fatigue) and since they must be written in HTML instead of Markdown, which makes the source less readable and more difficult to work with for localization and automation purposes. Here are examples of several types of alerts and their recommended icons: + +``` + + + + + + + +``` + +These render as: + + + + + + + + + +## Writing guidelines + +### Correct use of terminology + +Familiarize yourself with the terms defined in the [glossary](/doc/glossary/). Use these terms consistently and accurately throughout your writing. + +### Sentence case in headings + +Use sentence case (rather than title case) in headings for the reasons explained [here](https://www.sallybagshaw.com.au/articles/sentence-case-v-title-case/). In particular, since the authorship of the Qubes documentation is decentralized and widely distributed among users from around the world, many contributors come from regions with different conventions for implementing title case, not to mention that there are often differing style guide recommendations even within a single region. It is much easier for all of us to implement sentence case consistently across our growing body of pages, which is very important for managing the ongoing maintenance burden and sustainability of the documentation. + +### Writing command-line examples + +When providing command-line examples: + +- Tell the reader where to open a terminal (dom0 or a specific domU), and show the command along with its output (if any) in a code block, e.g.: + + ~~~markdown + Open a terminal in dom0 and run: + ```shell_session + $ cd test + $ echo Hello + Hello + ``` + ~~~ + +- Precede each command with the appropriate command prompt: At a minimum, the prompt should contain a trailing `#` (for the user `root`) or `$` (for other users) on Linux systems and `>` on Windows systems, respectively. + +- Don't try to add comments inside the code block. For example, *don't* do this: + + ~~~markdown + Open a terminal in dom0 and run: + ```shell_session + # Navigate to the new directory + $ cd test + # Generate a greeting + $ echo Hello + Hello + ``` + ~~~ + + The `#` symbol preceding each comment is ambiguous with a root command prompt. Instead, put your comments *outside* of the code block in normal prose. + +### Variable names in commands + +Syntactically distinguish variables in commands. For example, this is ambiguous: + + $ qvm-run --dispvm=disposable-template --service qubes.StartApp+xterm + +It should instead be: + + $ qvm-run --dispvm= --service qubes.StartApp+xterm + +Note that we syntactically distinguish variables in three ways: + +1. Surrounding them in angled brackets (`< >`) +2. Using underscores (`_`) instead of spaces between words +3. Using all capital letters + +We have observed that many novices make the mistake of typing the surrounding angled brackets (`< >`) on the command line, even after substituting the desired real value between them. Therefore, in documentation aimed at novices, we also recommend clarifying that the angled brackets should not be typed. This can be accomplished in one of several ways: + +- Explicitly say something like "without the angled brackets." +- Provide an example command using real values that excludes the angled brackets. +- If you know that almost all users will want to use (or should use) a specific command containing all real values and no variables, you might consider providing exactly that command and forgoing the version with variables. Novices may not realize which parts of the command they can substitute with different values, but if you've correctly judged that they should use the command you've provided as is, then this shouldn't matter. + +### Capitalization of "qube" + +We introduced the term ["qube"](https://qubes-doc-rst.readthedocs.io/en/latest/user/reference/glossary.html#qube) as a user-friendly alternative to the term ["virtual machine" ("VM")](https://qubes-doc-rst.readthedocs.io/en/latest/user/reference/glossary.html#vm) in the context of Qubes OS. Nonetheless, "qube" is a common noun like the words "compartment" and "container." Therefore, in English, "qube" follows the standard capitalization rules for common nouns. For example, "I have three qubes" is correct, while "I have three Qubes" is incorrect. Like other common nouns, "qube" should still be capitalized at the beginnings of sentences, the beginnings of sentence-case headings, and in title-case headings. Note, however, that starting a sentence with the plural of "qube" (e.g., "Qubes can be shut down...") can be ambiguous, since it may not be clear whether the referent is a plurality of qubes, [Qubes OS](https://qubes-doc-rst.readthedocs.io/en/latest/user/reference/glossary.html#qubes-os), or even the Qubes OS Project itself. Hence, it is generally a good idea to rephrase such sentences in order to avoid this ambiguity. + +Many people feel a strong temptation to capitalize the word "qube" all the time, like a proper noun, perhaps because it's a new and unfamiliar term that's closely associated with a particular piece of software (namely, Qubes OS). However, these factors are not relevant to the capitalization rules of English. In fact, it's not unusual for new common nouns to be introduced into English, especially in the context of technology. For example, "blockchain" is a relatively recent technical term that's a common noun. Why is it a common noun rather than a proper noun? Because proper nouns refer to *particular* people, places, things, and ideas. There are many different blockchains. However, even when there was just one, the word still denoted a collection of things rather than a particular thing. It happened to be the case that there was only one member in that collection at the time. For example, if there happened to be only one tree in the world, that wouldn't change the way we capitalize sentences like, "John sat under a tree." Intuitively, it makes sense that the addition and removal of objects from the world shouldn't cause published books to become orthographicallly incorrect while sitting on their shelves. + +Accordingly, the reason "qube" is a common noun rather than a proper noun is because it doesn't refer to any one specific thing (in this case, any one specific virtual machine). Rather, it's the term for any virtual machine in a Qubes OS installation. (Technically, while qubes are currently implemented as virtual machines, Qubes OS is independent of its underlying compartmentalization technology. Virtual machines could be replaced with a different technology, and qubes would still be called "qubes.") + +I have several qubes in my Qubes OS installation, and you have several in yours. Every Qubes OS user has their own set of qubes, just as each of us lives in some neighborhood on some street. Yet we aren't tempted to treat words like "neighborhood" or "street" as proper nouns (unless, of course, they're part of a name, like "Acorn Street"). Again, while this might seem odd because "qube" is a new word that we invented, that doesn't change how English works. After all, *every* word was a new word that someone invented at some point (otherwise we wouldn't have any words at all). We treat "telephone," "computer," "network," "program," and so on as common nouns, even though those were all new technological inventions in the not-too-distant past (on a historical scale, at least). So, we shouldn't allow ourselves to be confused by irrelevant factors, like the fact that the inventors happened to be *us* or that the invention was *recent* or is not in widespread use among humanity. + +### English language conventions + +For the sake of consistency and uniformity, the Qubes documentation aims to follow the conventions of American English, where applicable. (Please note that this is an arbitrary convention for the sake consistency and not a value judgment about the relative merits of British versus American English.) + +## Organizational guidelines + +### Do not duplicate documentation + +Duplicating documentation is almost always a bad idea. There are many reasons for this. The main one is that almost all documentation has to be updated as some point. When similar documentation appears in more than one place, it is very easy for it to get updated in one place but not the others (perhaps because the person updating it doesn't realize it's in more than once place). When this happens, the documentation as a whole is now inconsistent, and the outdated documentation becomes a trap, especially for novice users. Such traps are often more harmful than if the documentation never existed in the first place. The solution is to **link** to existing documentation rather than duplicating it. There are some exceptions to this policy (e.g., information that is certain not to change for a very long time), but they are rare. + +### Core vs. external documentation + +Core documentation resides in the [Qubes OS Project's official repositories](https://github.com/QubesOS/), mainly in [qubes-doc](https://github.com/QubesOS/qubes-doc). External documentation can be anywhere else (such as forums, community websites, and blogs), but there is an especially large collection in the [Qubes Forum](https://forum.qubes-os.org/docs). External documentation should not be submitted to [qubes-doc](https://github.com/QubesOS/qubes-doc). If you've written a piece of documentation that is not appropriate for [qubes-doc](https://github.com/QubesOS/qubes-doc), we encourage you to submit it to the [Qubes Forum](https://forum.qubes-os.org/docs) instead. However, *linking* to external documentation from [qubes-doc](https://github.com/QubesOS/qubes-doc) is perfectly fine. Indeed, the maintainers of the [Qubes Forum](https://forum.qubes-os.org/) should regularly submit PRs against the documentation index (see [How to edit the documentation index](https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/how-to-edit-the-documentation.html#how-to-edit-the-documentation-index)) to add and update Qubes Forum links in the ["External documentation"](https://qubes-doc-rst.readthedocs.io/en/latest/index.html#external-documentation) section of the documentation table of contents. + +The main difference between **core** (or **official**) and **external** (or **community** or **unofficial**) documentation is whether it documents software that is officially written and maintained by the Qubes OS Project. The purpose of this distinction is to keep the core docs maintainable and high-quality by limiting them to the software output by the Qubes OS Project. In other words, we take responsibility for documenting all of the software we put out into the world, but it doesn't make sense for us to take on the responsibility of documenting or maintaining documentation for anything else. For example, Qubes OS may use a popular Linux distribution for an official [TemplateVM](/doc/templates/). However, it would not make sense for a comparatively small project like ours, with modest funding and a lean workforce, to attempt to document software belonging to a large, richly-funded project with an army of paid and volunteer contributors, especially when they probably already have documentation of their own. This is particularly true when it comes to Linux in general. Although many users who are new to Qubes are also new to Linux, it makes absolutely no sense for our comparatively tiny project to try to document Linux in general when there is already a plethora of documentation out there. + +Many contributors do not realize that there is a significant amount of work involved in *maintaining* documentation after it has been written. They may wish to write documentation and submit it to the core docs, but they see only their own writing process and fail to consider that it will have to be kept up-to-date and consistent with the rest of the docs for years afterward. Submissions to the core docs also have to [undergo a review process](https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/how-to-edit-the-documentation.html#security) to ensure accuracy before being merged, which takes up valuable time from the team. We aim to maintain high quality standards for the core docs (style and mechanics, formatting), which also takes up a lot of time. If the documentation involves anything external to the Qubes OS Project (such as a website, platform, program, protocol, framework, practice, or even a reference to a version number), the documentation is likely to become outdated when that external thing changes. It's also important to periodically review and update this documentation, especially when a new Qubes release comes out. Periodically, there may be technical or policy changes that affect all the core documentation. The more documentation there is relative to maintainers, the harder all of this will be. Since there are many more people who are willing to write documentation than to maintain it, these individually small incremental additions amount to a significant maintenance burden for the project. + +On the positive side, we consider the existence of community documentation to be a sign of a healthy ecosystem, and this is quite common in the software world. The community is better positioned to write and maintain documentation that applies, combines, and simplifies the official documentation, e.g., tutorials that explain how to install and use various programs in Qubes, how to create custom VM setups, and introductory tutorials that teach basic Linux concepts and commands in the context of Qubes. In addition, just because the Qubes OS Project has officially written and maintains some flexible framework, such as `qrexec`, it does not make sense to include every tutorial that says "here's how to do something cool with `qrexec`" in the core docs. Such tutorials generally also belong in the community documentation. + +See [#4693](https://github.com/QubesOS/qubes-issues/issues/4693) for more background information. + +### Release-specific documentation + +*See [#5308](https://github.com/QubesOS/qubes-issues/issues/5308) for pending changes to this policy.* + +We maintain only one set of documentation for Qubes OS. We do not maintain a different set of documentation for each release of Qubes. Our single set of Qubes OS documentation is updated on a continual, rolling basis. Our first priority is to document all **current, stable releases** of Qubes. Our second priority is to document the next, upcoming release (if any) that is currently in the beta or release candidate stage. + +In cases where a documentation page covers functionality that differs considerably between Qubes OS releases, the page should be subdivided into clearly-labeled sections that cover the different functionality in different releases (examples below). + +In general, avoid mentioning specific Qubes versions in the body text of documentation, as these references rapidly go out of date and become misleading to readers. + +#### Incorrect Example + +``` +## How to Foo + +Fooing is the process by which one foos. There are both general and specific +versions of fooing, which vary in usefulness depending on your goals, but for +the most part, all fooing is fooing. + +To foo in Qubes 3.2: + + $ qvm-foo + +Note that this does not work in Qubes 4.0, where there is a special widget +for fooing, which you can find in the lower-right corner of the screen in +the Foo Manager. Alternatively, you can use the more general `qubes-baz` +command introduced in 4.0: + + $ qubes-baz --foo + +Once you foo, make sure to close the baz before fooing the next bar. +``` + +#### Correct Example + +``` +## Qubes 3.2 + +### How to Foo + +Fooing is the process by which one foos. There are both general and specific +versions of fooing, which vary in usefulness depending on your goals, but for +the most part, all fooing is fooing. + +To foo: + + $ qvm-foo + +Once you foo, make sure to close the baz before fooing the next bar. + +## Qubes 4.0 + +### How to Foo + +Fooing is the process by which one foos. There are both general and specific +versions of fooing, which vary in usefulness depending on your goals, but for +the most part, all fooing is fooing. + +There is a special widget for fooing, which you can find in the lower-right +corner of the screen in the Foo Manager. Alternatively, you can use the +general `qubes-baz` command: + + $ qubes-baz --foo + +Once you foo, make sure to close the baz before fooing the next bar. +``` + +Subdividing the page into clearly-labeled sections for each release has several benefits: + +- It preserves good content for older (but still supported) releases. Many documentation contributors are also people who prefer to use the latest release. Many of them are tempted to *replace* existing content that applies to an older, supported release with content that applies only to the latest release. This is somewhat understandable. Since they only use the latest release, they may be focused on their own experience, and they may even regard the older release as deprecated, even when it's actually still supported. However, allowing this replacement of content would do a great disservice to those who still rely on the older, supported release. In many cases, these users value the stability and reliability of the older, supported release. With the older, supported release, there has been more time to fix bugs and make improvements in both the software and the documentation. Consequently, much of the documentation content for this release may have gone through several rounds of editing, review, and revision. It would be a tragedy for this content to vanish while the very set of users who most prize stability and reliability are depending on it. +- It's easy for readers to quickly find the information they're looking for, since they can go directly to the section that applies to their release. +- It's hard for readers to miss information they need, since it's all in one place. In the incorrect example, information that the reader needs could be in any paragraph in the entire document, and there's no way to tell without reading the entire page. In the correct example, the reader can simply skim the headings in order to know which parts of the page need to be read and which can be safely ignored. The fact that some content is repeated in the two release-specific sections is not a problem, since no reader has to read the same thing twice. Moreover, as one release gets updated, it's likely that the documentation for that release will also be updated. Therefore, content that is initially duplicated between release-specific sections will not necessarily stay that way, and this is a good thing: We want the documentation for a release that *doesn't* change to stay the same, and we want the documentation for a release that *does* change to change along with the software. +- It's easy for documentation contributors and maintainers to know which file to edit and update, since there's only one page for all Qubes OS releases. Initially creating the new headings and duplicating content that applies to both is only a one-time cost for each page, and many pages don't even require this treatment, since they apply to all currently-supported Qubes OS releases. + +By contrast, an alternative approach, such as segregating the documentation into two different branches, would mean that contributions that apply to both Qubes releases would only end up in one branch, unless someone remembered to manually submit the same thing to the other branch and actually made the effort to do so. Most of the time, this wouldn't happen. When it did, it would mean a second pull request that would have to be reviewed. Over time, the different branches would diverge in non-release-specific content. Good general content that was submitted only to one branch would effectively disappear once that release was deprecated. (Even if it were still on the website, no one would look at it, since it would explicitly be in the subdirectory of a deprecated release, and there would be a motivation to remove it from the website so that search results wouldn't be populated with out-of-date information.) + +For further discussion about release-specific documentation in Qubes, see [here](https://groups.google.com/d/topic/qubes-users/H9BZX4K9Ptk/discussion). + +## Git conventions + +Please follow our [Git commit message guidelines](https://qubes-doc-rst.readthedocs.io/en/latest/developer/code/coding-style.html#commit-message-guidelines). \ No newline at end of file diff --git a/_doc/developer/general/gsoc.md b/_doc/developer/general/gsoc.md new file mode 100644 index 00000000..cb50d0ea --- /dev/null +++ b/_doc/developer/general/gsoc.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /gsoc/ +redirect_from: +- /GSoC/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/gsoc.html +ref: 33 +title: Google Summer of Code (GSoC) +--- \ No newline at end of file diff --git a/_doc/developer/general/gsod.md b/_doc/developer/general/gsod.md new file mode 100644 index 00000000..38563efd --- /dev/null +++ b/_doc/developer/general/gsod.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /gsod/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/gsod.html +ref: 242 +title: Google Season of Docs (GSoD) +--- \ No newline at end of file diff --git a/_doc/developer/general/how-to-edit-the-documentation.md b/_doc/developer/general/how-to-edit-the-documentation.md new file mode 100644 index 00000000..babf1f73 --- /dev/null +++ b/_doc/developer/general/how-to-edit-the-documentation.md @@ -0,0 +1,198 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-edit-the-documentation/ +title: How to edit the documentation +--- + +_Also see the [documentation style guide](/doc/documentation-style-guide/)._ + +Qubes OS documentation pages are stored as plain text Markdown files in the +[qubes-doc](https://github.com/QubesOS/qubes-doc) 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. + +The documentation is a volunteer community effort. People like you are +constantly working to make it better. If you notice something that can be fixed +or improved, please follow the steps below to open a pull request! + +## How to submit a pull request + +We keep all the documentation in +[qubes-doc](https://github.com/QubesOS/qubes-doc), a dedicated Git repository +hosted on [GitHub](https://github.com/). Thanks to GitHub's easy web interface, +you can edit the documentation even if you're not familiar with Git or the +command line! All you need is a free GitHub account. + +A few notes before we get started: + +- Since Qubes is a security-oriented project, every documentation change will + be [reviewed](#security) before it's accepted. This allows us to maintain + quality control and protect our users. + +- To give your contribution a better chance of being accepted, please follow + our [documentation style guide](/doc/documentation-style-guide/). + +- We don't want you to spend time and effort on a contribution that we can't + accept. If your contribution would take a lot of time, please [file an + issue](/doc/issue-tracking/) for it first so that we can make sure we're on + the same page before significant works begins. + +- Alternatively, you may already have written content that doesn't conform to + these guidelines, but you'd be willing to modify it so that it does. In this + case, you can still submit it by following the instructions below. Just make + a note in your pull request (PR) that you're aware of the changes that need + to be made and that you're just asking for the content to be reviewed before + you spend time making those changes. + +- Finally, if you've written something that doesn't belong in qubes-doc but + that would be beneficial to the Qubes community, please consider adding it to + the [external + documentation](/doc/documentation-style-guide/#core-vs-external-documentation). + +(**Advanced users:** If you're already familiar with GitHub or wish to work +from the command line, you can skip the rest of this section. All you need to +do to contribute is to [fork and +clone](https://guides.github.com/activities/forking/) the +[qubes-doc](https://github.com/QubesOS/qubes-doc) repo, make your changes, then +[submit a pull +request](https://help.github.com/articles/using-pull-requests/).) + +Ok, let's begin. Every documentation page has a "Page Source on GitHub" button. +Depending on the size of your screen, it may either be on the side (larger +screens) or on the bottom (smaller screens). + +[![page-source-button](/attachment/doc/doc-pr_01_page-source-button.png)](/attachment/doc/doc-pr_01_page-source-button.png) + +When you click on it, you'll be taken to the source file --- usually a Markdown +(`.md`) file --- on GitHub. On this page, there will be a button to edit the +file. + +[![github-edit](/attachment/doc/doc-pr_02_github-edit.png)](/attachment/doc/doc-pr_02_github-edit.png) + +You'll be prompted to sign in with your GitHub username and password +(if you aren't already logged in). You can also create a free account from here. + +[![github-sign-in](/attachment/doc/doc-pr_03_sign-in.png)](/attachment/doc/doc-pr_03_sign-in.png) + +If this is your first contribution to the documentation, you need to "fork" the +repository (make your own copy). It's easy --- just click the big green button +on the next page. This step is only needed the first time you make a +contribution. + +[![fork](/attachment/doc/doc-pr_04_fork.png)](/attachment/doc/doc-pr_04_fork.png) + +Now you can make your modifications. You can also preview the changes to see +how they'll be formatted by clicking the "Preview changes" tab. If you want to +add images, please see [How to add images](#how-to-add-images). If you're +making formatting changes, please [render the site +locally](https://github.com/QubesOS/qubesos.github.io#instructions) to verify +that everything looks correct before submitting any changes. + +[![edit](/attachment/doc/doc-pr_05_edit.png)](/attachment/doc/doc-pr_05_edit.png) + +Once you're finished, describe your changes at the bottom and click "Propose +file change". + +[![commit](/attachment/doc/doc-pr_06_commit-msg.png)](/attachment/doc/doc-pr_06_commit-msg.png) + +After that, you'll see exactly what modifications you've made. At this stage, +those changes are still in your own copy of the documentation ("fork"). If +everything looks good, send those changes to us by pressing the "Create pull +request" button. + +[![pull-request](/attachment/doc/doc-pr_07_review-changes.png)](/attachment/doc/doc-pr_07_review-changes.png) + +You will be able to adjust the pull request message and title there. In most +cases, the defaults are ok, so you can just confirm by pressing the "Create +pull request" button again. However, if you're not ready for your PR to be +reviewed or merged yet, please [make a draft PR +instead](https://github.blog/2019-02-14-introducing-draft-pull-requests/). + +[![pull-request-confirm](/attachment/doc/doc-pr_08_create-pull-request.png)](/attachment/doc/doc-pr_08_create-pull-request.png) + +If any of your changes should be reflected in the [documentation index (a.k.a. +table of contents)](/doc/) --- for example, if you're adding a new page, +changing the title of an existing page, or removing a page --- please see [How +to edit the documentation index](#how-to-edit-the-documentation-index). + +That's all! We will review your changes. If everything looks good, we'll pull +them into the official documentation. Otherwise, we may have some questions for +you, which we'll post in a comment on your pull request. (GitHub will +automatically notify you if we do.) If, for some reason, we can't accept your +pull request, we'll post a comment explaining why we can't. + +[![done](/attachment/doc/doc-pr_09_done.png)](/attachment/doc/doc-pr_09_done.png) + +## How to edit the documentation index + +The source file for the [documentation index (a.k.a. table of contents)](/doc/) +is +[doc-index.yml](https://github.com/QubesOS/qubesos.github.io/blob/master/_data/doc-index.yml). + +Editing this file will change what appears on the documentation index. If your +pull request (PR) adds, removes, or edits anything that should be reflected in +the documentation index, please make sure you also submit an associated pull +request against this file. + +## How to add images + +To add an image to a page, use the following syntax in the main document (see +[here](/doc/documentation-style-guide/#image-linking) for why this syntax is +important). + +``` +[![Image Title](/attachment/doc/image.png)](/attachment/doc/image.png) +``` + +Then, submit your image(s) in a separate pull request to the +[qubes-attachment](https://github.com/QubesOS/qubes-attachment) repository +using the same path and filename. This is the only permitted way to include +images. Do not link to images on other websites. + +## Serving the website locally + +You can serve the website offline on your local machine by following [these +instructions](https://github.com/QubesOS/qubesos.github.io#instructions). This +can be useful for making sure that your changes render the way you expect, +especially when your changes affect formatting, images, tables, styling, etc. + +## Security + +*Also see: [Should I trust this website?](https://qubes-doc-rst.readthedocs.io/en/latest/introduction/faq.html#should-i-trust-this-website)* + +All pull requests (PRs) against +[qubes-doc](https://github.com/QubesOS/qubes-doc) must pass review prior to be +merged, except in the case of [external +documentation](https://qubes-doc-rst.readthedocs.io/en/latest/index.html#external-documentation) (see +[#4693](https://github.com/QubesOS/qubes-issues/issues/4693)). This process is +designed to ensure that contributed text is accurate and non-malicious. This +process is a best effort that should provide a reasonable degree of assurance, +but it is not foolproof. For example, all text characters are checked for ANSI +escape sequences. However, binaries, such as images, are simply checked to +ensure they appear or function the way they should when the website is +rendered. They are not further analyzed in an attempt to determine whether they +are malicious. + +Once a pull request passes review, the reviewer should add a signed comment +stating, "Passed review as of ``" (or similar). The +documentation maintainer then verifies that the pull request is mechanically +sound (no merge conflicts, broken links, ANSI escapes, etc.). If so, the +documentation maintainer then merges the pull request, adds a PGP-signed tag to +the latest commit (usually the merge commit), then pushes to the remote. In +cases in which another reviewer is not required, the documentation maintainer +may review the pull request (in which case no signed comment is necessary, +since it would be redundant with the signed tag). + +## Questions, problems, and improvements + +If you have a question about something you read in the documentation or about +how to edit the documentation, please post it on the +[forum](https://forum.qubes-os.org/) or send it to the appropriate [mailing +list](/support/). If you see that something in the documentation should be +fixed or improved, please [contribute](#how-to-submit-a-pull-request) the +change yourself. To report an issue with the documentation, please follow our +standard [issue reporting guidelines](/doc/issue-tracking/). (If you report an +issue with the documentation, you will likely be asked to submit a pull request +for it, unless there is a clear indication in your report that you are not +willing or able to do so.) diff --git a/_doc/developer/general/package-contributions.md b/_doc/developer/general/package-contributions.md new file mode 100644 index 00000000..be47c56e --- /dev/null +++ b/_doc/developer/general/package-contributions.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/package-contributions/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/package-contributions.html +ref: 29 +title: Package contributions +--- \ No newline at end of file diff --git a/_doc/developer/general/research.md b/_doc/developer/general/research.md new file mode 100644 index 00000000..92ce86bd --- /dev/null +++ b/_doc/developer/general/research.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: site +permalink: /research/ +redirect_from: +- /doc/qubes-research/ +- /en/doc/qubes-research/ +- /doc/QubesResearch/ +- /wiki/QubesResearch/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/research.html +ref: 139 +title: Research +--- \ No newline at end of file diff --git a/_doc/developer/general/usability-ux.md b/_doc/developer/general/usability-ux.md new file mode 100644 index 00000000..f5493690 --- /dev/null +++ b/_doc/developer/general/usability-ux.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/usability-ux/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/general/usability-ux.html +ref: 31 +title: Usability & UX +--- \ No newline at end of file diff --git a/_doc/developer/general/visual-style-guide.md b/_doc/developer/general/visual-style-guide.md new file mode 100644 index 00000000..ceef871d --- /dev/null +++ b/_doc/developer/general/visual-style-guide.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +permalink: /doc/visual-style-guide/ +redirect_from: +- /doc/style-guide/ +ref: 27 +title: Visual style guide +--- diff --git a/_doc/developer/general/website-style-guide.md b/_doc/developer/general/website-style-guide.md new file mode 100644 index 00000000..6c5a7de8 --- /dev/null +++ b/_doc/developer/general/website-style-guide.md @@ -0,0 +1,78 @@ +--- +lang: en +layout: doc +permalink: /doc/website-style-guide/ +title: Website style guide +--- + +This page explains the standards we follow for building and maintaining the +website. Please follow these guidelines and conventions when modifying the +website. For the standards governing the documentation in particular, please +see the [documentation style guide](/doc/documentation-style-guide/). + +## Coding conventions + +The following conventions apply to the website as a whole, including everything +written in HTML, CSS, YAML, and Liquid. These conventions are intended to keep +the codebase consistent when multiple collaborators are working on it. They +should be understood as a practical set of rules for maintaining order in this +specific codebase rather than as a statement of what is objectively right or +good. + +### General practices + +- Use comments to indicate the purposes of different blocks of code. This makes + the file easier to understand and navigate. + +- Use descriptive variable names. Never use one or two letter variable names. + Avoid obscure abbreviations and made-up words. + +- In general, make it easy for others to read your code. Your future self will + thank you, and so will your collaborators! + +- [Don't Repeat Yourself + (DRY)!](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) Instead of + repeating the same block of code multiple times, abstract it out into a + separate file and `include` that file where you need it. + +### Whitespace + +- Always use spaces. Never use tabs. + +- Each indentation step should be exactly two (2) spaces. + +- Whenever you add an opening tag, indent the following line. (Exception: If + you open and close the tag on the same line, do not indent the following + line.) + +- Indent Liquid the same way as HTML. + +- In general, the starting columns of every adjacent pair of lines should be no + more than two spaces apart (example below). + +- No blank or empty lines. (Hint: When you feel you need one, add a comment on + that line instead.) + +#### Indentation example + +Here's an example that follows the indentation rules: + +{% raw %} +```html + + + + {% for item in secs.htmlsections[0].columns %} + + {% endfor %} + + {% for canary in site.data.sec-canary reversed %} + + + + + + {% endfor %} +
{{ item.title }}
{{ canary.date }}Qubes Canary #{{ canary.canary }}
+``` +{% endraw %} diff --git a/_doc/developer/releases/1_0/release-notes.md b/_doc/developer/releases/1_0/release-notes.md new file mode 100644 index 00000000..35e94683 --- /dev/null +++ b/_doc/developer/releases/1_0/release-notes.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/1.0/release-notes/ +redirect_from: +- /en/doc/releases/1.0/release-notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/1_0/release-notes.html +ref: 18 +title: Qubes R1.0 release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/2_0/release-notes.md b/_doc/developer/releases/2_0/release-notes.md new file mode 100644 index 00000000..a01c8501 --- /dev/null +++ b/_doc/developer/releases/2_0/release-notes.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/2.0/release-notes/ +redirect_from: +- /en/doc/releases/2.0/release-notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/2_0/release-notes.html +ref: 25 +title: Qubes R2.0 release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/3_0/release-notes.md b/_doc/developer/releases/3_0/release-notes.md new file mode 100644 index 00000000..1e32f98b --- /dev/null +++ b/_doc/developer/releases/3_0/release-notes.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/3.0/release-notes/ +redirect_from: +- /en/doc/releases/3.0/release-notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/3_0/release-notes.html +ref: 19 +title: Qubes R3.0 release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/3_0/schedule.md b/_doc/developer/releases/3_0/schedule.md new file mode 100644 index 00000000..167ed6ad --- /dev/null +++ b/_doc/developer/releases/3_0/schedule.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/3.0/schedule/ +redirect_from: +- /en/doc/releases/3.0/schedule/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/3_0/schedule.html +ref: 20 +title: Qubes R3.0 release schedule +--- \ No newline at end of file diff --git a/_doc/developer/releases/3_1/release-notes.md b/_doc/developer/releases/3_1/release-notes.md new file mode 100644 index 00000000..078c371b --- /dev/null +++ b/_doc/developer/releases/3_1/release-notes.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/3.1/release-notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/3_1/release-notes.html +ref: 16 +title: Qubes R3.1 release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/3_1/schedule.md b/_doc/developer/releases/3_1/schedule.md new file mode 100644 index 00000000..5e2d01b3 --- /dev/null +++ b/_doc/developer/releases/3_1/schedule.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/3.1/schedule/ +redirect_from: +- /en/doc/releases/3.1/schedule/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/3_1/schedule.html +ref: 17 +title: Qubes R3.1 release schedule +--- \ No newline at end of file diff --git a/_doc/developer/releases/3_2/release-notes.md b/_doc/developer/releases/3_2/release-notes.md new file mode 100644 index 00000000..7723f899 --- /dev/null +++ b/_doc/developer/releases/3_2/release-notes.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/3.2/release-notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/3_2/release-notes.html +ref: 21 +title: Qubes R3.2 release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/3_2/schedule.md b/_doc/developer/releases/3_2/schedule.md new file mode 100644 index 00000000..baf99e4f --- /dev/null +++ b/_doc/developer/releases/3_2/schedule.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/3.2/schedule/ +redirect_from: +- /en/doc/releases/3.2/schedule/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/3_2/schedule.html +ref: 22 +title: Qubes R3.2 release schedule +--- \ No newline at end of file diff --git a/_doc/developer/releases/4_0/release-notes.md b/_doc/developer/releases/4_0/release-notes.md new file mode 100644 index 00000000..41c1b321 --- /dev/null +++ b/_doc/developer/releases/4_0/release-notes.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/4.0/release-notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/4_0/release-notes.html +ref: 23 +title: Qubes R4.0 release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/4_0/schedule.md b/_doc/developer/releases/4_0/schedule.md new file mode 100644 index 00000000..ff21e8c6 --- /dev/null +++ b/_doc/developer/releases/4_0/schedule.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/4.0/schedule/ +redirect_from: +- /en/doc/releases/4.0/schedule/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/4_0/schedule.html +ref: 24 +title: Qubes R4.0 release schedule +--- \ No newline at end of file diff --git a/_doc/developer/releases/4_1/release-notes.md b/_doc/developer/releases/4_1/release-notes.md new file mode 100644 index 00000000..81800317 --- /dev/null +++ b/_doc/developer/releases/4_1/release-notes.md @@ -0,0 +1,6 @@ +--- +layout: doc +permalink: /doc/releases/4.1/release-notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/4_1/release-notes.html +title: Qubes OS 4.1 release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/4_1/schedule.md b/_doc/developer/releases/4_1/schedule.md new file mode 100644 index 00000000..cd65f570 --- /dev/null +++ b/_doc/developer/releases/4_1/schedule.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/4.1/schedule/ +redirect_from: +- /en/doc/releases/4.1/schedule/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/4_1/schedule.html +title: Qubes R4.1 release schedule +--- \ No newline at end of file diff --git a/_doc/developer/releases/4_2/release-notes.md b/_doc/developer/releases/4_2/release-notes.md new file mode 100644 index 00000000..93c30476 --- /dev/null +++ b/_doc/developer/releases/4_2/release-notes.md @@ -0,0 +1,6 @@ +--- +layout: doc +permalink: /doc/releases/4.2/release-notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/4_2/release-notes.html +title: Qubes OS 4.2.0 release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/4_2/schedule.md b/_doc/developer/releases/4_2/schedule.md new file mode 100644 index 00000000..d1541f6f --- /dev/null +++ b/_doc/developer/releases/4_2/schedule.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/4.2/schedule/ +redirect_from: +- /en/doc/releases/4.2/schedule/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/4_2/schedule.html +title: Qubes R4.2 release schedule +--- \ No newline at end of file diff --git a/_doc/developer/releases/notes.md b/_doc/developer/releases/notes.md new file mode 100644 index 00000000..9206b4cc --- /dev/null +++ b/_doc/developer/releases/notes.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/notes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/notes.html +ref: 13 +title: Release notes +--- \ No newline at end of file diff --git a/_doc/developer/releases/schedules.md b/_doc/developer/releases/schedules.md new file mode 100644 index 00000000..ed96fb11 --- /dev/null +++ b/_doc/developer/releases/schedules.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/schedules/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/schedules.html +ref: 15 +title: Release schedules +--- \ No newline at end of file diff --git a/_doc/developer/releases/todo.md b/_doc/developer/releases/todo.md new file mode 100644 index 00000000..a2754133 --- /dev/null +++ b/_doc/developer/releases/todo.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/releases/todo/ +redirect_from: +- /en/doc/releases/todo/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/todo.html +ref: 14 +title: Release checklist +--- \ No newline at end of file diff --git a/_doc/developer/releases/version-scheme.md b/_doc/developer/releases/version-scheme.md new file mode 100644 index 00000000..d58ca70f --- /dev/null +++ b/_doc/developer/releases/version-scheme.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/version-scheme/ +redirect_from: +- /en/doc/version-scheme/ +- /doc/VersionScheme/ +- /wiki/VersionScheme/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/releases/version-scheme.html +ref: 151 +title: Version scheme +--- \ No newline at end of file diff --git a/_doc/developer/services/admin-api.md b/_doc/developer/services/admin-api.md new file mode 100644 index 00000000..a8bda0b1 --- /dev/null +++ b/_doc/developer/services/admin-api.md @@ -0,0 +1,15 @@ +--- +lang: en +layout: doc +permalink: /doc/admin-api/ +redirect_from: +- /doc/qubes-admin-api/ +- /doc/mgmt/ +- /doc/mgmt1/ +- /doc/mgmt-architecture/ +- /doc/admin-api-architecture/ +- /doc/admin-api/table/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/admin-api.html +ref: 36 +title: Admin API +--- \ No newline at end of file diff --git a/_doc/developer/services/disposablevm-implementation.md b/_doc/developer/services/disposablevm-implementation.md new file mode 100644 index 00000000..be38cf56 --- /dev/null +++ b/_doc/developer/services/disposablevm-implementation.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/disposablevm-implementation/ +redirect_from: +- /doc/dvm-impl/ +- /en/doc/dvm-impl/ +- /doc/DVMimpl/ +- /wiki/DVMimpl/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/disposablevm-implementation.html +ref: 34 +title: Disposable implementation +--- \ No newline at end of file diff --git a/_doc/developer/services/dom0-secure-updates.md b/_doc/developer/services/dom0-secure-updates.md new file mode 100644 index 00000000..a14e52af --- /dev/null +++ b/_doc/developer/services/dom0-secure-updates.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/dom0-secure-updates/ +redirect_from: +- /en/doc/dom0-secure-updates/ +- /doc/Dom0SecureUpdates/ +- /wiki/Dom0SecureUpdates/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/dom0-secure-updates.html +ref: 43 +title: Dom0 secure updates +--- \ No newline at end of file diff --git a/_doc/developer/services/qfilecopy.md b/_doc/developer/services/qfilecopy.md new file mode 100644 index 00000000..36c01ed8 --- /dev/null +++ b/_doc/developer/services/qfilecopy.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/qfilecopy/ +redirect_from: +- /en/doc/qfilecopy/ +- /doc/Qfilecopy/ +- /wiki/Qfilecopy/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/qfilecopy.html +ref: 35 +title: Inter-qube file copying (qfilecopy) +--- \ No newline at end of file diff --git a/_doc/developer/services/qfileexchgd.md b/_doc/developer/services/qfileexchgd.md new file mode 100644 index 00000000..13ef9b77 --- /dev/null +++ b/_doc/developer/services/qfileexchgd.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/qfileexchgd/ +redirect_from: +- /en/doc/qfileexchgd/ +- /doc/Qfileexchgd/ +- /wiki/Qfileexchgd/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/qfileexchgd.html +ref: 40 +title: Qfileexchgd (deprecated) +--- \ No newline at end of file diff --git a/_doc/developer/services/qmemman.md b/_doc/developer/services/qmemman.md new file mode 100644 index 00000000..4da55ee1 --- /dev/null +++ b/_doc/developer/services/qmemman.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/qmemman/ +redirect_from: +- /en/doc/qmemman/ +- /doc/Qmemman/ +- /wiki/Qmemman/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/qmemman.html +ref: 41 +title: Qubes memory manager (qmemman) +--- \ No newline at end of file diff --git a/_doc/developer/services/qrexec-internals.md b/_doc/developer/services/qrexec-internals.md new file mode 100644 index 00000000..9ea7ea4c --- /dev/null +++ b/_doc/developer/services/qrexec-internals.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/qrexec-internals/ +redirect_from: +- /doc/qrexec3-implementation/ +- /en/doc/qrexec3-implementation/ +- /doc/Qrexec3Implementation/ +- /wiki/Qrexec3Implementation/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/qrexec-internals.html +ref: 39 +title: 'Qrexec: Qubes RPC internals' +--- \ No newline at end of file diff --git a/_doc/developer/services/qrexec-socket-services.md b/_doc/developer/services/qrexec-socket-services.md new file mode 100644 index 00000000..e39ad5ac --- /dev/null +++ b/_doc/developer/services/qrexec-socket-services.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/qrexec-socket-services/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/qrexec-socket-services.html +ref: 42 +title: 'Qrexec: socket-based services' +--- \ No newline at end of file diff --git a/_doc/developer/services/qrexec.md b/_doc/developer/services/qrexec.md new file mode 100644 index 00000000..02a70b9d --- /dev/null +++ b/_doc/developer/services/qrexec.md @@ -0,0 +1,16 @@ +--- +lang: en +layout: doc +permalink: /doc/qrexec/ +redirect_from: +- /en/doc/qrexec3/ +- /doc/Qrexec3/ +- /doc/qrexec3/ +- /wiki/Qrexec3/ +- /en/doc/qrexec/ +- /doc/Qrexec/ +- /wiki/Qrexec/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/qrexec.html +ref: 37 +title: 'Qrexec: secure communication across domains' +--- \ No newline at end of file diff --git a/_doc/developer/services/qrexec2.md b/_doc/developer/services/qrexec2.md new file mode 100644 index 00000000..34154cb3 --- /dev/null +++ b/_doc/developer/services/qrexec2.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/qrexec2/ +redirect_from: +- /doc/qrexec2-implementation/ +- /en/doc/qrexec2-implementation/ +- /doc/Qrexec2Implementation/ +- /wiki/Qrexec2Implementation/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/services/qrexec2.html +ref: 38 +title: Qrexec v2 (deprecated) +--- \ No newline at end of file diff --git a/_doc/developer/system/architecture.md b/_doc/developer/system/architecture.md new file mode 100644 index 00000000..617bcc87 --- /dev/null +++ b/_doc/developer/system/architecture.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/architecture/ +redirect_from: +- /doc/qubes-architecture/ +- /en/doc/qubes-architecture/ +- /doc/QubesArchitecture/ +- /wiki/QubesArchitecture/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/system/architecture.html +ref: 56 +title: Architecture +--- \ No newline at end of file diff --git a/_doc/developer/system/audio.md b/_doc/developer/system/audio.md new file mode 100644 index 00000000..5b915dde --- /dev/null +++ b/_doc/developer/system/audio.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/audio-virtualization/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/system/audio.html +ref: 60 +title: Audio virtualization +--- \ No newline at end of file diff --git a/_doc/developer/system/gui.md b/_doc/developer/system/gui.md new file mode 100644 index 00000000..96f45c7c --- /dev/null +++ b/_doc/developer/system/gui.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/gui/ +redirect_from: +- /en/doc/gui/ +- /en/doc/gui-docs/ +- /doc/GUIdocs/ +- /wiki/GUIdocs/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/system/gui.html +ref: 61 +title: GUI virtualization +--- \ No newline at end of file diff --git a/_doc/developer/system/networking.md b/_doc/developer/system/networking.md new file mode 100644 index 00000000..c3b47cf4 --- /dev/null +++ b/_doc/developer/system/networking.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/networking/ +redirect_from: +- /doc/qubes-net/ +- /en/doc/qubes-net/ +- /doc/QubesNet/ +- /wiki/QubesNet/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/system/networking.html +ref: 59 +title: Networking +--- \ No newline at end of file diff --git a/_doc/developer/system/qubes-core-admin-client.md b/_doc/developer/system/qubes-core-admin-client.md new file mode 100644 index 00000000..065adb20 --- /dev/null +++ b/_doc/developer/system/qubes-core-admin-client.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/qubes-core-admin-client/ +redirect_to: https://dev.qubes-os.org/projects/core-admin-client/en/latest/ +ref: 245 +title: Qubes core admin client +--- \ No newline at end of file diff --git a/_doc/developer/system/qubes-core-admin.md b/_doc/developer/system/qubes-core-admin.md new file mode 100644 index 00000000..fbd0d9ab --- /dev/null +++ b/_doc/developer/system/qubes-core-admin.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/qubes-core-admin/ +redirect_to: https://dev.qubes-os.org/projects/core-admin/en/latest/ +ref: 246 +title: Qubes core admin +--- \ No newline at end of file diff --git a/_doc/developer/system/qubes-core-stack.md b/_doc/developer/system/qubes-core-stack.md new file mode 100644 index 00000000..7032dd38 --- /dev/null +++ b/_doc/developer/system/qubes-core-stack.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/qubes-core-stack/ +redirect_to: /news/2017/10/03/core3/ +ref: 247 +title: Qubes core stack +--- \ No newline at end of file diff --git a/_doc/developer/system/security-critical-code.md b/_doc/developer/system/security-critical-code.md new file mode 100644 index 00000000..14b9cefd --- /dev/null +++ b/_doc/developer/system/security-critical-code.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/security-critical-code/ +redirect_from: +- /en/doc/security-critical-code/ +- /doc/SecurityCriticalCode/ +- /wiki/SecurityCriticalCode/ +- /trac/wiki/SecurityCriticalCode/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/system/security-critical-code.html +ref: 55 +title: Security-critical code +--- \ No newline at end of file diff --git a/_doc/developer/system/security-design-goals.md b/_doc/developer/system/security-design-goals.md new file mode 100644 index 00000000..a048eabc --- /dev/null +++ b/_doc/developer/system/security-design-goals.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/security-design-goals/ +redirect_from: +- /security/goals/ +- /doc/security-goals/ +- /en/doc/security-goals/ +- /doc/SecurityGoals/ +- /wiki/SecurityGoals/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/system/security-design-goals.html +ref: 210 +title: Security design goals +--- \ No newline at end of file diff --git a/_doc/developer/system/system-doc.md b/_doc/developer/system/system-doc.md new file mode 100644 index 00000000..a699b35f --- /dev/null +++ b/_doc/developer/system/system-doc.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/system-doc/ +redirect_from: +- /en/doc/system-doc/ +- /doc/SystemDoc/ +- /wiki/SystemDoc/ +redirect_to: +- https://qubes-doc-rst.readthedocs.io/en/latest/index.html#developer-documentation +ref: 62 +title: System documentation +--- diff --git a/_doc/developer/system/template-implementation.md b/_doc/developer/system/template-implementation.md new file mode 100644 index 00000000..29fa7f5a --- /dev/null +++ b/_doc/developer/system/template-implementation.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/template-implementation/ +redirect_from: +- /en/doc/template-implementation/ +- /doc/TemplateImplementation/ +- /wiki/TemplateImplementation/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/system/template-implementation.html +ref: 58 +title: Template implementation +--- \ No newline at end of file diff --git a/_doc/developer/system/template-manager.md b/_doc/developer/system/template-manager.md new file mode 100644 index 00000000..4f6c0351 --- /dev/null +++ b/_doc/developer/system/template-manager.md @@ -0,0 +1,6 @@ +--- +layout: doc +permalink: /doc/template-manager/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/developer/system/template-manager.html +title: Template manager +--- \ No newline at end of file diff --git a/_doc/doc.md b/_doc/doc.md new file mode 100644 index 00000000..16fc646e --- /dev/null +++ b/_doc/doc.md @@ -0,0 +1,18 @@ +--- +lang: en +layout: doc +permalink: /doc/ +redirect_from: +- /en/doc/ +- /doc/UserDoc/ +- /wiki/UserDoc/ +- /doc/QubesDocs/ +- /wiki/QubesDocs/ +- /help/ +- /en/help/ +- /en/community/ +- /community/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/index.html +ref: 12 +title: Documentation +--- diff --git a/_doc/external/building-guides/building-archlinux-template.md b/_doc/external/building-guides/building-archlinux-template.md new file mode 100644 index 00000000..8864f535 --- /dev/null +++ b/_doc/external/building-guides/building-archlinux-template.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/building-archlinux-template/ +- /en/doc/building-archlinux-template/ +- /doc/BuildingArchlinuxTemplate/ +- /wiki/BuildingArchlinuxTemplate/ +redirect_to: https://forum.qubes-os.org/t/19052 +ref: 116 +title: Building Arch Linux template +--- \ No newline at end of file diff --git a/_doc/external/building-guides/building-non-fedora-template.md b/_doc/external/building-guides/building-non-fedora-template.md new file mode 100644 index 00000000..506eeae2 --- /dev/null +++ b/_doc/external/building-guides/building-non-fedora-template.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/building-non-fedora-template/ +- /en/doc/building-non-fedora-template/ +- /doc/BuildingNonFedoraTemplate/ +- /wiki/BuildingNonFedoraTemplate/ +redirect_to: https://forum.qubes-os.org/t/18972 +ref: 117 +title: Building non-Fedora template +--- \ No newline at end of file diff --git a/_doc/external/building-guides/building-whonix-template.md b/_doc/external/building-guides/building-whonix-template.md new file mode 100644 index 00000000..308d9089 --- /dev/null +++ b/_doc/external/building-guides/building-whonix-template.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/building-whonix-template/ +- /en/doc/building-whonix-template/ +redirect_to: https://forum.qubes-os.org/t/18981 +ref: 115 +title: Building Whonix templates +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/change-time-zone.md b/_doc/external/configuration-guides/change-time-zone.md new file mode 100644 index 00000000..7198e9fc --- /dev/null +++ b/_doc/external/configuration-guides/change-time-zone.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/change-time-zone/ +redirect_to: https://forum.qubes-os.org/t/18983 +ref: 109 +title: Changing your time zone +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/disk-trim.md b/_doc/external/configuration-guides/disk-trim.md new file mode 100644 index 00000000..9d183437 --- /dev/null +++ b/_doc/external/configuration-guides/disk-trim.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/disk-trim/ +- /en/doc/disk-trim/ +- /doc/DiskTRIM/ +- /wiki/DiskTRIM/ +redirect_to: https://forum.qubes-os.org/t/19054 +ref: 104 +title: Disk TRIM +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/external-audio.md b/_doc/external/configuration-guides/external-audio.md new file mode 100644 index 00000000..390a4917 --- /dev/null +++ b/_doc/external/configuration-guides/external-audio.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/external-audio/ +- /en/doc/external-audio/ +- /doc/ExternalAudio/ +- /wiki/ExternalAudio/ +redirect_to: https://forum.qubes-os.org/t/18984 +ref: 100 +title: External audio +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/fetchmail.md b/_doc/external/configuration-guides/fetchmail.md new file mode 100644 index 00000000..b0a894d9 --- /dev/null +++ b/_doc/external/configuration-guides/fetchmail.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/fetchmail/ +- /en/doc/fetchmail/ +- /doc/Fetchmail/ +- /wiki/Fetchmail/ +redirect_to: https://forum.qubes-os.org/t/18985 +ref: 114 +title: Fetchmail +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/install-nvidia-driver.md b/_doc/external/configuration-guides/install-nvidia-driver.md new file mode 100644 index 00000000..ed385571 --- /dev/null +++ b/_doc/external/configuration-guides/install-nvidia-driver.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/install-nvidia-driver/ +- /en/doc/install-nvidia-driver/ +- /doc/InstallNvidiaDriver/ +- /wiki/InstallNvidiaDriver/ +redirect_to: https://forum.qubes-os.org/t/18987 +ref: 96 +title: How to install an Nvidia driver +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/multiboot.md b/_doc/external/configuration-guides/multiboot.md new file mode 100644 index 00000000..cb2e694a --- /dev/null +++ b/_doc/external/configuration-guides/multiboot.md @@ -0,0 +1,7 @@ +--- +lang: en +layout: doc +redirect_to: https://forum.qubes-os.org/t/18988 +ref: 112 +title: Multibooting +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/multimedia.md b/_doc/external/configuration-guides/multimedia.md new file mode 100644 index 00000000..4427af9c --- /dev/null +++ b/_doc/external/configuration-guides/multimedia.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/multimedia/ +- /en/doc/multimedia/ +- /doc/Multimedia/ +- /wiki/Multimedia/ +redirect_to: https://forum.qubes-os.org/t/19055 +ref: 105 +title: How to make a multimedia template +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/mutt.md b/_doc/external/configuration-guides/mutt.md new file mode 100644 index 00000000..677fd915 --- /dev/null +++ b/_doc/external/configuration-guides/mutt.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/mutt/ +- /en/doc/mutt/ +- /doc/Mutt/ +- /wiki/Mutt/ +redirect_to: https://forum.qubes-os.org/t/18989 +ref: 106 +title: Mutt +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/network-bridge-support.md b/_doc/external/configuration-guides/network-bridge-support.md new file mode 100644 index 00000000..54b28914 --- /dev/null +++ b/_doc/external/configuration-guides/network-bridge-support.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/network-bridge-support/ +- /en/doc/network-bridge-support/ +- /doc/NetworkBridgeSupport/ +- /wiki/NetworkBridgeSupport/ +redirect_to: https://forum.qubes-os.org/t/18990 +ref: 113 +title: Network bridge support +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/network-printer.md b/_doc/external/configuration-guides/network-printer.md new file mode 100644 index 00000000..f2f4aa2d --- /dev/null +++ b/_doc/external/configuration-guides/network-printer.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/network-printer/ +- /en/doc/network-printer/ +- /doc/NetworkPrinter/ +- /wiki/NetworkPrinter/ +redirect_to: https://forum.qubes-os.org/t/19056 +ref: 108 +title: Network printer +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/postfix.md b/_doc/external/configuration-guides/postfix.md new file mode 100644 index 00000000..8bef059c --- /dev/null +++ b/_doc/external/configuration-guides/postfix.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/postfix/ +- /en/doc/postfix/ +- /doc/Postfix/ +- /wiki/Postfix/ +redirect_to: https://forum.qubes-os.org/t/18991 +ref: 107 +title: Postfix +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/rxvt.md b/_doc/external/configuration-guides/rxvt.md new file mode 100644 index 00000000..54649508 --- /dev/null +++ b/_doc/external/configuration-guides/rxvt.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/rxvt/ +- /en/doc/rxvt/ +- /doc/Rxvt/ +- /wiki/Rxvt/ +redirect_to: https://forum.qubes-os.org/t/18992 +ref: 103 +title: Rxvt +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/vpn.md b/_doc/external/configuration-guides/vpn.md new file mode 100644 index 00000000..37681f7c --- /dev/null +++ b/_doc/external/configuration-guides/vpn.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/vpn/ +- /doc/privacy/vpn/ +- /en/doc/vpn/ +- /doc/VPN/ +- /wiki/VPN/ +redirect_to: https://forum.qubes-os.org/t/19061 +ref: 102 +title: VPN +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/w3m.md b/_doc/external/configuration-guides/w3m.md new file mode 100644 index 00000000..e961234c --- /dev/null +++ b/_doc/external/configuration-guides/w3m.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/w3m/ +- /en/doc/mutt/ +- /doc/W3m/ +- /wiki/W3m/ +redirect_to: https://forum.qubes-os.org/t/18993 +ref: 101 +title: Reducing the fingerprint of the text-based web browser w3m +--- \ No newline at end of file diff --git a/_doc/external/configuration-guides/zfs.md b/_doc/external/configuration-guides/zfs.md new file mode 100644 index 00000000..e9b84ccf --- /dev/null +++ b/_doc/external/configuration-guides/zfs.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/zfs/ +- /en/doc/zfs/ +- /doc/ZFS/ +- /wiki/ZFS/ +redirect_to: https://forum.qubes-os.org/t/18994 +ref: 111 +title: ZFS +--- \ No newline at end of file diff --git a/_doc/external/customization-guides/dark-theme.md b/_doc/external/customization-guides/dark-theme.md new file mode 100644 index 00000000..2ef63d5c --- /dev/null +++ b/_doc/external/customization-guides/dark-theme.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/dark-theme/ +redirect_to: https://forum.qubes-os.org/t/18997 +ref: 74 +title: Dark theme +--- \ No newline at end of file diff --git a/_doc/external/customization-guides/fedora-minimal-template-customization.md b/_doc/external/customization-guides/fedora-minimal-template-customization.md new file mode 100644 index 00000000..60515f3b --- /dev/null +++ b/_doc/external/customization-guides/fedora-minimal-template-customization.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /en/doc/fedora-minimal-template-customization/ +redirect_to: https://forum.qubes-os.org/t/18999 +ref: 76 +title: Fedora minimal template customization +--- \ No newline at end of file diff --git a/_doc/external/customization-guides/language-localization.md b/_doc/external/customization-guides/language-localization.md new file mode 100644 index 00000000..215307f9 --- /dev/null +++ b/_doc/external/customization-guides/language-localization.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/language-localization/ +- /en/doc/language-localization/ +- /doc/LanguageLocalization/ +- /wiki/LanguageLocalization/ +redirect_to: https://forum.qubes-os.org/t/19001 +ref: 73 +title: Language localization +--- \ No newline at end of file diff --git a/_doc/external/customization-guides/removing-templatevm-packages.md b/_doc/external/customization-guides/removing-templatevm-packages.md new file mode 100644 index 00000000..c6417261 --- /dev/null +++ b/_doc/external/customization-guides/removing-templatevm-packages.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/removing-templatevm-packages/ +redirect_to: https://forum.qubes-os.org/t/19002 +ref: 75 +title: Removing template packages +--- \ No newline at end of file diff --git a/_doc/external/customization-guides/windows-template-customization.md b/_doc/external/customization-guides/windows-template-customization.md new file mode 100644 index 00000000..f8b59556 --- /dev/null +++ b/_doc/external/customization-guides/windows-template-customization.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/windows-template-customization/ +redirect_to: https://forum.qubes-os.org/t/19005 +ref: 72 +title: Windows template customization +--- \ No newline at end of file diff --git a/_doc/external/os-guides/centos.md b/_doc/external/os-guides/centos.md new file mode 100644 index 00000000..2337266d --- /dev/null +++ b/_doc/external/os-guides/centos.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/templates/centos/ +redirect_to: https://forum.qubes-os.org/t/19006 +ref: 81 +title: CentOS template +--- \ No newline at end of file diff --git a/_doc/external/os-guides/gentoo.md b/_doc/external/os-guides/gentoo.md new file mode 100644 index 00000000..186faf50 --- /dev/null +++ b/_doc/external/os-guides/gentoo.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/templates/gentoo/ +redirect_to: https://forum.qubes-os.org/t/19007 +ref: 221 +title: Gentoo template +--- \ No newline at end of file diff --git a/_doc/external/os-guides/linux-hvm-tips.md b/_doc/external/os-guides/linux-hvm-tips.md new file mode 100644 index 00000000..5ecb9125 --- /dev/null +++ b/_doc/external/os-guides/linux-hvm-tips.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/linux-hvm-tips/ +- /en/doc/linux-hvm-tips/ +- /doc/LinuxHVMTips/ +- /wiki/LinuxHVMTips/ +redirect_to: https://forum.qubes-os.org/t/19008 +ref: 82 +title: Linux HVM tips +--- \ No newline at end of file diff --git a/_doc/external/os-guides/netbsd.md b/_doc/external/os-guides/netbsd.md new file mode 100644 index 00000000..18218f7f --- /dev/null +++ b/_doc/external/os-guides/netbsd.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/netbsd/ +redirect_to: https://forum.qubes-os.org/t/19009 +ref: 84 +title: How to create a NetBSD qube +--- \ No newline at end of file diff --git a/_doc/external/os-guides/pentesting/blackarch.md b/_doc/external/os-guides/pentesting/blackarch.md new file mode 100644 index 00000000..11069511 --- /dev/null +++ b/_doc/external/os-guides/pentesting/blackarch.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/pentesting/blackarch/ +- /doc/blackarch/ +redirect_to: https://forum.qubes-os.org/t/19010 +ref: 88 +title: How to create a BlackArch qube +--- \ No newline at end of file diff --git a/_doc/external/os-guides/pentesting/kali.md b/_doc/external/os-guides/pentesting/kali.md new file mode 100644 index 00000000..f9df9154 --- /dev/null +++ b/_doc/external/os-guides/pentesting/kali.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/pentesting/kali/ +- /doc/kali/ +redirect_to: https://forum.qubes-os.org/t/19071 +ref: 87 +title: How to create a Kali Linux qube +--- \ No newline at end of file diff --git a/_doc/external/os-guides/pentesting/ptf.md b/_doc/external/os-guides/pentesting/ptf.md new file mode 100644 index 00000000..a2d38d83 --- /dev/null +++ b/_doc/external/os-guides/pentesting/ptf.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/pentesting/ptf/ +- /doc/ptf/ +redirect_to: https://forum.qubes-os.org/t/19011 +ref: 89 +title: How to create penetration testers framework (PTF) qube +--- \ No newline at end of file diff --git a/_doc/external/os-guides/ubuntu.md b/_doc/external/os-guides/ubuntu.md new file mode 100644 index 00000000..ef087aad --- /dev/null +++ b/_doc/external/os-guides/ubuntu.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/templates/ubuntu/ +- /doc/ubuntu/ +- /en/doc/templates/ubuntu/ +- /doc/Templates/Ubuntu/ +- /wiki/Templates/Ubuntu/ +redirect_to: https://qubes.3isec.org +ref: 80 +title: Ubuntu template +--- \ No newline at end of file diff --git a/_doc/external/privacy-guides/anonymizing-your-mac-address.md b/_doc/external/privacy-guides/anonymizing-your-mac-address.md new file mode 100644 index 00000000..6576e0d9 --- /dev/null +++ b/_doc/external/privacy-guides/anonymizing-your-mac-address.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/anonymizing-your-mac-address/ +- /doc/randomizing-your-mac-address/ +redirect_to: https://forum.qubes-os.org/t/19072 +ref: 67 +title: Anonymizing your MAC address +--- \ No newline at end of file diff --git a/_doc/external/privacy-guides/signal.md b/_doc/external/privacy-guides/signal.md new file mode 100644 index 00000000..fd4fa91b --- /dev/null +++ b/_doc/external/privacy-guides/signal.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/signal/ +redirect_to: https://forum.qubes-os.org/t/19073 +ref: 70 +title: Signal +--- \ No newline at end of file diff --git a/_doc/external/privacy-guides/tails.md b/_doc/external/privacy-guides/tails.md new file mode 100644 index 00000000..5b4299c1 --- /dev/null +++ b/_doc/external/privacy-guides/tails.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/tails/ +- /doc/running-tails/ +redirect_to: https://forum.qubes-os.org/t/19012 +ref: 71 +title: Running Tails in qubes +--- \ No newline at end of file diff --git a/_doc/external/privacy-guides/torvm.md b/_doc/external/privacy-guides/torvm.md new file mode 100644 index 00000000..d4d21660 --- /dev/null +++ b/_doc/external/privacy-guides/torvm.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/torvm/ +- /doc/privacy/torvm/ +- /en/doc/torvm/ +- /doc/TorVM/ +- /doc/UserDoc/TorVM/ +- /wiki/UserDoc/TorVM/ +redirect_to: https://forum.qubes-os.org/t/19013 +ref: 68 +title: TorVM +--- \ No newline at end of file diff --git a/_doc/external/privacy-guides/whonix.md b/_doc/external/privacy-guides/whonix.md new file mode 100644 index 00000000..41c216ee --- /dev/null +++ b/_doc/external/privacy-guides/whonix.md @@ -0,0 +1,22 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/whonix/ +- /doc/privacy/whonix/ +- /doc/templates/whonix/ +- /en/doc/templates/whonix/ +- /doc/Templates/Whonix/ +- /wiki/Templates/Whonix/ +- /doc/whonix/customize/ +- /doc/privacy/customizing-whonix/ +- /doc/whonix/install/ +- /doc/privacy/install-whonix/ +- /doc/whonix/uninstall/ +- /doc/privacy/uninstall-whonix/ +- /doc/whonix/update/ +- /doc/privacy/updating-whonix/ +redirect_to: https://forum.qubes-os.org/t/19014 +ref: 69 +title: Whonix for privacy & anonymity +--- \ No newline at end of file diff --git a/_doc/external/security-guides/multifactor-authentication.md b/_doc/external/security-guides/multifactor-authentication.md new file mode 100644 index 00000000..75d5a6f0 --- /dev/null +++ b/_doc/external/security-guides/multifactor-authentication.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/multifactor-authentication/ +- /en/doc/multifactor-authentication/ +- /doc/Multi-factorAuthentication/ +redirect_to: https://forum.qubes-os.org/t/19016 +ref: 78 +title: Multifactor authentication +--- \ No newline at end of file diff --git a/_doc/external/security-guides/security-guidelines.md b/_doc/external/security-guides/security-guidelines.md new file mode 100644 index 00000000..4c6298fb --- /dev/null +++ b/_doc/external/security-guides/security-guidelines.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/security-guidelines/ +- /en/doc/security-guidelines/ +- /doc/SecurityGuidelines/ +- /wiki/SecurityGuidelines/ +redirect_to: https://forum.qubes-os.org/t/19075 +ref: 79 +title: Security guidelines +--- \ No newline at end of file diff --git a/_doc/external/security-guides/split-bitcoin.md b/_doc/external/security-guides/split-bitcoin.md new file mode 100644 index 00000000..37c9566f --- /dev/null +++ b/_doc/external/security-guides/split-bitcoin.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/split-bitcoin/ +redirect_to: https://forum.qubes-os.org/t/19017 +ref: 77 +title: Split Bitcoin +--- \ No newline at end of file diff --git a/_doc/external/troubleshooting/application-troubleshooting.md b/_doc/external/troubleshooting/application-troubleshooting.md new file mode 100644 index 00000000..6d4163f2 --- /dev/null +++ b/_doc/external/troubleshooting/application-troubleshooting.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/application-troubleshooting/ +redirect_to: https://forum.qubes-os.org/t/19019 +ref: 236 +title: Application troubleshooting +--- \ No newline at end of file diff --git a/_doc/external/troubleshooting/intel-igfx-troubleshooting.md b/_doc/external/troubleshooting/intel-igfx-troubleshooting.md new file mode 100644 index 00000000..47004658 --- /dev/null +++ b/_doc/external/troubleshooting/intel-igfx-troubleshooting.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/intel-igfx-troubleshooting/ +redirect_to: https://forum.qubes-os.org/t/19081 +ref: 90 +title: Intel integrated graphics troubleshooting +--- \ No newline at end of file diff --git a/_doc/external/troubleshooting/macbook-troubleshooting.md b/_doc/external/troubleshooting/macbook-troubleshooting.md new file mode 100644 index 00000000..940cf2a0 --- /dev/null +++ b/_doc/external/troubleshooting/macbook-troubleshooting.md @@ -0,0 +1,7 @@ +--- +lang: en +layout: doc +redirect_to: https://forum.qubes-os.org/t/19020 +ref: 238 +title: Apple MacBook troubleshooting +--- \ No newline at end of file diff --git a/_doc/external/troubleshooting/nvidia-troubleshooting.md b/_doc/external/troubleshooting/nvidia-troubleshooting.md new file mode 100644 index 00000000..d0650d36 --- /dev/null +++ b/_doc/external/troubleshooting/nvidia-troubleshooting.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/NvidiaTroubleshooting/ +- /wiki/NvidiaTroubleshooting/ +redirect_to: https://forum.qubes-os.org/t/19021 +ref: 91 +title: Nvidia troubleshooting +--- \ No newline at end of file diff --git a/_doc/external/troubleshooting/sony-vaio-tinkering.md b/_doc/external/troubleshooting/sony-vaio-tinkering.md new file mode 100644 index 00000000..a0d00137 --- /dev/null +++ b/_doc/external/troubleshooting/sony-vaio-tinkering.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/sony-vaio-tinkering/ +- /en/doc/sony-vaio-tinkering/ +- /doc/SonyVaioTinkering/ +- /wiki/SonyVaioTinkering/ +redirect_to: https://forum.qubes-os.org/t/19022 +ref: 93 +title: Sony Vaio tinkering +--- \ No newline at end of file diff --git a/_doc/external/troubleshooting/tails-troubleshooting.md b/_doc/external/troubleshooting/tails-troubleshooting.md new file mode 100644 index 00000000..9bde8c71 --- /dev/null +++ b/_doc/external/troubleshooting/tails-troubleshooting.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/tails-troubleshooting/ +redirect_to: https://forum.qubes-os.org/t/19023 +ref: 237 +title: Tails troubleshooting +--- \ No newline at end of file diff --git a/_doc/external/troubleshooting/thinkpad-troubleshooting.md b/_doc/external/troubleshooting/thinkpad-troubleshooting.md new file mode 100644 index 00000000..0c8fc1c9 --- /dev/null +++ b/_doc/external/troubleshooting/thinkpad-troubleshooting.md @@ -0,0 +1,17 @@ +--- +lang: en +layout: doc +redirect_from: +- /doc/thinkpad-troubleshooting/ +- /doc/thinkpad_x201/ +- /en/doc/thinkpad_x201/ +- /doc/Thinkpad_X201/ +- /wiki/Thinkpad_X201/ +- /doc/lenovo450-tinkering/ +- /en/doc/lenovo450-tinkering/ +- /doc/Lenovo450Tinkering/ +- /wiki/Lenovo450Tinkering/ +redirect_to: https://forum.qubes-os.org/t/19024 +ref: 95 +title: Lenovo ThinkPad troubleshooting +--- \ No newline at end of file diff --git a/_doc/introduction/code-of-conduct.md b/_doc/introduction/code-of-conduct.md new file mode 100644 index 00000000..ed73f83d --- /dev/null +++ b/_doc/introduction/code-of-conduct.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /code-of-conduct/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/code-of-conduct.html +ref: 118 +title: Code of conduct +--- \ No newline at end of file diff --git a/_doc/introduction/contributing.md b/_doc/introduction/contributing.md new file mode 100644 index 00000000..e8b636f3 --- /dev/null +++ b/_doc/introduction/contributing.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/contributing/ +redirect_from: +- /en/doc/contributing/ +- /doc/ContributingHowto/ +- /wiki/ContributingHowto/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/contributing.html +ref: 125 +title: How to contribute +--- \ No newline at end of file diff --git a/_doc/introduction/faq.md b/_doc/introduction/faq.md new file mode 100644 index 00000000..ac4efb83 --- /dev/null +++ b/_doc/introduction/faq.md @@ -0,0 +1,17 @@ +--- +lang: en +layout: doc +permalink: /faq/ +redirect_from: +- /doc/user-faq/ +- /en/doc/user-faq/ +- /doc/UserFaq/ +- /wiki/UserFaq/ +- /doc/devel-faq/ +- /en/doc/devel-faq/ +- /doc/DevelFaq/ +- /wiki/DevelFaq/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/faq.html +ref: 124 +title: Frequently asked questions (FAQ) +--- \ No newline at end of file diff --git a/_doc/introduction/getting-started.md b/_doc/introduction/getting-started.md new file mode 100644 index 00000000..4c540f46 --- /dev/null +++ b/_doc/introduction/getting-started.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/getting-started/ +redirect_from: +- /doc/how-to-get-started/ +- /getting-started/ +- /en/doc/getting-started/ +- /doc/GettingStarted/ +- /wiki/GettingStarted/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/getting-started.html +ref: 190 +title: Getting started +--- \ No newline at end of file diff --git a/_doc/introduction/intro.md b/_doc/introduction/intro.md new file mode 100644 index 00000000..d3d721cd --- /dev/null +++ b/_doc/introduction/intro.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: site +permalink: /intro/ +redirect_from: +- /tour/ +- /en/tour/ +- /about/ +- /en/about/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/intro.html +ref: 126 +title: Introduction +--- \ No newline at end of file diff --git a/_doc/introduction/issue-tracking.md b/_doc/introduction/issue-tracking.md new file mode 100644 index 00000000..1704385e --- /dev/null +++ b/_doc/introduction/issue-tracking.md @@ -0,0 +1,18 @@ +--- +lang: en +layout: doc +permalink: /doc/issue-tracking/ +redirect_from: +- /doc/reporting-bugs/ +- /en/doc/reporting-bugs/ +- /doc/BugReportingGuide/ +- /wiki/BugReportingGuide/ +- /reporting-bugs/ +- /bug/ +- /bugs/ +- /bug-report/ +- /bug-reports/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/issue-tracking.html +ref: 121 +title: Issue tracking +--- \ No newline at end of file diff --git a/_doc/introduction/privacy.md b/_doc/introduction/privacy.md new file mode 100644 index 00000000..fc4f49b1 --- /dev/null +++ b/_doc/introduction/privacy.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /privacy/ +redirect_from: +- /en/privacy/ +- /doc/privacy/ +- /wiki/privacy/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/privacy.html +ref: 243 +title: Privacy policy +--- \ No newline at end of file diff --git a/_doc/introduction/screenshots.md b/_doc/introduction/screenshots.md new file mode 100644 index 00000000..9c57313f --- /dev/null +++ b/_doc/introduction/screenshots.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: site +permalink: /screenshots/ +redirect_from: +- /media/ +- /doc/QubesScreenshots/ +- /wiki/QubesScreenshots/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/screenshots.html +ref: 123 +title: Screenshots +--- \ No newline at end of file diff --git a/_doc/introduction/statistics.md b/_doc/introduction/statistics.md new file mode 100644 index 00000000..c5021ef1 --- /dev/null +++ b/_doc/introduction/statistics.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: site +permalink: /statistics/ +redirect_from: +- /counter/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/statistics.html +ref: 127 +title: Statistics +--- \ No newline at end of file diff --git a/_doc/introduction/support.md b/_doc/introduction/support.md new file mode 100644 index 00000000..54c0edea --- /dev/null +++ b/_doc/introduction/support.md @@ -0,0 +1,17 @@ +--- +lang: en +layout: doc +permalink: /support/ +redirect_from: +- /help/ +- /mailing-lists/ +- /doc/mailing-lists/ +- /en/doc/mailing-lists/ +- /en/doc/qubes-lists/ +- /doc/qubes-lists/ +- /doc/QubesLists/ +- /wiki/QubesLists/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/support.html +ref: 122 +title: Help, support, mailing lists, and forum +--- \ No newline at end of file diff --git a/_doc/introduction/video-tours.md b/_doc/introduction/video-tours.md new file mode 100644 index 00000000..69dc8ee1 --- /dev/null +++ b/_doc/introduction/video-tours.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: site +permalink: /video-tours/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/introduction/video-tours.html +ref: 226 +title: Video tours +--- \ No newline at end of file diff --git a/_doc/project-security/security-pack.md b/_doc/project-security/security-pack.md new file mode 100644 index 00000000..c01a87f6 --- /dev/null +++ b/_doc/project-security/security-pack.md @@ -0,0 +1,20 @@ +--- +lang: en +layout: doc +permalink: /security/pack/ +redirect_from: +- /doc/security-pack/ +- /en/doc/security-pack/ +- /security-pack/ +- /doc/SecurityPack/ +- /wiki/SecurityPack/ +- /qsp/ +- /sec-pack/ +- /secpack/ +- /doc/qsp/ +- /doc/sec-pack/ +- /doc/secpack/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/project-security/security-pack.html +ref: 213 +title: Qubes security pack (qubes-secpack) +--- \ No newline at end of file diff --git a/_doc/project-security/security.md b/_doc/project-security/security.md new file mode 100644 index 00000000..ae3cb87f --- /dev/null +++ b/_doc/project-security/security.md @@ -0,0 +1,18 @@ +--- +lang: en +layout: doc +permalink: /security/ +redirect_from: +- /en/security/ +- /en/doc/security/ +- /en/doc/qubes-security/ +- /doc/QubesSecurity/ +- /wiki/QubesSecurity/ +- /en/doc/security-page/ +- /doc/SecurityPage/ +- /wiki/SecurityPage/ +- /trac/wiki/SecurityPage/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/project-security/security.html +ref: 217 +title: Qubes OS project security center +--- \ No newline at end of file diff --git a/_doc/project-security/verifying-signatures.md b/_doc/project-security/verifying-signatures.md new file mode 100644 index 00000000..b4e3d796 --- /dev/null +++ b/_doc/project-security/verifying-signatures.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /security/verifying-signatures/ +redirect_from: +- /doc/verifying-signatures/ +- /en/doc/verifying-signatures/ +- /doc/VerifyingSignatures/ +- /wiki/VerifyingSignatures/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/project-security/verifying-signatures.html +ref: 211 +title: Verifying signatures +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/awesomewm.md b/_doc/user/advanced-topics/awesomewm.md new file mode 100644 index 00000000..608efe1d --- /dev/null +++ b/_doc/user/advanced-topics/awesomewm.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/awesomewm/ +redirect_from: +- /doc/awesome/ +- /en/doc/awesome/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/awesomewm.html +ref: 179 +title: AwesomeWM (window manager) +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/bind-dirs.md b/_doc/user/advanced-topics/bind-dirs.md new file mode 100644 index 00000000..a2404633 --- /dev/null +++ b/_doc/user/advanced-topics/bind-dirs.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/bind-dirs/ +redirect_from: +- /en/doc/bind-dirs/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/bind-dirs.html +ref: 186 +title: How to make any file persistent (bind-dirs) +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/config-files.md b/_doc/user/advanced-topics/config-files.md new file mode 100644 index 00000000..14495b08 --- /dev/null +++ b/_doc/user/advanced-topics/config-files.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/config-files/ +redirect_from: +- /en/doc/config-files/ +- /doc/ConfigFiles/ +- /doc/UserDoc/ConfigFiles/ +- /wiki/UserDoc/ConfigFiles/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/config-files.html +ref: 180 +title: Config files +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/disposable-customization.md b/_doc/user/advanced-topics/disposable-customization.md new file mode 100644 index 00000000..278b814b --- /dev/null +++ b/_doc/user/advanced-topics/disposable-customization.md @@ -0,0 +1,15 @@ +--- +lang: en +layout: doc +permalink: /doc/disposable-customization/ +redirect_from: +- /doc/disposablevm-customization/ +- /doc/dispvm-customization/ +- /en/doc/dispvm-customization/ +- /doc/DispVMCustomization/ +- /doc/UserDoc/DispVMCustomization/ +- /wiki/UserDoc/DispVMCustomization/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/disposable-customization.html +ref: 174 +title: Disposable customization +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/gui-configuration.md b/_doc/user/advanced-topics/gui-configuration.md new file mode 100644 index 00000000..c776025c --- /dev/null +++ b/_doc/user/advanced-topics/gui-configuration.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/gui-configuration/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/gui-configuration.html +ref: 184 +title: GUI configuration +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/gui-domain.md b/_doc/user/advanced-topics/gui-domain.md new file mode 100644 index 00000000..ef0fe778 --- /dev/null +++ b/_doc/user/advanced-topics/gui-domain.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/gui-domain/ +redirect_from: +- /doc/guivm-configuration/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/gui-domain.html +ref: 184 +title: GUI domain +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/how-to-install-software-in-dom0.md b/_doc/user/advanced-topics/how-to-install-software-in-dom0.md new file mode 100644 index 00000000..98ba6a7c --- /dev/null +++ b/_doc/user/advanced-topics/how-to-install-software-in-dom0.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-install-software-in-dom0/ +redirect_from: +- /doc/software-update-dom0/ +- /en/doc/software-update-dom0/ +- /doc/SoftwareUpdateDom0/ +- /wiki/SoftwareUpdateDom0/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/how-to-install-software-in-dom0.html +ref: 194 +title: How to install software in dom0 +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/i3.md b/_doc/user/advanced-topics/i3.md new file mode 100644 index 00000000..b1948e79 --- /dev/null +++ b/_doc/user/advanced-topics/i3.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/i3/ +redirect_from: +- /en/doc/i3/ +- /doc/UserDoc/i3/ +- /wiki/UserDoc/i3/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/i3.html +ref: 183 +title: i3 (window manager) +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/installing-contributed-packages.md b/_doc/user/advanced-topics/installing-contributed-packages.md new file mode 100644 index 00000000..ab883bc9 --- /dev/null +++ b/_doc/user/advanced-topics/installing-contributed-packages.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/installing-contributed-packages/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/installing-contributed-packages.html +ref: 225 +title: Installing contributed packages +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/kde.md b/_doc/user/advanced-topics/kde.md new file mode 100644 index 00000000..23f428fa --- /dev/null +++ b/_doc/user/advanced-topics/kde.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/kde/ +redirect_from: +- /en/doc/kde/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/kde.html +ref: 176 +title: KDE (desktop environment) +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/managing-vm-kernels.md b/_doc/user/advanced-topics/managing-vm-kernels.md new file mode 100644 index 00000000..f17bec31 --- /dev/null +++ b/_doc/user/advanced-topics/managing-vm-kernels.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/managing-vm-kernels/ +redirect_from: +- /doc/managing-vm-kernel/ +- /en/doc/managing-vm-kernel/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/managing-vm-kernels.html +ref: 173 +title: Managing qube kernels +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/mount-from-other-os.md b/_doc/user/advanced-topics/mount-from-other-os.md new file mode 100644 index 00000000..9c248c8a --- /dev/null +++ b/_doc/user/advanced-topics/mount-from-other-os.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/mount-from-other-os/ +redirect_from: +- /en/doc/mount-from-other-os/ +- /doc/MountFromOtherOs/ +- /wiki/MountFromOtherOs/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/mount-from-other-os.html +ref: 175 +title: How to mount a Qubes partition from another OS +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/qubes-service.md b/_doc/user/advanced-topics/qubes-service.md new file mode 100644 index 00000000..6eac7025 --- /dev/null +++ b/_doc/user/advanced-topics/qubes-service.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/qubes-service/ +redirect_from: +- /en/doc/qubes-service/ +- /doc/QubesService/ +- /wiki/QubesService/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/qubes-service.html +ref: 138 +title: Qubes service +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/resize-disk-image.md b/_doc/user/advanced-topics/resize-disk-image.md new file mode 100644 index 00000000..dd074d0a --- /dev/null +++ b/_doc/user/advanced-topics/resize-disk-image.md @@ -0,0 +1,15 @@ +--- +lang: en +layout: doc +permalink: /doc/resize-disk-image/ +redirect_from: +- /en/doc/resize-disk-image/ +- /en/doc/resize-root-disk-image/ +- /doc/ResizeDiskImage/ +- /doc/ResizeRootDiskImage/ +- /wiki/ResizeDiskImage/ +- /wiki/ResizeRootDiskImage/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/resize-disk-image.html +ref: 182 +title: Resize disk image +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/rpc-policy.md b/_doc/user/advanced-topics/rpc-policy.md new file mode 100644 index 00000000..59e257bd --- /dev/null +++ b/_doc/user/advanced-topics/rpc-policy.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/rpc-policy/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/rpc-policy.html +ref: 178 +title: RPC policies +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/salt.md b/_doc/user/advanced-topics/salt.md new file mode 100644 index 00000000..79a37e63 --- /dev/null +++ b/_doc/user/advanced-topics/salt.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/salt/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/salt.html +ref: 185 +title: Salt (management software) +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/secondary-storage.md b/_doc/user/advanced-topics/secondary-storage.md new file mode 100644 index 00000000..297a9768 --- /dev/null +++ b/_doc/user/advanced-topics/secondary-storage.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/secondary-storage/ +redirect_from: +- /en/doc/secondary-storage/ +- /doc/SecondaryStorage/ +- /wiki/SecondaryStorage/ +- /doc/storage-pools/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/secondary-storage.html +ref: 187 +title: Secondary storage +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/standalones-and-hvms.md b/_doc/user/advanced-topics/standalones-and-hvms.md new file mode 100644 index 00000000..53574f3d --- /dev/null +++ b/_doc/user/advanced-topics/standalones-and-hvms.md @@ -0,0 +1,16 @@ +--- +lang: en +layout: doc +permalink: /doc/standalones-and-hvms/ +redirect_from: +- /doc/standalones-and-hvm/ +- /doc/standalone-and-hvm/ +- /doc/hvm/ +- /doc/hvm-create/ +- /en/doc/hvm-create/ +- /doc/HvmCreate/ +- /wiki/HvmCreate/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/standalones-and-hvms.html +ref: 130 +title: Standalones and HVMs +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/usb-qubes.md b/_doc/user/advanced-topics/usb-qubes.md new file mode 100644 index 00000000..70e610d5 --- /dev/null +++ b/_doc/user/advanced-topics/usb-qubes.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/usb-qubes/ +redirect_from: +- /doc/usbvm/ +- /en/doc/usbvm/ +- /doc/USBVM/ +- /wiki/USBVM/ +- /doc/sys-usb/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/usb-qubes.html +ref: 181 +title: USB qubes +--- \ No newline at end of file diff --git a/_doc/user/advanced-topics/volume-backup-revert.md b/_doc/user/advanced-topics/volume-backup-revert.md new file mode 100644 index 00000000..fafbdb52 --- /dev/null +++ b/_doc/user/advanced-topics/volume-backup-revert.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/volume-backup-revert/ +redirect_from: +- /en/doc/volume-backup-revert/ +- /doc/VolumeBackupRevert/ +- /wiki/VolumeBackupRevert/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/advanced-topics/volume-backup-revert.html +ref: 206 +title: Volume backup and revert +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/download-mirrors.md b/_doc/user/downloading-installing-upgrading/download-mirrors.md new file mode 100644 index 00000000..4e5b36f9 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/download-mirrors.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /downloads/mirrors/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/download-mirrors.html +ref: 148 +title: Download mirrors +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/downloads.md b/_doc/user/downloading-installing-upgrading/downloads.md new file mode 100644 index 00000000..8ea9d05d --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/downloads.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: site +permalink: /downloads/ +redirect_from: +- /doc/QubesDownloads/ +- /wiki/QubesDownloads/ +ref: 2 +title: Download Qubes OS +--- +{% include downloads.html %} diff --git a/_doc/user/downloading-installing-upgrading/install-security.md b/_doc/user/downloading-installing-upgrading/install-security.md new file mode 100644 index 00000000..0a49dd98 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/install-security.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/install-security/ +redirect_from: +- /en/doc/install-security/ +- /doc/InstallSecurity/ +- /wiki/InstallSecurity/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/install-security.html +ref: 149 +title: Installation security +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/installation-guide.md b/_doc/user/downloading-installing-upgrading/installation-guide.md new file mode 100644 index 00000000..c06ff7a1 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/installation-guide.md @@ -0,0 +1,23 @@ +--- +lang: en +layout: doc +permalink: /doc/installation-guide/ +redirect_from: +- /en/doc/installation-guide/ +- /doc/InstallationGuide/ +- /wiki/InstallationGuide/ +- /doc/InstallationGuideR1/ +- /doc/InstallationGuideR2B1/ +- /doc/InstallationGuideR2B2/ +- /doc/InstallationGuideR2B3/ +- /doc/InstallationGuideR2rc1/ +- /doc/InstallationGuideR2rc2/ +- /doc/InstallationGuideR3.0rc1/ +- /doc/InstallationGuideR3.0rc2/ +- /doc/live-usb/ +- /doc/custom-install/ +- /doc/encryption-config/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/installation-guide.html +ref: 153 +title: Installation guide +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/supported-releases.md b/_doc/user/downloading-installing-upgrading/supported-releases.md new file mode 100644 index 00000000..0b817c8f --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/supported-releases.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/supported-releases/ +redirect_from: +- /doc/supported-versions/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/supported-releases.html +ref: 154 +title: Supported releases +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/testing.md b/_doc/user/downloading-installing-upgrading/testing.md new file mode 100644 index 00000000..14b7293c --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/testing.md @@ -0,0 +1,9 @@ +--- +advanced: true +lang: en +layout: doc +permalink: /doc/testing/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/testing.html +ref: 147 +title: Testing new releases and updates +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/2.md b/_doc/user/downloading-installing-upgrading/upgrade/2.md new file mode 100644 index 00000000..600574a1 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/2.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/2/ +redirect_from: +- /doc/upgrade-to-r2/ +- /en/doc/upgrade-to-r2/ +- /doc/UpgradeToR2/ +- /doc/UpgradeToR2rc1/ +- /wiki/UpgradeToR2rc1/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/2.html +ref: 156 +title: Upgrading to R2 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/2b1.md b/_doc/user/downloading-installing-upgrading/upgrade/2b1.md new file mode 100644 index 00000000..e20e081b --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/2b1.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/2b1/ +redirect_from: +- /doc/upgrade-to-r2b1/ +- /en/doc/upgrade-to-r2b1/ +- /doc/UpgradeToR2B1/ +- /wiki/UpgradeToR2B1/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/2b1.html +ref: 163 +title: Upgrading to R2B1 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/2b2.md b/_doc/user/downloading-installing-upgrading/upgrade/2b2.md new file mode 100644 index 00000000..85737448 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/2b2.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/2b2/ +redirect_from: +- /doc/upgrade-to-r2b2/ +- /en/doc/upgrade-to-r2b2/ +- /doc/UpgradeToR2B2/ +- /wiki/UpgradeToR2B2/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/2b2.html +ref: 160 +title: Upgrading to R2B2 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/2b3.md b/_doc/user/downloading-installing-upgrading/upgrade/2b3.md new file mode 100644 index 00000000..70dc2130 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/2b3.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/2b3/ +redirect_from: +- /doc/upgrade-to-r2b3/ +- /en/doc/upgrade-to-r2b3/ +- /doc/UpgradeToR2B3/ +- /wiki/UpgradeToR2B3/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/2b3.html +ref: 157 +title: Upgrading to R2B3 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/3_0.md b/_doc/user/downloading-installing-upgrading/upgrade/3_0.md new file mode 100644 index 00000000..6cb8218a --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/3_0.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/3.0/ +redirect_from: +- /doc/upgrade-to-r3.0/ +- /en/doc/upgrade-to-r3.0/ +- /doc/UpgradeToR3.0/ +- /doc/UpgradeToR3.0rc1/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/3_0.html +ref: 159 +title: Upgrading to R3.0 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/3_1.md b/_doc/user/downloading-installing-upgrading/upgrade/3_1.md new file mode 100644 index 00000000..6ed0ae60 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/3_1.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/3.1/ +redirect_from: +- /doc/upgrade-to-r3.1/ +- /en/doc/upgrade-to-r3.1/ +- /doc/UpgradeToR3.1/ +- /doc/UpgradeToR3.1rc1/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/3_1.html +ref: 155 +title: Upgrading to R3.1 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/3_2.md b/_doc/user/downloading-installing-upgrading/upgrade/3_2.md new file mode 100644 index 00000000..5199f73b --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/3_2.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/3.2/ +redirect_from: +- /doc/upgrade-to-r3.2/ +- /en/doc/upgrade-to-r3.2/ +- /doc/UpgradeToR3.2/ +- /doc/UpgradeToR3.2rc1/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/3_2.html +ref: 161 +title: Upgrading to R3.2 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/4_0.md b/_doc/user/downloading-installing-upgrading/upgrade/4_0.md new file mode 100644 index 00000000..5e588076 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/4_0.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/4.0/ +redirect_from: +- /doc/upgrade-to-r4.0/ +- /en/doc/upgrade-to-r4.0/ +- /doc/UpgradeToR4.0/ +- /doc/UpgradeToR4.0rc1/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/4_0.html +ref: 162 +title: Upgrading to R4.0 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/4_1.md b/_doc/user/downloading-installing-upgrading/upgrade/4_1.md new file mode 100644 index 00000000..bcc70b78 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/4_1.md @@ -0,0 +1,7 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/4.1/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/4_1.html +title: How to upgrade to Qubes 4.1 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/4_2.md b/_doc/user/downloading-installing-upgrading/upgrade/4_2.md new file mode 100644 index 00000000..91f0541f --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/4_2.md @@ -0,0 +1,7 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/4.2/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/4_2.html +title: How to upgrade to Qubes 4.2 +--- \ No newline at end of file diff --git a/_doc/user/downloading-installing-upgrading/upgrade/upgrade.md b/_doc/user/downloading-installing-upgrading/upgrade/upgrade.md new file mode 100644 index 00000000..8bc07bc5 --- /dev/null +++ b/_doc/user/downloading-installing-upgrading/upgrade/upgrade.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/upgrade/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/downloading-installing-upgrading/upgrade/upgrade.html +ref: 158 +title: Upgrade guides +--- \ No newline at end of file diff --git a/_doc/user/hardware/certified-hardware.md b/_doc/user/hardware/certified-hardware.md new file mode 100644 index 00000000..a198b13b --- /dev/null +++ b/_doc/user/hardware/certified-hardware.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/certified-hardware/ +redirect_from: +- /doc/hardware/ +- /doc/certified-laptops/ +- /hardware-certification/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/hardware/certified-hardware.html +ref: 144 +title: Certified hardware +--- \ No newline at end of file diff --git a/_doc/user/hardware/community-recommended-hardware.md b/_doc/user/hardware/community-recommended-hardware.md new file mode 100644 index 00000000..fe6e87f3 --- /dev/null +++ b/_doc/user/hardware/community-recommended-hardware.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +permalink: /doc/community-recommended-hardware/ +redirect_from: /doc/hardware-testing/ +redirect_to: https://forum.qubes-os.org/t/5560 +ref: 145 +title: Community-recommended hardware +--- \ No newline at end of file diff --git a/_doc/user/hardware/hcl.md b/_doc/user/hardware/hcl.md new file mode 100644 index 00000000..3c1f3ff3 --- /dev/null +++ b/_doc/user/hardware/hcl.md @@ -0,0 +1,16 @@ +--- +lang: en +layout: hcl +model: all +permalink: /hcl/ +redirect_from: +- /doc/hcl/ +- /compatible-hardware/ +- /en/doc/hcl/ +- /doc/HCL/ +- /wiki/HCL/ +- /wiki/HCLR1/ +- /wiki/HCL-R2B2/ +ref: 143 +title: Hardware compatibility list (HCL) +--- diff --git a/_doc/user/hardware/how-to-use-the-hcl.md b/_doc/user/hardware/how-to-use-the-hcl.md new file mode 100644 index 00000000..8555a3b0 --- /dev/null +++ b/_doc/user/hardware/how-to-use-the-hcl.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-use-the-hcl/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/hardware/how-to-use-the-hcl.html +ref: 146 +title: How to use the hardware compatibility list (HCL) +--- \ No newline at end of file diff --git a/_doc/user/hardware/system-requirements.md b/_doc/user/hardware/system-requirements.md new file mode 100644 index 00000000..4102d503 --- /dev/null +++ b/_doc/user/hardware/system-requirements.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/system-requirements/ +redirect_from: +- /system-requirements/ +- /en/doc/system-requirements/ +- /doc/SystemRequirements/ +- /wiki/SystemRequirements/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/hardware/system-requirements.html +ref: 142 +title: System requirements +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/backup-emergency-restore-v2.md b/_doc/user/how-to-guides/backup-emergency-restore-v2.md new file mode 100644 index 00000000..032722d4 --- /dev/null +++ b/_doc/user/how-to-guides/backup-emergency-restore-v2.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/backup-emergency-restore-v2/ +redirect_from: +- /en/doc/backup-emergency-restore-v2/ +- /doc/BackupEmergencyRestoreV2/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/backup-emergency-restore-v2.html +ref: 207 +title: Emergency backup recovery (v2) +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/backup-emergency-restore-v3.md b/_doc/user/how-to-guides/backup-emergency-restore-v3.md new file mode 100644 index 00000000..db4d7165 --- /dev/null +++ b/_doc/user/how-to-guides/backup-emergency-restore-v3.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/backup-emergency-restore-v3/ +redirect_from: +- /en/doc/backup-emergency-restore-v3/ +- /doc/BackupEmergencyRestoreV3/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/backup-emergency-restore-v3.html +ref: 201 +title: Emergency backup recovery (v3) +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/backup-emergency-restore-v4.md b/_doc/user/how-to-guides/backup-emergency-restore-v4.md new file mode 100644 index 00000000..f5c4f513 --- /dev/null +++ b/_doc/user/how-to-guides/backup-emergency-restore-v4.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/backup-emergency-restore-v4/ +redirect_from: +- /en/doc/backup-emergency-restore-v4/ +- /doc/BackupEmergencyRestoreV4/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/backup-emergency-restore-v4.html +ref: 192 +title: Emergency backup recovery (v4) +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-back-up-restore-and-migrate.md b/_doc/user/how-to-guides/how-to-back-up-restore-and-migrate.md new file mode 100644 index 00000000..27490a3b --- /dev/null +++ b/_doc/user/how-to-guides/how-to-back-up-restore-and-migrate.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-back-up-restore-and-migrate/ +redirect_from: +- /doc/backup-restore/ +- /en/doc/backup-restore/ +- /doc/BackupRestore/ +- /wiki/BackupRestore/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-back-up-restore-and-migrate.html +ref: 199 +title: How to back up, restore, and migrate +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-copy-and-move-files.md b/_doc/user/how-to-guides/how-to-copy-and-move-files.md new file mode 100644 index 00000000..55cceffc --- /dev/null +++ b/_doc/user/how-to-guides/how-to-copy-and-move-files.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-copy-and-move-files/ +redirect_from: +- /doc/copying-files/ +- /en/doc/copying-files/ +- /doc/CopyingFiles/ +- /wiki/CopyingFiles/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-copy-and-move-files.html +ref: 191 +title: How to copy and move files +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-copy-and-paste-text.md b/_doc/user/how-to-guides/how-to-copy-and-paste-text.md new file mode 100644 index 00000000..e9b8648c --- /dev/null +++ b/_doc/user/how-to-guides/how-to-copy-and-paste-text.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-copy-and-paste-text/ +redirect_from: +- /doc/copy-paste/ +- /en/doc/copy-paste/ +- /doc/CopyPaste/ +- /wiki/CopyPaste/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-copy-and-paste-text.html +ref: 196 +title: How to copy and paste text +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-copy-from-dom0.md b/_doc/user/how-to-guides/how-to-copy-from-dom0.md new file mode 100644 index 00000000..478c8aaa --- /dev/null +++ b/_doc/user/how-to-guides/how-to-copy-from-dom0.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-copy-from-dom0/ +redirect_from: +- /doc/copy-from-dom0/ +- /doc/copy-to-dom0/ +- /en/doc/copy-to-dom0/ +- /doc/CopyToDomZero/ +- /wiki/CopyToDomZero/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-copy-from-dom0.html +ref: 198 +title: How to copy from dom0 +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-enter-fullscreen-mode.md b/_doc/user/how-to-guides/how-to-enter-fullscreen-mode.md new file mode 100644 index 00000000..9e1a6619 --- /dev/null +++ b/_doc/user/how-to-guides/how-to-enter-fullscreen-mode.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-enter-fullscreen-mode/ +redirect_from: +- /doc/full-screen-mode/ +- /en/doc/full-screen-mode/ +- /doc/FullScreenMode/ +- /wiki/FullScreenMode/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-enter-fullscreen-mode.html +ref: 205 +title: How to enter fullscreen mode +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-install-software.md b/_doc/user/how-to-guides/how-to-install-software.md new file mode 100644 index 00000000..fb95bfbe --- /dev/null +++ b/_doc/user/how-to-guides/how-to-install-software.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-install-software/ +redirect_from: +- /doc/software-update-domu/ +- /doc/software-update-vm/ +- /en/doc/software-update-vm/ +- /doc/SoftwareUpdateVM/ +- /wiki/SoftwareUpdateVM/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-install-software.html +ref: 189 +title: How to install software +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-organize-your-qubes.md b/_doc/user/how-to-guides/how-to-organize-your-qubes.md new file mode 100644 index 00000000..f961ccc2 --- /dev/null +++ b/_doc/user/how-to-guides/how-to-organize-your-qubes.md @@ -0,0 +1,7 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-organize-your-qubes/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-organize-your-qubes.html +title: How to organize your qubes +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-reinstall-a-template.md b/_doc/user/how-to-guides/how-to-reinstall-a-template.md new file mode 100644 index 00000000..d293969a --- /dev/null +++ b/_doc/user/how-to-guides/how-to-reinstall-a-template.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-reinstall-a-template/ +redirect_from: +- /doc/reinstall-template/ +- /doc/whonix/reinstall/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-reinstall-a-template.html +ref: 128 +title: How to reinstall a template +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-update.md b/_doc/user/how-to-guides/how-to-update.md new file mode 100644 index 00000000..9df5dc28 --- /dev/null +++ b/_doc/user/how-to-guides/how-to-update.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-update/ +redirect_from: +- /doc/updating-qubes-os/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-update.html +ref: 200 +title: How to update +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-use-block-storage-devices.md b/_doc/user/how-to-guides/how-to-use-block-storage-devices.md new file mode 100644 index 00000000..cc44e5cd --- /dev/null +++ b/_doc/user/how-to-guides/how-to-use-block-storage-devices.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-use-block-storage-devices/ +redirect_from: +- /doc/block-devices/ +- /doc/stick-mounting/ +- /en/doc/stick-mounting/ +- /doc/StickMounting/ +- /wiki/StickMounting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-use-block-storage-devices.html +ref: 193 +title: How to use block storage devices +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-use-devices.md b/_doc/user/how-to-guides/how-to-use-devices.md new file mode 100644 index 00000000..7a8a094e --- /dev/null +++ b/_doc/user/how-to-guides/how-to-use-devices.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-use-devices/ +redirect_from: +- /doc/device-handling/ +- /doc/external-device-mount-point/ +- /en/doc/external-device-mount-point/ +- /doc/ExternalDeviceMountPoint/ +- /wiki/ExternalDeviceMountPoint/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-use-devices.html +ref: 188 +title: How to use devices +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-use-disposables.md b/_doc/user/how-to-guides/how-to-use-disposables.md new file mode 100644 index 00000000..3556418c --- /dev/null +++ b/_doc/user/how-to-guides/how-to-use-disposables.md @@ -0,0 +1,16 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-use-disposables/ +redirect_from: +- /doc/how-to-use-disposablevms/ +- /doc/disposable/ +- /doc/disposablevm/ +- /doc/dispvm/ +- /en/doc/dispvm/ +- /doc/DisposableVms/ +- /wiki/DisposableVMs/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-use-disposables.html +ref: 203 +title: How to use disposables +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-use-optical-discs.md b/_doc/user/how-to-guides/how-to-use-optical-discs.md new file mode 100644 index 00000000..4fc2ef62 --- /dev/null +++ b/_doc/user/how-to-guides/how-to-use-optical-discs.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-use-optical-discs/ +redirect_from: +- /doc/optical-discs/ +- /doc/recording-optical-discs/ +- /en/doc/recording-optical-discs/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-use-optical-discs.html +ref: 204 +title: How to use optical discs +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-use-pci-devices.md b/_doc/user/how-to-guides/how-to-use-pci-devices.md new file mode 100644 index 00000000..3cbe5d8e --- /dev/null +++ b/_doc/user/how-to-guides/how-to-use-pci-devices.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-use-pci-devices/ +redirect_from: +- /doc/pci-devices/ +- /doc/assigning-devices/ +- /en/doc/assigning-devices/ +- /doc/AssigningDevices/ +- /wiki/AssigningDevices/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-use-pci-devices.html +ref: 197 +title: How to use PCI devices +--- \ No newline at end of file diff --git a/_doc/user/how-to-guides/how-to-use-usb-devices.md b/_doc/user/how-to-guides/how-to-use-usb-devices.md new file mode 100644 index 00000000..e1874d32 --- /dev/null +++ b/_doc/user/how-to-guides/how-to-use-usb-devices.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/how-to-use-usb-devices/ +redirect_from: +- /doc/usb-devices/ +- /doc/usb/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/how-to-guides/how-to-use-usb-devices.html +ref: 195 +title: How to use USB devices +--- \ No newline at end of file diff --git a/_doc/user/reference/glossary.md b/_doc/user/reference/glossary.md new file mode 100644 index 00000000..1df3dfdb --- /dev/null +++ b/_doc/user/reference/glossary.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/glossary/ +redirect_from: +- /en/doc/glossary/ +- /doc/Glossary/ +- /wiki/Glossary/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/reference/glossary.html +ref: 140 +title: Glossary +--- \ No newline at end of file diff --git a/_doc/user/reference/tools.md b/_doc/user/reference/tools.md new file mode 100644 index 00000000..fc89a85d --- /dev/null +++ b/_doc/user/reference/tools.md @@ -0,0 +1,15 @@ +--- +lang: en +layout: doc +permalink: /doc/tools/ +redirect_from: +- /doc/tools/4.0/ +- /doc/tools/4.0/dom0/ +- /doc/tools/4.0/domU/ +- /doc/tools/3.2/ +- /doc/tools/3.2/dom0/ +- /doc/tools/3.2/domU/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/reference/tools.html +ref: 141 +title: Command-line tools +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/anti-evil-maid.md b/_doc/user/security-in-qubes/anti-evil-maid.md new file mode 100644 index 00000000..59bde2e1 --- /dev/null +++ b/_doc/user/security-in-qubes/anti-evil-maid.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/anti-evil-maid/ +redirect_from: +- /en/doc/anti-evil-maid/ +- /doc/AntiEvilMaid/ +- /wiki/AntiEvilMaid/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/anti-evil-maid.html +ref: 164 +title: Anti evil maid (AEM) +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/data-leaks.md b/_doc/user/security-in-qubes/data-leaks.md new file mode 100644 index 00000000..cdb3a72a --- /dev/null +++ b/_doc/user/security-in-qubes/data-leaks.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/data-leaks/ +redirect_from: +- /en/doc/data-leaks/ +- /doc/DataLeaks/ +- /wiki/DataLeaks/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/data-leaks.html +ref: 171 +title: Data leaks +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/device-handling-security.md b/_doc/user/security-in-qubes/device-handling-security.md new file mode 100644 index 00000000..c9c806bf --- /dev/null +++ b/_doc/user/security-in-qubes/device-handling-security.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/device-handling-security/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/device-handling-security.html +ref: 170 +title: Device handling security +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/firewall.md b/_doc/user/security-in-qubes/firewall.md new file mode 100644 index 00000000..86508105 --- /dev/null +++ b/_doc/user/security-in-qubes/firewall.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/firewall/ +redirect_from: +- /doc/qubes-firewall/ +- /en/doc/qubes-firewall/ +- /doc/QubesFirewall/ +- /wiki/QubesFirewall/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/firewall.html +ref: 166 +title: Firewall +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/firewall_4.1.md b/_doc/user/security-in-qubes/firewall_4.1.md new file mode 100644 index 00000000..8f32c0d6 --- /dev/null +++ b/_doc/user/security-in-qubes/firewall_4.1.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +permalink: /doc/firewall_4.1/ +redirect_from: null +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/firewall_4.1.html +ref: 401 +title: Firewall 4.1 +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/split-gpg.md b/_doc/user/security-in-qubes/split-gpg.md new file mode 100644 index 00000000..3fcb4809 --- /dev/null +++ b/_doc/user/security-in-qubes/split-gpg.md @@ -0,0 +1,18 @@ +--- +lang: en +layout: doc +permalink: /doc/split-gpg/ +redirect_from: +- /en/doc/split-gpg/ +- /doc/SplitGpg/ +- /doc/UserDoc/SplitGpg/ +- /wiki/UserDoc/SplitGpg/ +- /doc/open-pgp/ +- /en/doc/open-pgp/ +- /doc/OpenPGP/ +- /doc/UserDoc/OpenPGP/ +- /wiki/UserDoc/OpenPGP/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/split-gpg.html +ref: 168 +title: Split GPG +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/u2f-proxy.md b/_doc/user/security-in-qubes/u2f-proxy.md new file mode 100644 index 00000000..19cc656b --- /dev/null +++ b/_doc/user/security-in-qubes/u2f-proxy.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/u2f-proxy/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/u2f-proxy.html +ref: 167 +title: U2F proxy +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/vm-sudo.md b/_doc/user/security-in-qubes/vm-sudo.md new file mode 100644 index 00000000..ea26a247 --- /dev/null +++ b/_doc/user/security-in-qubes/vm-sudo.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/vm-sudo/ +redirect_from: +- /en/doc/vm-sudo/ +- /doc/VMSudo/ +- /wiki/VMSudo/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/vm-sudo.html +ref: 165 +title: Passwordless root access in qubes +--- \ No newline at end of file diff --git a/_doc/user/security-in-qubes/yubi-key.md b/_doc/user/security-in-qubes/yubi-key.md new file mode 100644 index 00000000..74f7e458 --- /dev/null +++ b/_doc/user/security-in-qubes/yubi-key.md @@ -0,0 +1,12 @@ +--- +lang: en +layout: doc +permalink: /doc/yubikey/ +redirect_from: +- /doc/yubi-key/ +- /en/doc/yubi-key/ +- /doc/YubiKey/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/security-in-qubes/yubi-key.html +ref: 169 +title: YubiKey +--- \ No newline at end of file diff --git a/_doc/user/templates/debian/debian-upgrade.md b/_doc/user/templates/debian/debian-upgrade.md new file mode 100644 index 00000000..ee025f39 --- /dev/null +++ b/_doc/user/templates/debian/debian-upgrade.md @@ -0,0 +1,17 @@ +--- +advanced: true +lang: en +layout: doc +permalink: /doc/templates/debian/in-place-upgrade/ +redirect_from: +- /doc/template/debian/upgrade/ +- /doc/templates/debian/upgrade/ +- /doc/template/debian/upgrade-8-to-9/ +- /doc/debian-template-upgrade-8/ +- /en/doc/debian-template-upgrade-8/ +- /doc/DebianTemplateUpgrade8/ +- /wiki/DebianTemplateUpgrade8/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/debian/debian-upgrade.html +ref: 133 +title: How to upgrade a Debian template in-place +--- \ No newline at end of file diff --git a/_doc/user/templates/debian/debian.md b/_doc/user/templates/debian/debian.md new file mode 100644 index 00000000..b8b9df77 --- /dev/null +++ b/_doc/user/templates/debian/debian.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/debian/ +redirect_from: +- /doc/debian/ +- /en/doc/templates/debian/ +- /doc/Templates/Debian/ +- /wiki/Templates/Debian/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/debian/debian.html +ref: 134 +title: Debian templates +--- \ No newline at end of file diff --git a/_doc/user/templates/fedora/fedora-upgrade.md b/_doc/user/templates/fedora/fedora-upgrade.md new file mode 100644 index 00000000..a47429a4 --- /dev/null +++ b/_doc/user/templates/fedora/fedora-upgrade.md @@ -0,0 +1,28 @@ +--- +advanced: true +lang: en +layout: doc +permalink: /doc/templates/fedora/in-place-upgrade/ +redirect_from: +- /doc/template/fedora/upgrade/ +- /doc/templates/fedora/upgrade/ +- /doc/template/fedora/upgrade-26-to-27/ +- /doc/fedora-template-upgrade-26/ +- /en/doc/fedora-template-upgrade-26/ +- /doc/FedoraTemplateUpgrade26/ +- /wiki/FedoraTemplateUpgrade26/ +- /doc/template/fedora/upgrade-27-to-28/ +- /doc/fedora-template-upgrade-27/ +- /en/doc/fedora-template-upgrade-27/ +- /doc/FedoraTemplateUpgrade27/ +- /wiki/FedoraTemplateUpgrade27/ +- /doc/template/fedora/upgrade-28-to-29/ +- /doc/fedora-template-upgrade-28/ +- /en/doc/fedora-template-upgrade-28/ +- /doc/FedoraTemplateUpgrade28/ +- /wiki/FedoraTemplateUpgrade28/ +- /doc/template/fedora/upgrade-29-to-30/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/fedora/fedora-upgrade.html +ref: 137 +title: How to upgrade a Fedora template in-place +--- \ No newline at end of file diff --git a/_doc/user/templates/fedora/fedora.md b/_doc/user/templates/fedora/fedora.md new file mode 100644 index 00000000..cc969361 --- /dev/null +++ b/_doc/user/templates/fedora/fedora.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/fedora/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/fedora/fedora.html +ref: 136 +title: Fedora templates +--- \ No newline at end of file diff --git a/_doc/user/templates/minimal-templates.md b/_doc/user/templates/minimal-templates.md new file mode 100644 index 00000000..78f6bce1 --- /dev/null +++ b/_doc/user/templates/minimal-templates.md @@ -0,0 +1,16 @@ +--- +advanced: true +lang: en +layout: doc +permalink: /doc/templates/minimal/ +redirect_from: +- /doc/templates/fedora-minimal/ +- /doc/fedora-minimal/ +- /en/doc/templates/fedora-minimal/ +- /doc/Templates/FedoraMinimal/ +- /wiki/Templates/FedoraMinimal/ +- /doc/templates/debian-minimal/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/minimal-templates.html +ref: 132 +title: Minimal templates +--- \ No newline at end of file diff --git a/_doc/user/templates/templates.md b/_doc/user/templates/templates.md new file mode 100644 index 00000000..39ac5c1f --- /dev/null +++ b/_doc/user/templates/templates.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/ +redirect_from: +- /doc/template/ +- /en/doc/templates/ +- /doc/Templates/ +- /wiki/Templates/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/templates.html +ref: 131 +title: Templates +--- \ No newline at end of file diff --git a/_doc/user/templates/windows/migrate-to-4-1.md b/_doc/user/templates/windows/migrate-to-4-1.md new file mode 100644 index 00000000..08539322 --- /dev/null +++ b/_doc/user/templates/windows/migrate-to-4-1.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/windows/migrate-to-4-1/ +redirect_from: +- /doc/templates/windows/windows-migrate41/ +- /user/templates/windows/windows-migrate41/ +- /doc/windows-migrate41/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/windows/migrate-to-4-1.html +title: Migrating Windows qubes to Qubes OS 4.1 +--- \ No newline at end of file diff --git a/_doc/user/templates/windows/qubes-windows-tools-4-0.md b/_doc/user/templates/windows/qubes-windows-tools-4-0.md new file mode 100644 index 00000000..62e38dd2 --- /dev/null +++ b/_doc/user/templates/windows/qubes-windows-tools-4-0.md @@ -0,0 +1,20 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/windows/qubes-windows-tools-4-0/ +redirect_from: +- /doc/templates/windows/windows-tools/ +- /user/templates/windows/windows-tools/ +- /doc/windows-tools/ +- /doc/windows-appvms/ +- /en/doc/windows-appvms/ +- /doc/WindowsAppVms/ +- /wiki/WindowsAppVms/ +- /doc/windows-tools-3/ +- /en/doc/windows-tools-3/ +- /doc/WindowsTools3/ +- /doc/WindowsTools/ +- /wiki/WindowsTools/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/windows/qubes-windows-tools-4-0.html +title: Qubes Windows Tools (QWT) in Qubes OS 4.0 +--- \ No newline at end of file diff --git a/_doc/user/templates/windows/qubes-windows-tools-4-1.md b/_doc/user/templates/windows/qubes-windows-tools-4-1.md new file mode 100644 index 00000000..7dd76f2e --- /dev/null +++ b/_doc/user/templates/windows/qubes-windows-tools-4-1.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/windows/qubes-windows-tools-4-1/ +redirect_from: +- /doc/templates/windows/windows-tools41/ +- /user/templates/windows/windows-tools41/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/windows/qubes-windows-tools-4-1.html +title: Qubes Windows Tools (QWT) +--- \ No newline at end of file diff --git a/_doc/user/templates/windows/windows-qubes-4-0.md b/_doc/user/templates/windows/windows-qubes-4-0.md new file mode 100644 index 00000000..56da96c6 --- /dev/null +++ b/_doc/user/templates/windows/windows-qubes-4-0.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/windows/windows-qubes-4-0/ +redirect_from: +- /doc/templates/windows/windows-vm/ +- /user/templates/windows/windows-vm/ +- /doc/windows-vm/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/windows/windows-qubes-4-0.html +title: How to install Windows qubes in Qubes OS 4.0 +--- \ No newline at end of file diff --git a/_doc/user/templates/windows/windows-qubes-4-1.md b/_doc/user/templates/windows/windows-qubes-4-1.md new file mode 100644 index 00000000..abab4e86 --- /dev/null +++ b/_doc/user/templates/windows/windows-qubes-4-1.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/windows/windows-qubes-4-1/ +redirect_from: +- /doc/templates/windows/windows-vm41/ +- /doc/templates/windows/windows-vm41/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/windows/windows-qubes-4-1.html +title: How to install Windows qubes in Qubes OS +--- \ No newline at end of file diff --git a/_doc/user/templates/windows/windows.md b/_doc/user/templates/windows/windows.md new file mode 100644 index 00000000..95b9d2e4 --- /dev/null +++ b/_doc/user/templates/windows/windows.md @@ -0,0 +1,9 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/windows/ +redirect_from: +- /doc/windows/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/windows/windows.html +title: Windows qubes +--- \ No newline at end of file diff --git a/_doc/user/templates/xfce-templates.md b/_doc/user/templates/xfce-templates.md new file mode 100644 index 00000000..42ce6a88 --- /dev/null +++ b/_doc/user/templates/xfce-templates.md @@ -0,0 +1,14 @@ +--- +lang: en +layout: doc +permalink: /doc/templates/xfce/ +redirect_from: +- /doc/xfce/ +- /doc/templates/fedora-xfce/ +- /en/doc/templates/xfce/ +- /doc/Templates/Xfce/ +- /wiki/Templates/Xfce/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/templates/xfce-templates.html +ref: 222 +title: Xfce templates +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/app-menu-shortcut-troubleshooting.md b/_doc/user/troubleshooting/app-menu-shortcut-troubleshooting.md new file mode 100644 index 00000000..e19e03a7 --- /dev/null +++ b/_doc/user/troubleshooting/app-menu-shortcut-troubleshooting.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/app-menu-shortcut-troubleshooting/ +redirect_from: +- /doc/managing-appvm-shortcuts/ +- /en/doc/managing-appvm-shortcuts/ +- /doc/ManagingAppVmShortcuts/ +- /wiki/ManagingAppVmShortcuts/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/app-menu-shortcut-troubleshooting.html +ref: 202 +title: App menu shortcut troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/autostart-troubleshooting.md b/_doc/user/troubleshooting/autostart-troubleshooting.md new file mode 100644 index 00000000..98d10e0a --- /dev/null +++ b/_doc/user/troubleshooting/autostart-troubleshooting.md @@ -0,0 +1,7 @@ +--- +lang: en +layout: doc +permalink: /doc/autostart-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/autostart-troubleshooting.html +title: Autostart troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/debian-and-whonix-update-troubleshooting.md b/_doc/user/troubleshooting/debian-and-whonix-update-troubleshooting.md new file mode 100644 index 00000000..bb6d8566 --- /dev/null +++ b/_doc/user/troubleshooting/debian-and-whonix-update-troubleshooting.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/debian-and-whonix-update-troubleshooting/ +redirect_from: +- /doc/troubleshooting/updating-debian-and-whonix/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/debian-and-whonix-update-troubleshooting.html +ref: 98 +title: Updating Debian and Whonix +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/disk-troubleshooting.md b/_doc/user/troubleshooting/disk-troubleshooting.md new file mode 100644 index 00000000..039cb356 --- /dev/null +++ b/_doc/user/troubleshooting/disk-troubleshooting.md @@ -0,0 +1,13 @@ +--- +lang: en +layout: doc +permalink: /doc/disk-troubleshooting/ +redirect_from: +- /en/doc/out-of-memory/ +- /doc/OutOfmemory/ +- /wiki/OutOfmemory/ +- /doc/out-of-memory/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/disk-troubleshooting.html +ref: 231 +title: Disk troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/gui-troubleshooting.md b/_doc/user/troubleshooting/gui-troubleshooting.md new file mode 100644 index 00000000..1c3f4ced --- /dev/null +++ b/_doc/user/troubleshooting/gui-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/gui-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/gui-troubleshooting.html +ref: 233 +title: GUI troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/hardware-troubleshooting.md b/_doc/user/troubleshooting/hardware-troubleshooting.md new file mode 100644 index 00000000..68b43354 --- /dev/null +++ b/_doc/user/troubleshooting/hardware-troubleshooting.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/hardware-troubleshooting/ +redirect_from: +- /doc/newer-hardware-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/hardware-troubleshooting.html +ref: 97 +title: Hardware troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/hvm-troubleshooting.md b/_doc/user/troubleshooting/hvm-troubleshooting.md new file mode 100644 index 00000000..9578319b --- /dev/null +++ b/_doc/user/troubleshooting/hvm-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/hvm-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/hvm-troubleshooting.html +ref: 232 +title: HVM troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/installation-troubleshooting.md b/_doc/user/troubleshooting/installation-troubleshooting.md new file mode 100644 index 00000000..e7c24e53 --- /dev/null +++ b/_doc/user/troubleshooting/installation-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/installation-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/installation-troubleshooting.html +ref: 224 +title: Installation troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/media-troubleshooting.md b/_doc/user/troubleshooting/media-troubleshooting.md new file mode 100644 index 00000000..94f2fb7f --- /dev/null +++ b/_doc/user/troubleshooting/media-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/media-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/media-troubleshooting.html +ref: 235 +title: Media troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/pci-troubleshooting.md b/_doc/user/troubleshooting/pci-troubleshooting.md new file mode 100644 index 00000000..8e50c2c6 --- /dev/null +++ b/_doc/user/troubleshooting/pci-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/pci-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/pci-troubleshooting.html +ref: 230 +title: PCI troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/resume-suspend-troubleshooting.md b/_doc/user/troubleshooting/resume-suspend-troubleshooting.md new file mode 100644 index 00000000..abc09014 --- /dev/null +++ b/_doc/user/troubleshooting/resume-suspend-troubleshooting.md @@ -0,0 +1,11 @@ +--- +lang: en +layout: doc +permalink: /doc/suspend-resume-troubleshooting/ +redirect_from: +- /en/doc/wireless-troubleshooting/ +- /doc/wireless-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/resume-suspend-troubleshooting.html +ref: 94 +title: Suspend/resume troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/uefi-troubleshooting.md b/_doc/user/troubleshooting/uefi-troubleshooting.md new file mode 100644 index 00000000..6cac67cd --- /dev/null +++ b/_doc/user/troubleshooting/uefi-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/uefi-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/uefi-troubleshooting.html +ref: 177 +title: UEFI troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/update-troubleshooting.md b/_doc/user/troubleshooting/update-troubleshooting.md new file mode 100644 index 00000000..7b9e02f7 --- /dev/null +++ b/_doc/user/troubleshooting/update-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/update-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/update-troubleshooting.html +ref: 239 +title: Update troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/usb-troubleshooting.md b/_doc/user/troubleshooting/usb-troubleshooting.md new file mode 100644 index 00000000..f3b17543 --- /dev/null +++ b/_doc/user/troubleshooting/usb-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/usb-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/usb-troubleshooting.html +ref: 234 +title: USB troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/vm-troubleshooting.md b/_doc/user/troubleshooting/vm-troubleshooting.md new file mode 100644 index 00000000..821a01d6 --- /dev/null +++ b/_doc/user/troubleshooting/vm-troubleshooting.md @@ -0,0 +1,10 @@ +--- +lang: en +layout: doc +permalink: /doc/vm-troubleshooting/ +redirect_from: +- /doc/remove-vm-manually/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/vm-troubleshooting.html +ref: 223 +title: Qube troubleshooting +--- \ No newline at end of file diff --git a/_doc/user/troubleshooting/vpn-troubleshooting.md b/_doc/user/troubleshooting/vpn-troubleshooting.md new file mode 100644 index 00000000..84b66682 --- /dev/null +++ b/_doc/user/troubleshooting/vpn-troubleshooting.md @@ -0,0 +1,8 @@ +--- +lang: en +layout: doc +permalink: /doc/vpn-troubleshooting/ +redirect_to: https://qubes-doc-rst.readthedocs.io/en/latest/user/troubleshooting/vpn-troubleshooting.html +ref: 240 +title: VPN troubleshooting +--- \ No newline at end of file diff --git a/_includes/variables.html b/_includes/variables.html index 025388aa..83911ec1 100644 --- a/_includes/variables.html +++ b/_includes/variables.html @@ -69,7 +69,7 @@ {% endif %} {% endif %} - {% assign doc_link = lang | append: "/doc/" %} + {% assign doc_link = "https://qubes-doc-rst.readthedocs.io/" | append: page.lang | append: "/latest/index.html" %} {% assign team_link = lang | append: "/team/" %} diff --git a/_posts b/_posts index 019cc059..585397b9 160000 --- a/_posts +++ b/_posts @@ -1 +1 @@ -Subproject commit 019cc0594e38263f1b0d65c454a8830bf8d2cc19 +Subproject commit 585397b9351e9a4ad30ef95b81735becf5c292ed diff --git a/_utils/gitlabci.sh b/_utils/gitlabci.sh index a60e7cc2..0654ebac 100755 --- a/_utils/gitlabci.sh +++ b/_utils/gitlabci.sh @@ -48,6 +48,9 @@ git submodule update --init --recursive echo -e "section_end:$(date +%s):prepare\r\e[0K" +#temp fixup +git remote set-url origin $(git remote get-url origin | sed -e s/gitlab/github/) + if is_pr; then echo -e "section_start:$(date +%s):build_orig\r\e[0KBuilding original site to compare" # exact value doesn't matter as long as it is in the future, but needs to diff --git a/pages/canary.md b/pages/canary.md index f7ea2e98..11bf6337 100644 --- a/pages/canary.md +++ b/pages/canary.md @@ -10,7 +10,7 @@ title: Qubes canaries --- A **Qubes canary** is a security announcement periodically issued by the [Qubes -security team](/security/#qubes-security-team) through the [Qubes security +security team](https://qubes-doc-rst.readthedocs.io/en/latest/project-security/security.html#qubes-security-team) through the [Qubes security pack](/security/pack/) consisting of several statements to the effect that the signers of the canary have not been compromised. The idea is that, as long as signed canaries including such statements continue to be published, all is diff --git a/pages/donate.md b/pages/donate.md index 076a3ded..caccf633 100644 --- a/pages/donate.md +++ b/pages/donate.md @@ -148,7 +148,7 @@ However, if you or your organization has relevant knowledge, experience, leads, ### How do I verify your Bitcoin address? The donation address can be verified via the [Qubes Security Pack](/security/pack/), specifically in the [fund directory](https://github.com/QubesOS/qubes-secpack/tree/master/fund). -We provide [detailed instructions for verifying the digital signatures](/security/pack/#how-to-obtain-and-authenticate). +We provide [detailed instructions for verifying the digital signatures](https://qubes-doc-rst.readthedocs.io/en/latest/project-security/security-pack.html#how-to-obtain-and-authenticate). The Qubes Project maintains a [decentralized Bitcoin fund using a multi-signature wallet](/news/2016/07/13/qubes-distributed-fund/). This means that no single person is capable of spending these funds. @@ -156,12 +156,12 @@ This means that no single person is capable of spending these funds. ### How do I verify your Ethereum address? The donation address can be verified via the [Qubes Security Pack](/security/pack/), specifically in the [fund directory](https://github.com/QubesOS/qubes-secpack/tree/master/fund). -We provide [detailed instructions for verifying the digital signatures](/security/pack/#how-to-obtain-and-authenticate). +We provide [detailed instructions for verifying the digital signatures](https://qubes-doc-rst.readthedocs.io/en/latest/project-security/security-pack.html#how-to-obtain-and-authenticate). ### How do I verify your Monero address? The donation address can be verified via the [Qubes Security Pack](/security/pack/), specifically in the [fund directory](https://github.com/QubesOS/qubes-secpack/tree/master/fund). -We provide [detailed instructions for verifying the digital signatures](/security/pack/#how-to-obtain-and-authenticate). +We provide [detailed instructions for verifying the digital signatures](https://qubes-doc-rst.readthedocs.io/en/latest/project-security/security-pack.html#how-to-obtain-and-authenticate). ### Is Qubes merchandise available? diff --git a/pages/home.html b/pages/home.html index bb3f8f91..3a79d750 100644 --- a/pages/home.html +++ b/pages/home.html @@ -235,7 +235,7 @@

Join the Commu
-

Have questions or need a hand? As a free and open-source project, our valued community of users and contributors from around the world are in the best position to help. Before diving in, we encourage you to read about staying safe, our discussion guidelines, and our code of conduct to help keep things positive and on-track. We welcome newcomers and returning users wanting to discuss Qubes and seeking to contribute. +

Have questions or need a hand? As a free and open-source project, our valued community of users and contributors from around the world are in the best position to help. Before diving in, we encourage you to read about staying safe, our discussion guidelines, and our code of conduct to help keep things positive and on-track. We welcome newcomers and returning users wanting to discuss Qubes and seeking to contribute.

diff --git a/pages/partners.html b/pages/partners.html index 8fb4c3af..b345e74d 100644 --- a/pages/partners.html +++ b/pages/partners.html @@ -309,7 +309,7 @@

Center for the Cultivation of Technology

Discourse

-

Discourse is an open source Internet forum and mailing list management software application. Through their free hosting for FOSS projects program they provided us with initial free hosting for the Qubes Forum.

+

Discourse is an open source Internet forum and mailing list management software application. Through their free hosting for FOSS projects program they provided us with initial free hosting for the Qubes Forum.

diff --git a/pages/qsb.md b/pages/qsb.md index 5576b986..facb6a2a 100644 --- a/pages/qsb.md +++ b/pages/qsb.md @@ -14,7 +14,7 @@ title: Qubes security bulletins (QSBs) --- A **Qubes security bulletin (QSB)** is a security announcement issued by the -[Qubes security team](/security/#qubes-security-team) through the [Qubes +[Qubes security team](https://qubes-doc-rst.readthedocs.io/en/latest/project-security/security.html#qubes-security-team) through the [Qubes security pack](/security/pack/). A QSB typically provides a summary and impact analysis of one or more recently-discovered software vulnerabilities, including details about patching to address them. For Xen security advisories (XSAs), see