Skip to content

update explorer docs with granular configuration#4088

Merged
enekofb merged 2 commits intomainfrom
jp-explorer-docs
Oct 25, 2023
Merged

update explorer docs with granular configuration#4088
enekofb merged 2 commits intomainfrom
jp-explorer-docs

Conversation

@jpellizzari
Copy link
Copy Markdown
Contributor

@jpellizzari jpellizzari marked this pull request as ready for review October 23, 2023 22:57
@jpellizzari jpellizzari requested a review from enekofb October 23, 2023 22:57
Copy link
Copy Markdown
Contributor

@enekofb enekofb left a 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.

# ... other spec components
values:
enableExplorer: true
explorer:
Copy link
Copy Markdown
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

Comment on lines +47 to +51
enabledFor:
- applications
- sources
- gitopssets
- templates
Copy link
Copy Markdown
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

@jpellizzari
Copy link
Copy Markdown
Contributor Author

@enekofb Added more info regarding the difference between UI and collection config

@jpellizzari jpellizzari requested a review from enekofb October 24, 2023 16:52
Copy link
Copy Markdown
Contributor

@enekofb enekofb left a 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/

@enekofb enekofb changed the title Change explorer config docs update explorer docs with granular configuration Oct 25, 2023
@enekofb enekofb merged commit 35254ac into main Oct 25, 2023
@enekofb enekofb deleted the jp-explorer-docs branch October 25, 2023 10:24
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.

3 participants