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

Index h3s in docs for search #10123

Closed
kimberleyamackenzie opened this issue Oct 24, 2023 · 2 comments · Fixed by #13328
Closed

Index h3s in docs for search #10123

kimberleyamackenzie opened this issue Oct 24, 2023 · 2 comments · Fixed by #13328
Assignees
Labels
area/docs Improvements or additions to documentation grooming-q2y25 kind/enhancement Improvements or new features needs-triage Needs attention from the triage team resolution/by-design This issue won't be fixed because the functionality is working as designed resolution/fixed This issue was fixed
Milestone

Comments

@kimberleyamackenzie
Copy link
Contributor

kimberleyamackenzie commented Oct 24, 2023

I was searching for a specific piece of info about deployments, and I searched the term "dependency installation" in docs.
My search returned 0 results, and I had to ask someone on the project for details, and they linked me to this page - https://www.pulumi.com/docs/pulumi-cloud/deployments/reference/#customizing-the-dependency-installation-step. I was surprised that I didn't find that via search, given the phrase appears in the h3 there.

@kimberleyamackenzie kimberleyamackenzie added the needs-triage Needs attention from the triage team label Oct 24, 2023
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Oct 24, 2023
@toriancrane toriancrane added area/docs Improvements or additions to documentation kind/enhancement Improvements or new features and removed needs-triage Needs attention from the triage team labels Oct 25, 2023
@toriancrane toriancrane moved this from 🤔 Triage to 🎬 Ready in Docs 📚 Oct 25, 2023
@cnunciato cnunciato moved this from 🎬 Ready to 🧳 Backlog in Docs 📚 Jul 1, 2024
@thoward
Copy link
Contributor

thoward commented Nov 9, 2024

This is a good call out. According to the script that builds the index, we've explicitly chosen not to include H3s because they are "too noisy": https://github.com/pulumi/docs/blob/master/scripts/search/page.js#L54 ...

I'm going to close this as "by design". However, it's worth consider if this design is ideal or not... Including all H3s as well as H2s is a very small change to the jQuery selector in that same code location.

@interurban @sean1588 If you think we should add these, we can reopen and get a PR in right away.

@thoward thoward self-assigned this Nov 9, 2024
@thoward thoward added the resolution/by-design This issue won't be fixed because the functionality is working as designed label Nov 9, 2024
@thoward thoward moved this from 🧳 Backlog to 🏁 Done in Docs 📚 Nov 9, 2024
@thoward thoward closed this as completed Nov 9, 2024
@thoward thoward moved this from 🏁 Done to 💜 Review in Docs 📚 Nov 12, 2024
@thoward
Copy link
Contributor

thoward commented Nov 12, 2024

After some discussion, going to reopen and fix this.

@thoward thoward reopened this Nov 12, 2024
@thoward thoward added this to the 0.113 milestone Nov 12, 2024
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Nov 12, 2024
@github-project-automation github-project-automation bot moved this from 💜 Review to 🏁 Done in Docs 📚 Nov 13, 2024
@pulumi-bot pulumi-bot added the resolution/fixed This issue was fixed label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation grooming-q2y25 kind/enhancement Improvements or new features needs-triage Needs attention from the triage team resolution/by-design This issue won't be fixed because the functionality is working as designed resolution/fixed This issue was fixed
Projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

4 participants