Skip to content

Commit bb06e86

Browse files
committed
merge pr #1540, fixed merge conflicts
2 parents 7552425 + 8a744b0 commit bb06e86

38 files changed

+137
-131
lines changed

developer/general/developing-gui-applications.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ If error should be thrown, you need to provide the error code and name, for exam
6363
b'2\x00QubesNoSuchPropertyError\x00\x00No such property\x00'
6464
6565
66-
For details of particular calls, you can use `Extending the mock Qubes object <#extending-the-mock-qubes-object>`__.
66+
For details of particular calls, you can use :ref:`developer/general/developing-gui-applications:extending the mock qubes object`.
6767

6868
Available mocks
6969
---------------

developer/general/how-to-edit-the-website.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ hosted on `GitHub <https://github.com/>`__.
2424

2525
A few notes to consider:
2626

27-
- Since Qubes is a security-oriented project, every change will be `reviewed <#security>`__ before it’s accepted. This allows us to maintain quality control and protect our users.
27+
- Since Qubes is a security-oriented project, every change will be :ref:`reviewed <developer/general/how-to-edit-the-website:security>` before it’s accepted. This allows us to maintain quality control and protect our users.
2828
- To give your contribution a better chance of being accepted, please follow our :doc:`website style guide </developer/general/website-style-guide>`.
2929
- 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 :doc:`file an issue </introduction/issue-tracking>` for it first so that we can make sure we’re on the same page before significant works begins.
3030
- Finally, if you’ve written something that doesn’t belong in `qubesos.github.io <https://github.com/QubesOS/qubesos.github.io>`__ but would be beneficial to the Qubes community, please consider adding it to the :doc:`documentation </developer/general/how-to-edit-the-rst-documentation>` or the :ref:`external documentation <developer/general/rst-documentation-style-guide:core vs. external documentation>`.
@@ -212,7 +212,7 @@ Once a pull request passes review, the reviewer should add a signed comment stat
212212
Questions, problems, and improvements
213213
-------------------------------------
214214

215-
If you have a question about something you read in the website or about how to edit the it, please post it on the `forum <https://forum.qubes-os.org/>`__ or send it to the appropriate :doc:`mailing list </introduction/support>`. If you see that something in the website should be fixed or improved, please `contribute <#how-to-submit-a-pull-request>`__ the change yourself. To report an issue with the wesbite, please follow our standard :doc:`issue reporting guidelines </introduction/issue-tracking>`. (If you report an issue with the website, 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.)
215+
If you have a question about something you read in the website or about how to edit the it, please post it on the `forum <https://forum.qubes-os.org/>`__ or send it to the appropriate :doc:`mailing list </introduction/support>`. If you see that something in the website should be fixed or improved, please :ref:`contribute <developer/general/how-to-edit-the-website:how to submit a pull request>` the change yourself. To report an issue with the wesbite, please follow our standard :doc:`issue reporting guidelines </introduction/issue-tracking>`. (If you report an issue with the website, 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.)
216216

217217
.. |news-section| image:: /attachment/doc/website_news_section.png
218218
:alt: Depicts the News section of the Qubes OS website

developer/general/package-contributions.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ Contribution Procedure
3535

3636
Before you start putting serious work into a package, we recommend that you discuss your idea with the Qubes developers and the broader community on the :ref:`qubes-devel mailing list <introduction/support:qubes-devel>`. Once you have a package that’s ready to become part of Qubes OS, please follow this procedure:
3737

38-
1. Ensure that your package satisfies the `Inclusion Criteria <#inclusion-criteria>`__.
38+
1. Ensure that your package satisfies the :ref:`developer/general/package-contributions:inclusion criteria`.
3939

4040
2. If your code isn’t already on GitHub, create a GitHub repo that contains your code. You can have a look to an example package called `qubes-skeleton <https://github.com/QubesOS-contrib/qubes-skeleton>`__.
4141

4242
3. If you haven’t already, :doc:`sign your code </developer/code/code-signing>`.
4343

4444
4. Create an issue in `qubes-issues <https://github.com/QubesOS/qubes-issues/issues/>`__ with the title ``[Contribution] your-package-name``. Include a link to your repo, a brief description of your package, and a brief explanation of why you think it should be included in Qubes. Please note that the Qubes core developers are very busy. If they are under heavy load when you submit your contribution, it may be a very long time before they have time to review your package. If this happens, please do not be discouraged. If you think they may have forgotten about your pending contribution, you may “bump” your request by commenting on your issue, but please do this *very* sparingly (i.e., no more than once a month). We appreciate your understanding!
4545

46-
5. You may be asked followup questions. If we decide to accept your contribution, you will be invited to join the `QubesOS-contrib <https://github.com/QubesOS-contrib>`__ organization on GitHub as public recognition of your contribution (but without push access; see `Review Procedure <#review-procedure>`__), and `QubesOS-contrib <https://github.com/QubesOS-contrib>`__ will fork your repo. If we decide not to accept your contribution, we will state the reason and close the issue.
46+
5. You may be asked followup questions. If we decide to accept your contribution, you will be invited to join the `QubesOS-contrib <https://github.com/QubesOS-contrib>`__ organization on GitHub as public recognition of your contribution (but without push access; see :ref:`developer/general/package-contributions:review procedure`), and `QubesOS-contrib <https://github.com/QubesOS-contrib>`__ will fork your repo. If we decide not to accept your contribution, we will state the reason and close the issue.
4747

