Skip to content

Create ui-customization.md #2127

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

Merged
merged 3 commits into from
Dec 21, 2022
Merged

Create ui-customization.md #2127

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bb9296
Create ui-customization.md
davidstauffer Dec 21, 2022
fe60292
Merge branch 'main' into add-docs-for-ui-customization
ahussein3 Dec 21, 2022
54c2bf1
Update ui-customization.md
davidstauffer Dec 21, 2022
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
27 changes: 27 additions & 0 deletions ui-customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Custom GUI
We support the following custom GUI elements:
- Logo (Logo Dimension should not be bigger than ( width: '150px', height: '32px')
- Footer (We do support mark-down style in the footer content but we don't encourage it as it will break the footer style.)

## Enabling

We make some configuration changes to the `values` in the Weave Gitops Enterprise `HelmRelease`.

```yaml
logoURL: http://iqt.dev/iqt.svg
footer:
backgroundColor: red
color: blue
content: My footer header This is the footer [link](example.com)
# Show or hide version of Weave GitOps
hideVersion: false
Copy link
Contributor

@ahussein3 ahussein3 Dec 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Can we add something to the description to explain what hideVesion does?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

```

## Rollout

After updating the `HelmRelease`, commit, push, reconcile and restart:

- `git commit -am "Enable cost estimation"`
- `git push`
- `flux reconcile kustomization --with-source flux-system`
- `kubectl -n flux-system rollout restart deploy/weave-gitops-enterprise-mccp-cluster-service`