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

Feature Request: Searchable Release Notes #3519

Closed
chef-davin opened this issue Oct 28, 2021 · 2 comments
Closed

Feature Request: Searchable Release Notes #3519

chef-davin opened this issue Oct 28, 2021 · 2 comments
Assignees
Labels
CFT Support Customer Facing Team support Documentation Type: Enhancement Adds new functionality.

Comments

@chef-davin
Copy link
Contributor

Is your feature request related to a problem? Please describe.
There is a frustration around not being able to search through release notes with the docs search feature. Particularly for Chef Infra Client

In the previous format, to find things out about less-documented or undocumented things (target mode, powershell_exec, chef-run, compliance folders in cookbooks, etc...) I could go to the release notes and just search the giant page with the browser's search function, but now I have to try to remember the exact release version when a feature was introduced or improved and I can no longer find those things.

Describe the solution you'd like
It would be great if searching for an undocumented feature, I could at least be taken to the release page where that feature was introduced or updated so I could get some context around it.

Describe alternatives you've considered
Finding all the underdocumented things and creating Issues/PRs for each of them so they actually make it into the docs.

@chef-davin chef-davin added Type: Bug Does not work as expected. Status: Untriaged An issue that has yet to be triaged. Documentation CFT Support Customer Facing Team support labels Oct 28, 2021
@IanMadd
Copy link
Contributor

IanMadd commented Oct 28, 2021

I think this Issue can be lumped together with #3273.

I think the goal is that each product has a single page for release notes, that they're static pages and not loaded with JS which will allow search, and then each individual release has a separate page. So something like:

https://docs.chef.io/release_notes_<PRODUCT>/ for a single static page,

and

https://docs.chef.io/release_notes_<PRODUCT>/<VERSION>/ for static pages for each individual release note.

One goal is to maintain a single source for the RN so if they're updated in the S3 bucket, the updates will automatically show up in docs.chef.io. That could involve some kind of bash/Expeditor trickery or Hugo's getJSON.

🤔

@IanMadd IanMadd self-assigned this Oct 28, 2021
@kagarmoe kagarmoe added Type: Enhancement Adds new functionality. and removed Type: Bug Does not work as expected. Status: Untriaged An issue that has yet to be triaged. labels Nov 16, 2021
@IanMadd IanMadd mentioned this issue Dec 23, 2021
8 tasks
@IanMadd
Copy link
Contributor

IanMadd commented Jan 19, 2022

Close with #3623

@IanMadd IanMadd closed this as completed Jan 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CFT Support Customer Facing Team support Documentation Type: Enhancement Adds new functionality.
Projects
None yet
Development

No branches or pull requests

3 participants