openstack
/
charm-openstack-dashboard
Code Issues Proposed changes

[DOC] Add details about custom theme folder structure 

When using custom themes, some strict structure should be
used in order for it to work correctly.

Closes-bug: #1897805
Change-Id: I535478b06f8789f245b6c9fc523806c02c47a369
This commit is contained in:
Rodrigo Barbieri 2022-09-01 15:37:02 -03:00
parent ee9762367b
commit 366960f4c9
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -86,6 +86,32 @@ the file 'local_settings.py' is included it will be sourced.
Repeating the attach-resource will update the theme and turning off the
custom-theme option will return to the default.
The extracted .tgz file should contain the root of the custom theme directory,
where all static content is placed in a directory named 'static'. Here is an
example directory structure:
theme.tgz
\ static - _styles.scss
| | _variables.scss
| \ img - favicon.ico
| | logo.svg
| \ logo-splash.svg
|
\ local_settings.py (optional)
A barebone custom theme would include only the files shown in the example
above, where the '\_styles.scss' file is empty, and the '\_variables.scss'
file contains:
$brand-primary: #772953; // the key brand color
$navbar-default-bg: $brand-primary;
$navbar-default-link-hover-bg: darken($navbar-default-bg, 15%);
$navbar-default-color: #fff;
$navbar-default-toggle-hover-bg: darken($navbar-default-bg, 10%);
$navbar-default-toggle-icon-bar-bg: #fff;
$navbar-height: 36px;
@import "/themes/default/variables";
Optionally, the uploaded custom theme can be set as the default theme.
juju config openstack-dashboard default-theme='custom'