Skip to content

Put Dependabot in gallery on landing page and in the sidebar #5953

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

Closed
HonkingGoose opened this issue May 2, 2021 · 2 comments
Closed

Put Dependabot in gallery on landing page and in the sidebar #5953

HonkingGoose opened this issue May 2, 2021 · 2 comments
Labels
triage Do not begin working on this issue until triaged by the team

Comments

@HonkingGoose
Copy link
Contributor

What is the current behavior?

It's hard to find the documentation entrypoint for Dependabot.

This is probably what happens to newcomers to the GitHub docs:

  1. Go to the main landing page: https://docs.github.com/en
  2. Search on landing page for "Dependabot" in browser search (CTRL + F), no hits.
  3. Use docs-native search with string "Dependabot", get no hits about enabling Dependabot.

What changes are you suggesting?

I think it would be great to have links/text that references Dependabot on the main landing page of the docs.

  • Create new item in sidebar called "Dependabot".
  • Create new item in "Explore by product" gallery on the homepage for the GitHub docs, called "Dependabot".

This way users can find the docs for Dependabot by viewing the sidebar, looking in the "gallery" on the homepage, or by searching in their browser for the string "Dependabot" and find the sidebar/gallery items.

Additional information

Inspired by the confusion a user had with finding Dependabot docs in issue: #5946.

@HonkingGoose HonkingGoose added the engineering Will involve Docs Engineering label May 2, 2021
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 2, 2021
@chiedo chiedo removed the engineering Will involve Docs Engineering label May 3, 2021
@lee-dohm
Copy link
Contributor

lee-dohm commented May 3, 2021

Thanks @HonkingGoose for your detailed feedback! Having the steps to reproduce your experience was especially helpful in understanding the problem you’re describing.

I also want to say that going the extra mile to help someone out when they were in need is very much appreciated. This kind of helpful and cooperative attitude is what attracted me, personally, to open source in the first place and keeps me excited and hopeful about efforts like open sourcing the GitHub documentation.

Upon reviewing this with the team, we feel the real failure here is the inability to search for the information that was needed. The search experience in the GitHub Docs is not especially useful at times. This is something that we have targeted for improvement and are currently investigating how best to achieve those gains. Because we’re still scouting out alternatives with their various pros and cons, we can’t give a timeline for when we’ll be able to roll out changes, however be assured that this is a pain point that we experience as well and want to see fixed. Because this is a search issue and not something that we would change the gallery or sidebar for, we’re going to close this issue.

Thanks again for contributing to the GitHub Docs and your interest in seeing them improved! We truly appreciate your ongoing efforts and eagerness to help people 💖

@lee-dohm lee-dohm closed this as completed May 3, 2021
@HonkingGoose
Copy link
Contributor Author

I also want to say that going the extra mile to help someone out when they were in need is very much appreciated. This kind of helpful and cooperative attitude is what attracted me, personally, to open source in the first place and keeps me excited and hopeful about efforts like open sourcing the GitHub documentation.

Thank you very much for the compliment! 😄 🥳

Because this is a search issue and not something that we would change the gallery or sidebar for, we’re going to close this issue.

That's ok, at least now it on the radar. Thanks for discussing my idea with the team, and for your helpful explanation of the reason for closing the issue!

Thanks again for contributing to the GitHub Docs and your interest in seeing them improved! We truly appreciate your ongoing efforts and eagerness to help people 💖

🥳 ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

No branches or pull requests

3 participants