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

Jump to bottom

[dashboard] Improve dashboard customization #17741

Closed
sleshchenko opened this issue Aug 28, 2020 · 1 comment · Fixed by eclipse-che/che-dashboard#97
Closed

[dashboard] Improve dashboard customization #17741

sleshchenko opened this issue Aug 28, 2020 · 1 comment · Fixed by eclipse-che/che-dashboard#97
Assignees
@akurinnoy
Labels
area/dashboard kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.
Milestone
7.20

Comments

@sleshchenko
Copy link
Member

Is your task related to a problem? Please describe.

Currently, we have the following issues with dashboard customization:

  1. values are duplicated in upstream in two places - branding constants (code) and product.json (additional resource that can be overridden).
  2. When for some reason product.json is not loaded - constants are used without any warning, it's safe for upstream but for some downstream, like CRW - then we'll have Eclipse Che dashboard displayed instead of branded CRW.

Describe the solution you'd like

As we discussed with @olexii4 and @akurinnoy some stuff can be improved:

  1. Make product.json in upstream - just empty values since upstream already has everything needed in code.
    Note once it's done https://github.com/eclipse/che-docs/blob/master/.github/PULL_REQUEST_TEMPLATE.md should be updated as well.
  2. Make RHChe specified only values that should be overridden to avoid extra support, like documentation links.
  3. Make dashboard show a warning banner in case product.json is not loaded. It will help catch packaging/deployment issue earlier.

One improvement we told about but postponed to time of the #15778:

  1. Introduce JSON schema for product.json, then it would solve two issues:
  • we'll have documented product.json
  • downstreams are able to validate their customized files with that JSON schema to make sure it's valid and even - no new fields are added which may lead to unexpected default values usage.

Describe alternatives you've considered

Additional context
@sleshchenko sleshchenko added kind/task Internal things, technical debt, and to-do tasks to be performed. area/dashboard labels Aug 28, 2020
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Aug 28, 2020
@vparfonov vparfonov added severity/P2 Has a minor but important impact to the usage or development of the system. and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Aug 31, 2020
@sleshchenko
Copy link
Member Author

P.S. docs entries like factory, organization, converting seems to be deprecated and should be removed in upstream and downstream.

@sleshchenko sleshchenko added this to the 7.20 milestone Sep 17, 2020
@akurinnoy akurinnoy self-assigned this Oct 1, 2020
@akurinnoy akurinnoy mentioned this issue Oct 1, 2020
Merged
This was referenced Oct 7, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@akurinnoy akurinnoy

Labels
area/dashboard kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.
Projects
None yet
Milestone
7.20
Development

Successfully merging a pull request may close this issue.

UD customization improvement eclipse-che/che-dashboard
4 participants
@vparfonov @sleshchenko @akurinnoy @che-bot