Skip to content
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

Docs refresh: README, CONTRIBUTING, and misc updates #59289

Merged
merged 12 commits into from Feb 3, 2021
Merged

Docs refresh: README, CONTRIBUTING, and misc updates #59289

merged 12 commits into from Feb 3, 2021

Conversation

ScriptAutomate
Copy link
Contributor

@ScriptAutomate ScriptAutomate commented Jan 13, 2021

What does this PR do?

README preview: https://github.com/ScriptAutomate/salt/blob/refresh-docs/README.rst

A handful of things:

  • Update all python.org/2/* URI links in doc/*.rst files (many links still need to be updated in *.py files in the Salt repo)
  • Move contents of doc/topics/development/contributing.rst to new CONTRIBUTING.rst file at root, and import it at build with Sphinx. CONTRIBUTING.rst now new, primary contributing guide.
  • Delete redundant contributor guide files: CONTRIBUTING.md and .github/CONTRIBUTING.md
  • Refresh README.rst
  • Include README.rst contents in doc/contents.rst
    • Updated doc/_themes/saltstack2/layout.html so TOC link still works as expected
  • Delete doc/.scripts/setup-transifex-config: No longer used
  • Correct Aluminum to Aluminium
  • Replace some straggling documentation about develop branch that need to be referencing master branch for development. Also mentioning tag releases instead of branch releases.

What issues does this PR fix or reference?

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

  • Docs

Commits signed with GPG?

Yes

Copy link
Contributor

@sagetherage sagetherage left a 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

doc/topics/development/deprecations.rst Outdated Show resolved Hide resolved
doc/topics/development/deprecations.rst Outdated Show resolved Hide resolved
doc/topics/development/git/index.rst Show resolved Hide resolved
@sagetherage
Copy link
Contributor

Putting a general comment to review the Deprecation docs and Release docs.

sagetherage
sagetherage previously approved these changes Jan 14, 2021
Copy link
Contributor

@sagetherage sagetherage left a 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.

@s0undt3ch
Copy link
Member

Failures are unrelated

s0undt3ch
s0undt3ch previously approved these changes Jan 15, 2021
@ScriptAutomate
Copy link
Contributor Author

ScriptAutomate commented Jan 28, 2021

Before this is merged, I'd like to just get confirmation that this makes sense:

  • Include README.rst contents in doc/contents.rst
    • Updated doc/_themes/saltstack2/layout.html so TOC link still works as expected

This makes contents.rst not only be a TOC, but have the README.rst contents injected directly above the TOC, since the contents page is pretty much the landing page for the salt repo docs. The TOC / Table of Contents buttons and links will still go directly to the section of the TOC for people wanting to look at a main TOC.

I also have updated the Twitter social media button link.

@s0undt3ch
Copy link
Member

To me, it makes sense.

@ScriptAutomate
Copy link
Contributor Author

ScriptAutomate commented Feb 2, 2021

I've also closed #59383 which is duplicating one of the included fixes in this PR

@Ch3LL Ch3LL added the Aluminium Release Post Mg and Pre Si label Feb 3, 2021
@Ch3LL Ch3LL merged commit a0c23d7 into saltstack:master Feb 3, 2021
@ScriptAutomate
Copy link
Contributor Author

Before this is merged, I'd like to just get confirmation that this makes sense:

* Include `README.rst` contents in `doc/contents.rst`
  
  * Updated `doc/_themes/saltstack2/layout.html` so TOC link still works as expected

This makes contents.rst not only be a TOC, but have the README.rst contents injected directly above the TOC, since the contents page is pretty much the landing page for the salt repo docs. The TOC / Table of Contents buttons and links will still go directly to the section of the TOC for people wanting to look at a main TOC.

I also have updated the Twitter social media button link.

This ended up introducing some unexpected, downstream issues that will be resolved with the following:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Aluminium Release Post Mg and Pre Si
Projects
None yet
5 participants