etcd-io
Authentication and RBAC should be separate doc pages
The way it is now:
Our authentication reference info is kind of a postscript on the Role Based Access Control page (which is named, confusingly, "authentication"). This makes it both hard to find, and has resulted in full authentication docs never being written. All that's covered there is basic auth.
The way it should be:
We should have two separate pages, one named "Role Based Access Control" and one named "Authentication". The current auth content will be the stub of the authentication page, which should get built out with etcd's other authentication options and some examples of common auth integrations.
@jberkus, we've got a new Authentication page now; should the original https://etcd.io/docs/v3.5/op-guide/authentication/ (Athentication) page now be renamed "Role Based Access Control" & moved next to the new Auth page?
The current page https://etcd.io/docs/v3.5/authentication/ looks more of RBAC so that needs to be worked on as discussed in meeting today. Also, let's have a high level dir here with two sub-pages covering Authentication and RBAC on their own. @nate-double-u @Somoshree Please add anything if I missed from our discussion. Thanks!
During that meeting we also had a discussion about where the Authentication should be -- at the same level as op-guide, or under op-guide. I'm happy with it being at the same level as I think it's likely a very common action, so it may be valuable to have it have a higher place, but I can also see how it's a part of the op-guide suite, and if it's put there we can still link to it from other places.
Ether way, I'd recommend making fairly liberal use of the git mv command so that we don't lose the git history as we move these pages around.
If we want to move the new authentication stuff back into op-guide, id suggest the following process:
- in
content/en/docs/v3.5/:git mv authentication/ op-guide/authentication - then, in
content/en/docs/v3.5/op-guide:git mv authentication.md authentication/rbac.md - remember we'll need to update the redirects file as we've published the new Authentication page
In this case we'll also need to rework the new op-guide/authentication page as it'll actually be an index, meaning we'll likely need a new auth instruction page. Other headers may also need to be updated.
(We could use a similar process if we want to move everything into the content/en/docs/v3.5/authentication folder.)
I'd say under the op guide. It's important, but it's definitely operations.