-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Docs refresh: README, CONTRIBUTING, and misc updates #59289
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
Conversation
sagetherage
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
few changes to the branching here, see my comments
|
Putting a general comment to review the Deprecation docs and Release docs. |
sagetherage
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am good to merge this in and then re-word the deprecation portion in a separate PR.
|
Failures are unrelated |
2e96d4a
|
Before this is merged, I'd like to just get confirmation that this makes sense:
This makes I also have updated the Twitter social media button link. |
|
To me, it makes sense. |
|
I've also closed #59383 which is duplicating one of the included fixes in this PR |
This ended up introducing some unexpected, downstream issues that will be resolved with the following: |
What does this PR do?
README preview: https://github.com/ScriptAutomate/salt/blob/refresh-docs/README.rst
A handful of things:
python.org/2/*URI links indoc/*.rstfiles (many links still need to be updated in*.pyfiles in the Salt repo)doc/topics/development/contributing.rstto newCONTRIBUTING.rstfile at root, and import it at build with Sphinx.CONTRIBUTING.rstnow new, primary contributing guide.CONTRIBUTING.mdand.github/CONTRIBUTING.mdREADME.rstREADME.rstcontents indoc/contents.rstdoc/_themes/saltstack2/layout.htmlso TOC link still works as expecteddoc/.scripts/setup-transifex-config: No longer usedAluminumtoAluminiumdevelopbranch that need to be referencingmasterbranch for development. Also mentioning tag releases instead of branch releases.What issues does this PR fix or reference?
.. raw::directive)latestrelease badge and updates Twitter badgemasterbranch)developbranch into themasterbranch. This PR is not resolving that, and I don't think the official docs should have this information, but should exist as an ongoing effort detailed elsewhere due to the dynamic nature of PR jams (and how thedevelopbranch will eventually be deleted after all appropriate migrations tomasteroccur).Merge requirements satisfied?
[NOTICE] Bug fixes or features added to Salt require tests.
Commits signed with GPG?
Yes