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.

Sign up for GitHub

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

update explorer docs with granular configuration #4088

Merged
merged 2 commits into from
Oct 25, 2023
Merged

update explorer docs with granular configuration #4088

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7dfb2f
Change explorer config docs
jpellizzari Oct 17, 2023
ca9699e
Add more context to explorer setup
jpellizzari Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion website/docs/explorer/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,20 @@ metadata:
spec:
# ... other spec components
values:
enableExplorer: true
explorer:
Copy link
Contributor

Choose a reason for hiding this comment

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

given its a getting started page, a minimal configuration would be better

explorer:
  enabled: true # global enable/disable flag

and then leave other cases for the user to go onto the configuration page

https://docs.gitops.weave.works/docs/explorer/configuration/

where to give a little more guidance and the configuration options that we provide

https://docs.gitops.weave.works/docs/explorer/configuration/#setup

enabled: true
collector:
# ServiceAccount that explorer will use to watch clusters for resources
serviceAccount:
name: "collector"
namespace: "flux-system"
cleaner:
disabled: false
enabledFor:
- applications
- sources
- gitopssets
- templates
Copy link
Contributor

Choose a reason for hiding this comment

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

it feels that we should expand with comments to provide guidance to the user on how use these flags. for example: the user could think that is configuration for deciding which type of data to collect and not for the UI only

```

For a complete overview on the configuration you could see [configuration](./configuration.mdx).
Expand Down