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.

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

As enterprise admin I want to tweak an IDE look: change favicon, background image, title rebranding #2016

Open
4 tasks
brusherru opened this issue Aug 11, 2020 · 2 comments

Comments

@brusherru
Copy link
Contributor

brusherru commented Aug 11, 2020

Rationale

The enterprise admin wants to show their logotype on the background, favicon, and show their title of the tab/application.

Prerequisites

#2013 — introducing a new configuration file

User story

To specify a custom title of the IDE the title property of the config.json file should be edited:

{
  "title": "XOD Enterpise Edition"
}

To replace graphic images (and favicon) to their own admin should overwrite them:

  • in the dist/branding directory to update it without a rebuild,
  • in the xod-client/src/branding directory, which will be copied to the dist/branding during the build process, or used in the development mode yarn start dev:browser

Out of Scrope

Customizing desktop application icon.

Acceptance criteria

  • Admin can change the background image of the placeholder when no tabs opened without rebuilding by placing images to the dist/branding directory
  • Admin can overwrite it in the src/branding and use yarn start:browser or rebuild with the new graphics
  • Admin can change favicon the same way
  • Admin can change the title via the config file

How to implement

  1. Replace constant title with the function which gets value from the config file or fallback to the default
  2. Add <link> to the favicon to provide a favicon for IDE itself
  3. Replace some paths or inlined graphics with the images sourced from the new directory branding
  4. Tune Webpack config to work with the new branding directory
  5. Document all graphics that can be changed

How to test

@nkrkv
Copy link
Member

nkrkv commented Aug 12, 2020

    "noTabs": {
      "backgroundImage": "./my_own_logo.svg",
      "backgroundColor": "#F00"
    }

I see no reason to play with the image path. Can we just extract the image out of the bundle.js to a well/known/location/logo.svg and document the way it can be overwritten?

Also, see no reason to adjust the color. Any color other than current will not place nicely with the surrounding UI. Suggest removing.

@nkrkv
Copy link
Member

nkrkv commented Aug 12, 2020

favicon.ico stored in the service that serves a website, and it much desired to be placed in the root of the public (in case of that search engines will index some images it looks for a default favicon.ico place)

It’s our cluster internal detail. How does yarn start dev:browser work? It serves static files anyway, so it can serve the favicon. The favicon is not required to be on root (although I think we can put in even there). Use <link> tag to point to the location.

To put the summary. Customizing favicon at the xod-client-browser level is possible in the way similar to backgroundImage.

Customizing the icon of desktop IDE is indeed out of scope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants