search

saltstack / salt

Software to automate the management and configuration of any infrastructure or application at scale. Install Salt from the Salt package repositories here:
https://docs.saltproject.io/salt/install-guide/en/latest/
Apache License 2.0
14.23k stars 5.49k forks source link

documentation: remove old docker module page #42015

Closed epelc closed 6 years ago

epelc commented 7 years ago

Description of Issue/Question

docker.login is missing documentation on the latest develop

https://docs.saltstack.com/en/develop/ref/modules/all/salt.modules.docker.html

gtmanfred commented 7 years ago

https://docs.saltstack.com/en/develop/ref/modules/all/salt.modules.dockermod.html#salt.modules.dockermod.login

docker.html is the old one, i am not sure why that is there.

It is documented correctly in dockermod.

I am going to tag this as a documentation error and see if we can get these extra files cleaned up.

cc @rallytime @Ch3LL It looks like there are some old files on the docs server that haven't been deleted when the module names were changed?

Thanks! Daniel

epelc commented 7 years ago

@gtmanfred Is it supposed to be dockerng.login on the new page? Looks like another issue

Needs to be changed to docker.login

image

gtmanfred commented 7 years ago

Yup, Erik had made some changes and looks like they got merged forward when they didn't need to be.

I have reverted it in the newer branch in #42019

Thanks! Daniel

terminalmage commented 7 years ago

I had to go back and fix dockerng in the older branches, since the login func was originally backported from a newer branch and contanined the 2017.7-and-later usage. I meant to ping @rallytime to remind her that we'd need to re-fix that once it was merged forward, but I didn't do that and the merge-forward overwrote the docs in the newer branches. I've merged @gtmanfred's PR.

As for the page linked in the OP, we had to rename salt.modules.docker to salt.modules.dockermod to avoid a circular import in our loader. We are likely just deploying the docs using an rsync (without --delete), so the old file was left live on docs.saltstack.com. We just need to remove that old file from the webserver.

As you can see here the list of modules contains a link to the correct page.

epelc commented 7 years ago

@terminalmage Thanks!

Just fwi from a users perspective on how I ended up there. I was getting to that page by googling salt docker module clicking current docs link, going to develop branch, then manually changing dockerio to docker in the url since develop has no page for dockerio.

I'm not sure how typical this is or if it was just me being lazy and not liking the salt docs site search much. Anyways I think this fix is good and my fault for not being aware of the docker vs dockermod naming(have only been using python for a little while). I'll use the doc's site search from now on.

terminalmage commented 7 years ago

What you see there as "develop" will shortly be our 2017.7.0 release. In that release, dockerio (the legacy docker support) has been removed. The replacement, which was formerly called dockerng, has also been renamed.

I think your way of getting to the docs is totally valid though, and we should look into doing some sort of redirect for renamed modules. Sorry about any confusion.

stale[bot] commented 6 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.