-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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: Improve archive log docs as to why it's not recommended #12597
Conversation
And document how to make life easier with links. Signed-off-by: Alan Clucas <alan@clucas.org>
I'm guessing this is a follow-up to the question and my answer in #12593? I haven't gotten that question too often, but good to have a longer note on it. In particular Argo seems to get a good bit of users who aren't necessarily operators/k8s cluster-admins and so may not know about |
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.
Recommending some structural changes for more directness and changing the verbal descriptions of links to example YAML. Also some changes per the style guide
Yes, directly inspired by that. It's a common question in face-to-face chats with argo users, so I thought worth addressing with a long term fix. |
Signed-off-by: Alan Clucas <alan@clucas.org>
Screenshots at the top of the issue are updated with the latest changes. |
@agilgur5 could you check you're happy with this? |
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 better, but there are still some pieces from the old version remaining that are now quite repetitive (and themselves still have style issues). Re-ordering it as suggested below will consolidate that significantly
Is there a way to reconfigure the UI after having followed these new recommendations to disable the default Seems a bit awkward to potentially have multiple buttons for |
Signed-off-by: Alan Clucas <alan@clucas.org>
Screenshot updated at the top. |
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Alan Clucas <alan@clucas.org>
This needs updating once more, but otherwise LGTM. EDIT: I updated it myself now that I have that permission |
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.
LGTM; addresses a common question
Signed-off-by: Alan Clucas <alan@clucas.org> Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> (cherry picked from commit 11b701a)
And document how to make life easier with links.
Switch to an admonition as per #12561.
Header:
And then new documentation
Verification
mkdocs build
See screenshots above.