-
Notifications
You must be signed in to change notification settings - Fork 67
First restructuring pass for auth section #1149
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
base: develop
Are you sure you want to change the base?
Conversation
ToC is the last piece to tie up - since hitting some funkiness with the rendering. Discussed and walked through each change. Looks fantastic on first walkthrough! |
I think I have the ToC finally working correctly and all links seem to be correct. I'm still clicking through some pages to check I haven't missed anything yet. This makes the landing page for the auth very lean but it is clear what you need to do and i removed a lot of redundancy in wording and warnings and merged some things. The idea is the page is incredibly streamlined so that it is hard to miss what is required, and it's now designed to let you "fall through" the docs section of the ToC then spit you back out to a "Known Auth Solutions" page where the user can select their auth, rather than just being dumped right into OIDC as previously. I did some serious rework on the overview, to the point i removed the file and even the old authentication page, split the authentication between the overview and the solutions, then folded the overview into that new ood-auth page as it felt like 3 pages all said the same thing in 3 different ways and this destroyed the nesting of the ToC to navigate easily. So, it's a big change. Hopefully it improves things. There's still room for improvement, but I am much happier with the logical flow and semantics for now. |
I also reworded the "Insecure Options" page to call out the reason so we don't have to explain it constantly along with making it a bit more severe in the warning of an insecure prod instance. |
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.
This is absolutely awesome, Travis, and I want to get this into our docs soon. Right now, these changes are in develop, which means they will not get pushed out until 4.1 timeframe because I've confirmed there are several other things waiting in develop that should not go to latest because of how they are tied to future releases. Is it possible for you to move these changes to latest so we can get it into the docs way sooner? Sorry that I did not mention having you doing this in latest sooner :(
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 really like that you have titled this OOD Documentation for clearer communication, but the URL needs to stay https://osc.github.io/ood-documentation/latest/authentication.html so that when people are configuring OOD and they get redirected to the documentation, they don't now get a 404 page.
Could you keep the title of the section the same but revert back the URL to the original?
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.
Maybe a more clearer way I could could have put it:
The heading and the text can still have "OOD Authentication" but the URL / maybe the file name needs to keep "Authentication"
Modify this link to include the branch name, and possibly the page this PR modifies:
https://osc.github.io/ood-documentation-test/auth-page-restruct-1035/
Add your description here
First pass at restructuring some of the auth page to help with the flow and emphasis on parts that must be done which users have a history of missing (like user mapping).
Part of issue #1035