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

doc page title is confusing #6729

Closed
ntabris opened this issue Jul 15, 2022 · 3 comments · Fixed by #6733
Closed

doc page title is confusing #6729

ntabris opened this issue Jul 15, 2022 · 3 comments · Fixed by #6733
Labels
documentation Improve or add to documentation

Comments

@ntabris
Copy link
Contributor

ntabris commented Jul 15, 2022

The page that explains all sorts of plugins (Scheduler Plugins, Worker Plugin, even Nanny Plugins!) is titled "Scheduler Plugins". This is confusing.

It affects what's listed in the docs sidebar:

image

It also affects search results:

image

For a while I thought "why aren't there any docs about worker plugins?!" but eventually I looked at the "scheduler plugin" page and saw the information I wanted.

@ntabris
Copy link
Contributor Author

ntabris commented Jul 15, 2022

cc @scharlottej13

@jrbourbeau
Copy link
Member

Thanks for pointing that out @ntabris -- agreed that current page title is confusing. I think updating to just "Plugins" would be more clear (possibly adding a sentence or two saying there are different kinds of plugins). @scharlottej13 do you have bandwidth to work on this at the moment? (no obligation)

@jrbourbeau jrbourbeau added the documentation Improve or add to documentation label Jul 15, 2022
@scharlottej13
Copy link
Contributor

Thanks @jrbourbeau! Happy to make this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve or add to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants