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

Update contributing and documentation pages to recommend submitting against branches

Browse source 
Fixes #28272
This commit is contained in:
rallytime 2015-11-03 10:44:29 -07:00
parent 63ce8f78d5
commit 1c612e2772
2 changed files with 24 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,3 +1,5 @@
.. _contributing:
============
Contributing
============
@ -163,14 +165,15 @@ Which Salt branch?
==================
GitHub will open pull requests against Salt's main branch, ``develop``, by
default. Ideally features should go into ``develop`` and bug fixes should go
into the oldest supported release branch affected by the bug. See
default. Ideally, features should go into ``develop`` and bug fixes and
documentation changes should go into the oldest supported release branch
affected by the bug or documentation update. See
:ref:`Sending a GitHub pull request <github-pull-request>`.
If you have a bug fix and have already forked your working branch from
``develop`` and do not know how to rebase your commits against another branch,
then submit it to ``develop`` anyway and we'll be sure to backport it to the
correct place.
If you have a bug fix or doc change and have already forked your working
branch from ``develop`` and do not know how to rebase your commits against
another branch, then submit it to ``develop`` anyway and we'll be sure to
back-port it to the correct place.
The current release branch
--------------------------

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

@ -298,6 +298,21 @@ cross-referenced using two custom roles, ``conf_master``, and ``conf_minion``.
single minion.
.. _docs-ref-fixes:
Documentation Changes and Fixes
===============================
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.
.. _docs-building:
Building the documentation