polaris

polaris copied to clipboard

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

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.

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

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

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.