-
Notifications
You must be signed in to change notification settings - Fork 153
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
update explorer docs with granular configuration #4088
Conversation
f7a39e8
to
e7dfb2f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added comment with suggestion on how to split the configuration info.
@@ -35,7 +35,20 @@ metadata: | |||
spec: | |||
# ... other spec components | |||
values: | |||
enableExplorer: true | |||
explorer: |
There was a problem hiding this comment.
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
enabledFor: | ||
- applications | ||
- sources | ||
- gitopssets | ||
- templates |
There was a problem hiding this comment.
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
@enekofb Added more info regarding the difference between UI and collection config |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
approving and merging to get it in today's wego release
followup around explorer docs and getting started vs configuration https://docs.gitops.weave.works/docs/explorer/configuration/
Related to weaveworks/weave-gitops-enterprise#3485