saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add link to Sending a GH PR to documentation docs

Browse source
This commit is contained in:
rallytime 2015-11-03 14:07:49 -07:00
parent 1c612e2772
commit a959681858
2 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/topics/development/contributing.rst
View file

@ -44,8 +44,9 @@ Fork a Repo Guide_>`_ and is well worth reading.
feature Y". Multiple unrelated fixes and/or features should be
isolated into separate branches.
If you're working on a fix, create your branch from the oldest release
branch having the bug. See :ref:`Which Salt Branch? <which-salt-branch>`.
If you're working on a bug or documentation fix, create your branch from
the oldest release branch that contains the bug or requires the documentation
update. See :ref:`Which Salt Branch? <which-salt-branch>`.
.. code-block:: bash

13
doc/topics/development/conventions/documentation.rst
View file

@ -307,10 +307,15 @@ Documentation changes and fixes should be made against the earliest supported
release branch that the update applies to. The practice of updating a release
branch instead of making all documentation changes against Salt's main, default
branch, ``develop``, is necessary in order for the docs to be as up-to-date as
possible when the docs are built. This workflow is also inline with the
recommendations outlined in Salt's :ref:`contributing` page. You can read more
about how to choose where to submit documentation fixes by reading the
:ref:`which-salt-branch` section.
possible when the docs are built.
The workflow mentioned above is also inline with the recommendations outlined
in Salt's :ref:`contributing` page. You can read more about how to choose where
to submit documentation fixes by reading the :ref:`which-salt-branch` section.
For an explanation of how to submit changes against various branches, see the
:ref:`github-pull-request` section. Specifically, see the section describing
how to``Create a new branch`` and the steps that follow.
.. _docs-building: