Skip to content

Docs: Improve scoping of two potentially overlapping Triage sections #9302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.rstcheck.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[rstcheck]
ignore_directives=automodule,http:get,tabs,tab,prompt,http:patch,http:post,http:put,http:delete
ignore_roles=djangosetting,setting,featureflags,buildpyversions
ignore_roles=djangosetting,setting,featureflags,buildpyversions,external+rtd:doc,external,external+rtd
ignore_substitutions=org_brand,com_brand,:smile:,:arrows_counterclockwise:,:heavy_plus_sign:,:tada:,:heart:,:pencil2:
# This error needs to be ignored for now
# See: https://github.com/myint/rstcheck/issues/19
Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@
"rtd": ("https://docs.readthedocs.io/en/stable/", None),
"rtd-dev": ("https://dev.readthedocs.io/en/latest/", None),
}
# Redundant in Sphinx 5.0
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
intersphinx_disabled_reftypes = ["std:doc"]
myst_enable_extensions = [
"deflist",
]
Expand Down
19 changes: 13 additions & 6 deletions docs/dev/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,22 @@ projects, feel free to suggest the language on Transifex to start the process.

.. _our projects on Transifex: https://www.transifex.com/projects/p/readthedocs/

Triaging tickets
----------------
Triaging issues
---------------

Core team uses the following guidelines for issue triage on all of our projects.
These guidelines describe the issue lifecycle, and what is required at each step
of this lifecycle.
Everyone is encouraged to help improving, refining, verifying and prioritizing
issues on Github. The Read the Docs core :external+rtd:doc:`team` uses the following
guidelines for issue triage on all of our projects. These guidelines describe
the issue lifecycle step-by-step.

.. note:: You will need Triage permission on the project in order to do this.
You can ask one of the members of the :doc:`team` to give you access.
You can ask one of the members of the :external+rtd:doc:`team` to give you access.

.. tip:: Triaging helps identify problems and solutions and ultimately what
issues that are ready to be worked on. The core
:external+rtd:doc:`team` maintains a separate :doc:`/roadmap`
of prioritized issues - issues will only end up on that Roadmap after
they have been triaged.

Initial triage
~~~~~~~~~~~~~~
Expand Down
12 changes: 7 additions & 5 deletions docs/dev/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,21 @@ Here, you will find several views into our roadmap:

`Backlog <https://github.com/orgs/readthedocs/projects/156/views/4>`_
Work that we have planned for future sprints. Items with an assigned
timeframe have generally been discussed already by the team. Iteams that do
timeframe have generally been discussed already by the team. Items that do
not yet have a timeframe assigned are not yet a priority of the core team.

The focus of the core team will be on roadmap and sprint items. These items are
promoted from our backlog before each sprint begins.

.. _GitHub Roadmap: https://github.com/orgs/readthedocs/projects/156/views/1

Triaging issues
~~~~~~~~~~~~~~~
Triaging issues for the Roadmap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Much of this is already covered in our guide on :doc:`contribute`, however to
summarize the important pieces:
Issues are triaged before they are worked on, involving a number of steps that
are covered in :doc:`/contribute`. Everyone can take part in helping to
triage issues, read more in :ref:`contribute:Triaging issues`. Additionally, issues are
considered for the Roadmap according to the following process:

* New issues coming in will be triaged, but won't yet be considered part of our
roadmap.
Expand Down
2 changes: 1 addition & 1 deletion docs/user/localization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ It also gets included in the Read the Docs flyout:
.. note::
The default language of a custom domain is determined by the language of the
parent project that the domain was configured on. See
:doc:`custom_domains` for more information.
:doc:`/custom-domains` for more information.

.. note:: You can include multiple translations in the same repository,
with same ``conf.py`` and ``.rst`` files,
Expand Down
2 changes: 1 addition & 1 deletion docs/user/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The issue was found by the Read the Docs team.
Version 5.14.0
~~~~~~~~~~~~~~

:ref:`changelog:Version 5.14.0` fixes an issue where that affected new code that removed multiple slashes in URL paths. The issue allowed the creation of hyperlinks that looked like they would go to a documentation domain on Read the Docs (either `*.readthedocs.io` or a [custom docs domain](https://docs.readthedocs.io/en/stable/custom_domains.html)) but instead went to a different domain.
:ref:`changelog:Version 5.14.0` fixes an issue where that affected new code that removed multiple slashes in URL paths. The issue allowed the creation of hyperlinks that looked like they would go to a documentation domain on Read the Docs (either `*.readthedocs.io` or a :doc:`custom docs domain </custom-domains>`)) but instead went to a different domain.

This issue was reported by Splunk after it was reported by a security audit.

Expand Down
2 changes: 1 addition & 1 deletion docs/user/single_version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ rather than redirecting to ``https://pip.readthedocs.io/en/latest/``.
.. warning::

Documentation at ``/<language>/<default_version>/`` will stop working.
Remember to set :ref:`custom_domains:Canonical URLs`
Remember to set :doc:`canonical URLs </canonical-urls>`
to tell search engines like Google what to index,
and to create :doc:`user-defined-redirects` to avoid broken incoming links.