Skip to content

updating extend explorer internal documentation out of the feedback from adding gitopssets #3283

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

Merged
merged 3 commits into from
Sep 6, 2023

Conversation

enekofb
Copy link
Contributor

@enekofb enekofb commented Sep 4, 2023

…rom adding gitopssets

Closes #3281

What changed?

Updated extend explorer internal documentation with findings from extending explorer with gitopsssets

Why was this change made?

To give more complete feedback on the steps to extend explorer

How was this change implemented?

Just documentation

How did you validate the change?

  • Explain how a reviewer can verify the change themselves
  • Integration tests -- what is covered, what cannot be covered;
    or, explain why there are no new tests
  • Unit tests -- what is covered, what cannot be covered; are
    there tests that fail without the change?

It is just documentation so not required the steps above

Release notes

No

Documentation Changes

Not required, internal documentation

Other follow ups

@enekofb enekofb added the exclude from release notes Use this label to exclude a PR from the release notes label Sep 4, 2023
@enekofb enekofb mentioned this pull request Sep 4, 2023
1 task
If you would like to use default Explorer view with your Kind:

1. Add your Kind details Route to [`getKindRoute`](https://github.com/weaveworks/weave-gitops-enterprise/blob/f36d549b6010afbd3c086c4955637586629ec589/ui-cra/src/utils/nav.ts#L3)
2. Add a test case for your kind in the [integration test](https://github.com/weaveworks/weave-gitops-enterprise/blob/main/pkg/query/server/server_integration_test.go#L44)

## Using the Explorer UI component
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe a new section:

updating the tests!

  1. Add any CRDs to testdata/crds
  2. Add AddToScheme to suite_test.go`

Anything else @ranatrk ? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added e2bfec1

@enekofb enekofb requested a review from foot September 5, 2023 16:05
@enekofb enekofb force-pushed the issues/3281 branch 2 times, most recently from cab3ab2 to 2dd6da7 Compare September 6, 2023 09:08
@enekofb enekofb merged commit f774d0e into main Sep 6, 2023
@enekofb enekofb deleted the issues/3281 branch September 6, 2023 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exclude from release notes Use this label to exclude a PR from the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend explorer internal documentation with information on ToFluxObject
4 participants