mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-11-27 07:07:09 -05:00
manual fixes
Manual fixes after the conversion tool.
This commit is contained in:
parent
4a3b08fd7d
commit
bbd0337e91
26 changed files with 388 additions and 1613 deletions
|
|
@ -208,7 +208,7 @@ 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:
|
||||
|
||||
.. code:: bash
|
||||
.. code::
|
||||
|
||||
<div class="alert alert-success" role="alert">
|
||||
<i class="fa fa-check-circle"></i>
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ and therefore one of the most important things to do well.
|
|||
|
||||
Below is the application template:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: markdown
|
||||
|
||||
# Introduction
|
||||
|
||||
|
|
@ -136,7 +136,7 @@ incomplete. If you are interested in submitting a proposal based on
|
|||
these ideas, you should contact the :ref:`qubes-devel mailing list <introduction/support:qubes-devel>` and associated GitHub issue to learn
|
||||
more about the idea.
|
||||
|
||||
.. code:: bash
|
||||
.. code:: markdown
|
||||
|
||||
### Adding a Proposal
|
||||
|
||||
|
|
|
|||
|
|
@ -224,7 +224,7 @@ satisfy the following criteria:
|
|||
|
||||
- The videos are suitable for embedding in appropriate places in the
|
||||
Qubes documentation. (E.g., a video on how to update Qubes OS should
|
||||
be appropriate for appearing on the :doc:`:doc:`how to update </user/how-to-guides/how-to-update>`` page.)
|
||||
be appropriate for appearing on the :doc:`how to update </user/how-to-guides/how-to-update>` page.)
|
||||
|
||||
- Where possible, the videos should strive to be version-independent.
|
||||
(For example, a video explaining the template system should still be
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ How to edit the documentation
|
|||
=============================
|
||||
|
||||
|
||||
*Also see the* :doc:`documentation style guide </developer/general/documentation-style-guide>` *.*
|
||||
*Also see the* :doc:`documentation style guide </developer/general/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
|
||||
|
|
@ -186,7 +186,7 @@ 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 ``<LATEST_COMMIT>``” (or similar).
|
||||
comment stating, “Passed review as of ``<LATEST_COMMIT>`` ” (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,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue