Skip to content

docs: add Perses Operator documentation#129

Merged
Nexucis merged 1 commit intoperses:mainfrom
slashpai:operator-docs
Feb 17, 2026
Merged

docs: add Perses Operator documentation#129
Nexucis merged 1 commit intoperses:mainfrom
slashpai:operator-docs

Conversation

@slashpai
Copy link
Member

Include User Guide and API Reference in the navigation menu

Fixes #128

Include User Guide and API Reference in the navigation menu

Signed-off-by: Jayapriya Pai <janantha@redhat.com>

Fixes perses#128
@Nexucis
Copy link
Member

Nexucis commented Feb 17, 2026

hi @slashpai,

did you see these logs ?

INFO    -  Doc file 'index.md' contains an absolute link '/perses-operator/docs/user-guide/', it was left as is. Did you mean 'perses-operator/docs/user-guide.md'?
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#display', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#panel', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#duration', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#plugin', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#security', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#database', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#schemas', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#dashboardconfig', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#provisioningconfig', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#datasourceconfig', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#variableconfig', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#ephemeraldashboard', but there is no such anchor on this page.
INFO    -  Doc file 'perses-operator/docs/api.md' contains a link '#frontend', but there is no such anchor on this page.

is it something that should be considered ?

@slashpai
Copy link
Member Author

Its because its embedded type it wont show in original api.md file as well https://github.com/perses/perses-operator/blob/main/docs/api.md#ephemeraldashboard, its a limitation of crd doc gen

Copy link
Member

@Nexucis Nexucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks

@Nexucis Nexucis merged commit 54380df into perses:main Feb 17, 2026
3 checks passed
@slashpai
Copy link
Member Author

Just curious how often the site gets redeployed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include perses-operator docs and have page for API docs

2 participants