4848

4949

@@ -59,7 +59,7 @@ Review Procedure
5959
----------------
6060

6161

62-
This review procedure covers both original package contributions (see `Contribution Procedure <#contribution-procedure>`__) and all subsequent updates to those packages, including updates from the original package contributor (see `Update Procedure <#update-procedure>`__). All changes will be reviewed by a Qubes Core Reviewer (QCR) and the `Package Maintainer <#package-maintainers>`__ (PM). In all cases, the QCR will be a core Qubes developer. In some cases, the QCR and the PM will be the same person. For example, if someone contributes a package, then disappears, and no suitable replacement has been found, then it is likely that a core Qubes developer will play both the QCR and PM roles for that package, at least until another suitable candidate volunteers to become the PM for that package.
62+
This review procedure covers both original package contributions (see :ref:`developer/general/package-contributions:contribution procedure`) and all subsequent updates to those packages, including updates from the original package contributor (see :ref:`developer/general/package-contributions:update procedure`). All changes will be reviewed by a Qubes Core Reviewer (QCR) and the :ref:`Package Maintainer <developer/general/package-contributions:package maintainers>` (PM). In all cases, the QCR will be a core Qubes developer. In some cases, the QCR and the PM will be the same person. For example, if someone contributes a package, then disappears, and no suitable replacement has been found, then it is likely that a core Qubes developer will play both the QCR and PM roles for that package, at least until another suitable candidate volunteers to become the PM for that package.
6363

6464
The review procedure is as follows:
6565

@@ -97,7 +97,7 @@ Package Maintainers
9797

9898
If you contribute a package, we assume that you will be the maintainer of that package, unless you tell us otherwise. As the maintainer of the package, it is your privilege and responsibility to:
9999

100-
- `Review <#review-procedure>`__ each pull request made against the package.
100+
- :ref:`Review <developer/general/package-contributions:review procedure>` each pull request made against the package.
101101

102102
- Decide when the package has reached a new version, and notify the Qubes core developers when this occurs.
103103

developer/general/website-style-guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ HTML and CSS
109109
^^^^^^^^^^^^
110110

111111

112-
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.
112+
Do not write HTML inside Markdown documents (except in rare, unavoidable cases, such as :ref:`developer/general/website-style-guide:alerts`). In particular, never include HTML or CSS for styling, formatting, or white space control. That belongs in the (S)CSS files instead.
113113

114114
Headings
115115
^^^^^^^^
@@ -161,7 +161,7 @@ There are two problems with this:
161161

162162

163163

164-
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.,:
164+
Instead, an example of an appropriate way to stylistically distinguish a portion of text is by using :ref:`developer/general/website-style-guide: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.,:
165165

166166
.. code:: markdown
167167

developer/services/qrexec.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ When calling a service that takes an argument, just add the argument to the serv
212212
213213
The script will receive ``ARGUMENT`` as its argument. The argument will also become available as the ``QREXEC_SERVICE_ARGUMENT`` environment variable. This means it is possible to install a different script for a particular service argument.
214214

215-
See `below <#rpc-service-with-argument-file-reader>`__ for an example of an RPC service using an argument.
215+
See :ref:`developer/services/qrexec:rpc service with argument (file reader)` for an example of an RPC service using an argument.
216216

217217
Qubes RPC examples
218218
------------------
@@ -278,7 +278,7 @@ RPC service with argument (file reader)
278278
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
279279

280280

281-
Here we create an RPC call that reads a specific file from a predefined directory on the target. This example uses an `argument <#service-policies-with-arguments>`__ to the policy. In this example a simplified workflow will be used. The service code is placed directly in the service definition file on the target VM. No separate client script will be needed.
281+
Here we create an RPC call that reads a specific file from a predefined directory on the target. This example uses an :ref:`argument <developer/services/qrexec:service policies with arguments>` to the policy. In this example a simplified workflow will be used. The service code is placed directly in the service definition file on the target VM. No separate client script will be needed.
282282

283283
First, on your target VM, create two files in the home directory: ``testfile1`` and ``testfile2``. Have them contain two different “Hello world!” lines.
284284

developer/services/qrexec2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ By default, stderr of client and server is logged to respective ``/var/log/qubes
102102

103103
Be very careful when coding and adding a new RPC service! Any vulnerability in a RPC server can be fatal to security of the target VM!
104104

105-
If requesting VM-VM (and VM-Dom0) services execution *without cmdline helper*, connect directly to ``/var/run/qubes/qrexec-agent-fdpass`` socket as described `below <#all-the-pieces-together-at-work>`__.
105+
If requesting VM-VM (and VM-Dom0) services execution *without cmdline helper*, connect directly to ``/var/run/qubes/qrexec-agent-fdpass`` socket as described :ref:`below <developer/services/qrexec2:all the pieces together at work>`.
106106

107107
Revoking "Yes to All" authorization
108108
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)