The Wayback Machine - https://web.archive.org/web/20201111215402/https://github.com/saltstack/salt/issues/58516
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

[BUG] Installing Salt for development docs out of date #58516

Open
SammyTbeile opened this issue Sep 21, 2020 · 3 comments
Open

[BUG] Installing Salt for development docs out of date #58516

SammyTbeile opened this issue Sep 21, 2020 · 3 comments

Comments

@SammyTbeile
Copy link
Contributor

@SammyTbeile SammyTbeile commented Sep 21, 2020

Description
The documentation for Installing Salt for development feels like it's out of date https://docs.saltstack.com/en/latest/topics/development/hacking.html . One example is that it seems to indicate that Python2 should be used:
On Arch Linux, where Python 3 is the default installation of Python, use the virtualenv2 command instead of virtualenv.

@sagetherage
Copy link
Contributor

@sagetherage sagetherage commented Sep 22, 2020

Thank you for submitting this issue, due to demands we likely will not get to this issue in the Magnesium release, so setting it for Aluminium.

@ScriptAutomate
Copy link
Contributor

@ScriptAutomate ScriptAutomate commented Sep 22, 2020

As an added note, that docs page has a section that will be updated to either include or point to a dedicated section around contributing to Salt documentation.

I'm referring to this section:

We are having an upcoming docs clinic where we are working to improve/update docs workflow for contributors, with this WIP PR being discussed in a different repo (via the Docs Working Group) before we eventually port to the official salt docs here. WIP docs contributor guide:

@ScriptAutomate
Copy link
Contributor

@ScriptAutomate ScriptAutomate commented Oct 5, 2020

For generating the docs, with nox already installed:

# Test building out HTML / Sphinx
nox -e 'docs-html(compress=False)'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Aluminium
  
To do
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.