Skip to content
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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

karenzone
Copy link
Contributor

@karenzone karenzone commented Aug 13, 2021

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.

Screen Shot 2021-08-13 at 3 25 35 PM

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.

@karenzone karenzone requested a review from lcawl August 13, 2021 19:58
@karenzone
Copy link
Contributor Author

@lcawl I've tagged you for initial discussion.
@everyone I welcome your input as well -- now or later.

@lcawl
Copy link
Contributor

lcawl commented Aug 16, 2021

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

@karenzone
Copy link
Contributor Author

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!

@mergify
Copy link
Contributor

mergify bot commented Feb 24, 2022

This pull request is now in conflict. Could you fix it @karenzone? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch <remote-repo>
git checkout -b bc-text <remote-repo>/bc-text
git merge <remote-repo>/main
git push <remote-repo> bc-text

@mergify
Copy link
Contributor

mergify bot commented Feb 24, 2022

This pull request does not have a backport label. Could you fix it @karenzone? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip automated backport with mergify label Feb 24, 2022
@mergify
Copy link
Contributor

mergify bot commented Sep 27, 2022

This pull request is now in conflict. Could you fix it @karenzone? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch <remote-repo>
git checkout -b bc-text <remote-repo>/bc-text
git merge <remote-repo>/main
git push <remote-repo> bc-text

3 similar comments
@mergify
Copy link
Contributor

mergify bot commented Mar 30, 2023

This pull request is now in conflict. Could you fix it @karenzone? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch <remote-repo>
git checkout -b bc-text <remote-repo>/bc-text
git merge <remote-repo>/main
git push <remote-repo> bc-text

@mergify
Copy link
Contributor

mergify bot commented Aug 31, 2023

This pull request is now in conflict. Could you fix it @karenzone? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch <remote-repo>
git checkout -b bc-text <remote-repo>/bc-text
git merge <remote-repo>/main
git push <remote-repo> bc-text

Copy link
Contributor

mergify bot commented Jan 18, 2024

This pull request is now in conflict. Could you fix it @karenzone? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch <remote-repo>
git checkout -b bc-text <remote-repo>/bc-text
git merge <remote-repo>/main
git push <remote-repo> bc-text

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants