-
Notifications
You must be signed in to change notification settings - Fork 510
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
[DOC] update links to tempo-operator API docs #3658
[DOC] update links to tempo-operator API docs #3658
Conversation
Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com>
menuTitle: TempoStack documentation | ||
description: TempoStack CRD and Operator configuration | ||
title: Operator configuration and CRD specifications | ||
menuTitle: API documentation |
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 think Operator configuration and CRD specifications
is too long for the menu. I'm open for better suggestions though :)
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.
What about Operator API documentation? We have some other API docs in Tempo docs.
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've been thinking about this a bit. The page is just linking to resources for the Operator.
What about calling the page "Reference," or maybe "Configuration, API, and CRD" or something like that?
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 like "Reference", I've renamed it now.
Yes, the page links to auto-generated reference files.
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.
Thank you for updating the docs!
Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com>
This PR must be merged before a backport PR will be created. |
My normal update is to backport small doc changes to the currently visible release. I've added the backport tag for this update as well. is that okay? |
Yes, thanks! |
* [DOC] update links to tempo-operator API docs Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> * update page title to Reference Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> --------- Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> (cherry picked from commit 67e28bb)
What this PR does:
update links to operator API docs
Which issue(s) this PR fixes:
fixes outdated links
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]