-
Notifications
You must be signed in to change notification settings - Fork 253
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
Provide more context for breaking changes links #1784
base: main
Are you sure you want to change the base?
Conversation
@lcawl I've tagged you for initial discussion. |
Theoretically the addition of book names is applicable only until we migrate (and no longer have books, hooray). But then again, I'm also hoping the elastic.co/new project will render these repeated highlights and breaking changes unnecessary by then, so let's do whatever helps here now. LGTM |
I went down the same thought path. We new docs system and new release notes initiative should solve these problems, but that's no reason not to mitigate them for the present. Thanks! |
This pull request is now in conflict. Could you fix it @karenzone? 🙏
|
This pull request does not have a backport label. Could you fix it @karenzone? 🙏
|
This pull request is now in conflict. Could you fix it @karenzone? 🙏
|
3 similar comments
This pull request is now in conflict. Could you fix it @karenzone? 🙏
|
This pull request is now in conflict. Could you fix it @karenzone? 🙏
|
This pull request is now in conflict. Could you fix it @karenzone? 🙏
|
PREVIEW: https://stack-docs_1784.docs-preview.app.elstc.co/diff
Our breaking changes content in the Installation and Upgrade Guide could use a bit more context around the links.
At first glance, this link appears to be self-referential, when in fact, it's sending the user to the Logstash Reference. I know this content well, and still had a "where the heck am I" moment. This could have implications for screen readers as well.
I made a proposal for Logstash (and for other books as well) to add a clue that the link will send you to another book.
You get to decide for your deliverables
Like your links they way they are now? Prefer a different approach? Let me know, and we can make the change in this PR, or reverse the change for your docs.
Another thought
The breaking changes for Logstash are identical between the Installation and Upgrade Guide and the Logstash Reference. Is this statement true for other products?
I'm considering changing the text to something like "The list of breaking changes is also available in the Logstash Reference" to avoid sending users away for more info when there isn't any additional info.