Skip to content

Commit

Permalink
Fix and update customization docs (#4478)
Browse files Browse the repository at this point in the history
* Fixes #4335: Create Stratos static web site with better documentation
structure using docusaurus. Initial commit.

* 1) Re-organize some more existing doc files.
2) Re-organize links in the doc file to refer to the new document
   hierarchy.

* Landing Page WIP

* Documentation tweaks

* Use better action names

* More visual improvements to landing page

* More doc and landing page improvements

* Remove publish workflow for now

* Typo fix

* Moer documentation improvements

* Remove extra title from helm doc

* Fix script when used from npm

* Improve layout on mobile devices

* More documentation improvements

* Fix typo

* Merge downstream (#4441)

* Merge src/frontend from downstream

* Merge src/jetstream from jetstream

* Remove examples/custom-src

* Merge deploy from downstream
Does not include changes to
- deploy/all-in-one/*
- deploy/aio-entrypoint.sh
- deploy/Dockerfile.all-in-one

* Merge build from downstream

* Add missing merge items from deploy

* Updates to package-lock

* Remove fdescribe

* Fix e2e core tests

* Remove favicon from packages/core/src

* Changes following review

* Show all favorites for an endpoint favorite if there is only one (#4440)

* Show all favorites for the endpoint favorite if there is only one

* Missing changes

* Merge downstream - JSON Viewer with dark mode & Header Fixes (#4444)

* Fix json-viewer dark mode

* Fix profile page and side nav top position following header diet
- Fix side nav top position
- Update fix for profile page to also work in non-desktop mode

* Fix issues with tests not running if build upload fails (#4453)

* Fix issues with tests not running if build upload fails

* Fix script

* One more fix for script

* Fix white space at start of file

* Improve autoscaler e2e logging (#4456)

* Improve autoscaler e2e logging
- it looks like the AS returns scaling events 1-2 mins after they occur, which is too late for the test
- add additional logging to print out event table data in case of alternative events being raised
- fix logging if wait for events times out
- add hint in later test that depends on AS scaling event

* Ensure only the schedule rule results in scaling events

* Fix check-e2e-pr.sh for pr's from other repos (#4459)

- switch from TRAVIS_PULL_REQUEST_SLUG to TRAVIS_REPO_SLUG

* Convert Client Secret Input Fields to `password` (#4455)

* Insecure tlsv10 and tlsv11 ciphers in Stratos UI, bsc#1173295 (#411) (#4460)

Co-authored-by: Michal Jura <[email protected]>

* [Security] Bump codecov from 3.7.0 to 3.7.1 (#4457)

Bumps [codecov](https://github.com/codecov/codecov-node) from 3.7.0 to 3.7.1. **This update includes a security fix.**
- [Release notes](https://github.com/codecov/codecov-node/releases)
- [Commits](codecov/codecov-node@v3.7.0...v3.7.1)

Signed-off-by: dependabot-preview[bot] <[email protected]>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

* Bump lodash from 4.17.15 to 4.17.19 (#4452)

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](lodash/lodash@4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Website update: Wed 22 Jul 2020 21:55:00 BST

* Website update: Wed 22 Jul 2020 21:56:45 BST

* Website update: Wed 22 Jul 2020 21:58:22 BST

* Remove dist

* FIx deploy script to remove old files

* Moer tidy ups

* Add CNAME file when publishing

* Add talks doc

* * Fix broken links due to reorganization of documents

* Move Troubleshooting content from cloud-foundry deployment doc to
  cf-troubleshooting

* * Fix Getting Started broken link in page footer

* Only publish if there are website changes

* Remove old doc

* Publish website on merge

* Apply new theming process to acme example

* First pass at customization docs, most of themeing done

* Final pass at customization docs

* Merge fixes

Co-authored-by: Veerapuram Varadhan <[email protected]>
Co-authored-by: Neil MacDougall <[email protected]>
Co-authored-by: Neil MacDougall <[email protected]>
Co-authored-by: Neil MacDougall <[email protected]>
Co-authored-by: Michal Jura <[email protected]>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
8 people authored Aug 7, 2020
1 parent d7102e7 commit 50617f7
Show file tree
Hide file tree
Showing 18 changed files with 463 additions and 288 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,5 @@ src/frontend/sass
go-vendor-*.tgz

website/build
website/site-dist
website/site-dist
website/.docusaurus
4 changes: 2 additions & 2 deletions docs/issue_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@

### Actual behaviour

### Steps to reproduce the behaviour
### Steps to reproduce the behavior

### Log output covering before error and any error statements
```
Insert your log here
Insert log hereCopy
```


Expand Down
6 changes: 6 additions & 0 deletions docs/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
id: pull_request_template
title: Pull request template for contributions to Stratos
sidebar_label: PR template
---

<!--- Provide a general summary of your changes in the Title above -->

## Description
Expand Down
56 changes: 54 additions & 2 deletions src/frontend/packages/example-theme/_index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,60 @@

// Custom Theme
@import './sass/custom';
@import './sass/custom/acme-colors';

// Style overrides
@import './sass/custom/acme';

@function stratos-theme() {
$theme: stratos-theme-helper($stratos-theme);
@return $theme
}
@return (
default: create-custom-theme($stratos-theme),
dark: create-dark-theme()
);
}

@function create-custom-theme($base-theme) {
$theme: stratos-theme-helper($base-theme);

// Modify some of the colors
$app-theme: map-get($theme, app-theme);
$app-theme: map-merge($app-theme, (
header-background-color: $acme-text,
header-foreground-color: $acme-dark-gray,
header-background-span: false,
stratos-title-show-text: true,
user-avatar-background-color: $acme-text,
user-avatar-foreground-color: $acme-primary-color,
user-avatar-header-invert-colors: false,
side-nav: (
background: $acme-dark-gray,
text: $acme-text-gray,
active: $acme-side-nav-active,
active-text: $acme-text-gray,
hover: $acme-side-nav-active,
hover-text: $acme-text-gray
)
));

$theme: map-merge($theme, (
app-theme: $app-theme
));

@return $theme;
}

@function create-dark-theme() {
$theme: create-custom-theme($stratos-dark-theme);

$app-theme: map-get($theme, app-theme);
$app-theme: map-merge($app-theme, (
header-background-color: $acme-dark-gray,
header-foreground-color: $acme-text,
));

$theme: map-merge($theme, (
app-theme: $app-theme
));
@return $theme;
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/frontend/packages/example-theme/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"assets/core": "core/assets",
"assets/favicon.ico": "favicon.ico"
},
"theme":{
"theme": {
"loadingCss": "loader/loading.css",
"loadingHtml": "loader/loading.html"
}
Expand Down
2 changes: 0 additions & 2 deletions src/frontend/packages/example-theme/sass/custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,3 @@ $stratos-dark-theme: mat-dark-theme($acme-theme-primary, $acme-theme-primary, $a

// Default Theme
$stratos-theme: mat-light-theme($acme-theme-primary, $acme-theme-primary, $acme-theme-warn);

@import 'custom/acme';
16 changes: 16 additions & 0 deletions src/frontend/packages/example-theme/sass/custom/acme-colors.scss
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
// These colors need tidying, some aren't used

$acme-primary: #00c081;
$acme-secondary: #00243e;
$acme-text: #fff;
$acme-text-gray: #ccc;
$acme-button-gray: #888;
$acme-dark-blue: #06253a;
$acme-blue: #073155;

// Acme Brand primary colour
$acme-primary-color: #035a97;

// Secondary blue colour
$acme-secondary: #035a97;
$acme-text: #fff;
$acme-text-gray: #ccc;
$acme-dark-blue: #06253a;
$acme-blue: #073155;
$acme-side-nav: $acme-secondary;
$acme-side-nav-active: #003358;

$acme-dark-gray: #333
70 changes: 5 additions & 65 deletions src/frontend/packages/example-theme/sass/custom/acme.scss
Original file line number Diff line number Diff line change
@@ -1,71 +1,11 @@
// Style overrides
// Acme Brand primary colour
$acme-primary-color: #035a97;
@import './acme-colors';

// Secondary blue colour
$acme-secondary: #035a97;
$acme-text: #fff;
$acme-text-gray: #ccc;
$acme-dark-blue: #06253a;
$acme-blue: #073155;
$acme-side-nav: $acme-secondary;
$acme-side-nav-active: #003358;
// Style overrides

body.stratos {
app-page-subheader {
.page-subheader {
background-color: #fff;
color: #333;
}
}

.page-header__divider {
color: #333;
}

.page-header__menu-button-icon {
background-color: $acme-primary-color;
color: $acme-text;
}

.mat-tab-nav-bar.mat-primary.mat-background-primary {
.mat-tab-links {
background-color: #fff;
color: #333;
}
.mat-tab-link {
color: #333;
}
.mat-ink-bar {
background-color: $acme-primary-color;
.favorite-list {
.app-no-content-container {
color: $acme-dark-blue;
}
}

.stratos-title__logo {
width: 160px;
}

.page-header .mat-toolbar.mat-primary {
background-color: #fff;
color: #333;
}

// Use Acme Blue Side Navigation
.side-nav,
.side-nav__top,
.side-nav__item--active:hover {
background-color: $acme-side-nav;
}
.side-nav__item--active,
.side-nav__item:hover {
background-color: $acme-side-nav-active;
}
.side-nav__bottom {
color: $acme-text-gray;
}

// Show the text Stratos beneath the Acme logo
.stratos-title > .stratos-title__header {
display: inline-block;
}
}
4 changes: 2 additions & 2 deletions website/docs/extensions/backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Currently, to create an extension to the backend:

1. Build Jetstream

> Note: There are a few plugins in the `src/jetstream/plugins` folder that should help serve as examples of how to write a plugin.
> There are a few plugins in the `src/jetstream/plugins` folder that should help serve as examples of how to write a plugin.
> Note: Jetstream uses the [Echo web server](https://echo.labstack.com/) from Labstack - some familiarity with this is required when developing backend plugins.
> Jetstream uses the [Echo web server](https://echo.labstack.com/) from Labstack - some familiarity with this is required when developing backend plugins.
## Plugin Interface

All plugins must implement the interface `interfaces.StratosPlugin` - this is defined in `src/jetstream/repository/interfaces/plugin.go`.
Expand Down
154 changes: 0 additions & 154 deletions website/docs/extensions/customizing.md

This file was deleted.

Loading

0 comments on commit 50617f7

Please sign in to comment.