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

Support custom categories & documentation URLs #854

Open
bkrein-vertex opened this issue Sep 27, 2022 · 4 comments
Open

Support custom categories & documentation URLs #854

bkrein-vertex opened this issue Sep 27, 2022 · 4 comments
Labels
enhancement Adding additional functionality or improvements pinned Prevents stalebot from removing

Comments

@bkrein-vertex
Copy link

Is your feature request related to a problem? Please describe.

When writing custom checks it would be helpful to be able to put them into custom categories with custom documentation URLs to set the (?) icon link to.

Describe the solution you'd like

Perhaps a new section in the config file to define custom categories like the following:

categories:
  - name: category1
    url: https://example.com/docs/category1
  - name: category2
    url: https://example.com/docs/category2

Describe alternatives you've considered

None.

Additional context

N/A

@bkrein-vertex bkrein-vertex added enhancement Adding additional functionality or improvements triage This bug needs triage labels Sep 27, 2022
@sudermanjr
Copy link
Member

sudermanjr commented Sep 27, 2022

I believe custom categories are already supported inherently for custom checks. I definitely think adding the ability point the URL to a custom location for that category would be awesome.

@bkrein-vertex
Copy link
Author

Is that true? According to the docs you can only use Security, Efficiency & Reliability:

Pasted_Image_9_27_22__12_31_PM

@sudermanjr
Copy link
Member

Seems like the docs are wrong :-D

I was able to do custom ones during a recent demo. I can dig up the video if you like

@bkrein-vertex
Copy link
Author

Confirmed that you can indeed create arbitrary categories but they're still hard-coded to a Fairwinds URL. For example I created the Business category but the links will all point to:

https://polaris.docs.fairwinds.com/checks/business

Which I don't think is customizable at this point.

@sudermanjr sudermanjr added pinned Prevents stalebot from removing and removed triage This bug needs triage labels Nov 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Adding additional functionality or improvements pinned Prevents stalebot from removing
Projects
None yet
Development

No branches or pull requests

2 participants