Skip to content
This repository has been archived by the owner on Jan 24, 2023. It is now read-only.

Commit

Permalink
Fix docs (#4497)
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 <mjura@users.noreply.github.com>

* [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] <support@dependabot.com>

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] <support@github.com>

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

* Update base README, point to website

* Update developer docs
Still need an overhall, but updated to remove incorrect data and apply website context

* Fix PR template

Co-authored-by: Veerapuram Varadhan <v.varadhan@gmail.com>
Co-authored-by: Neil MacDougall <neil.macdougall@suse.com>
Co-authored-by: Neil MacDougall <nmacdougall@suse.com>
Co-authored-by: Neil MacDougall <nwmac@users.noreply.github.com>
Co-authored-by: Michal Jura <mjura@users.noreply.github.com>
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 committed Aug 7, 2020
1 parent e12f60f commit 4209358
Show file tree
Hide file tree
Showing 4 changed files with 306 additions and 236 deletions.
6 changes: 0 additions & 6 deletions docs/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
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
152 changes: 20 additions & 132 deletions website/docs/developer/developers-guide-env-tech.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,68 @@
---
id: developers-guide-env-tech
title: Stratos Tech + Developer Environment
sidebar_label: Dev Environment
title: Developer Links + Environment
sidebar_label: Dev Links & Env
---

## ES6
## Links

Below is a collection of links that are can be useful when tackling some of the technology involved with Stratos

### ES6

* [http://stack.formidable.com/es6-interactive-guide](http://stack.formidable.com/es6-interactive-guide)
* [http://es6-features.org](http://es6-features.org)

## TypeScript
### TypeScript

* [https://www.sitepen.com/blog/2013/12/31/definitive-guide-to-typescript/](https://www.sitepen.com/blog/2013/12/31/definitive-guide-to-typescript/)
* [https://learnxinyminutes.com/docs/typescript/](https://learnxinyminutes.com/docs/typescript/) (cheat sheet)
* [https://www.tutorialspoint.com/typescript/](https://www.tutorialspoint.com/typescript/)
* [https://tutorialzine.com/2016/07/learn-typescript-in-30-minutes](https://tutorialzine.com/2016/07/learn-typescript-in-30-minutes)
* [https://www.sitepen.com/blog/2013/12/31/typescript-cheat-sheet/](https://www.sitepen.com/blog/2013/12/31/typescript-cheat-sheet/) (advanced cheat sheet)

## Angular

### Angular

#### Angular

* [https://www.youtube.com/watch?v=KhzGSHNhnbI](https://www.youtube.com/watch?v=KhzGSHNhnbI) (very basic 1h video of angular covering basic app features in a demo)
* [https://angular.io/guide/architecture](https://angular.io/guide/architecture) (official angular intro)
* [https://angular.io/tutorial](https://angular.io/tutorial) (official angular tutorial. Basic to start with but good introduction to routing, http requests, promises, observables and observable event stream later on)

### Angular CLI
#### Angular CLI

* [https://cli.angular.io/reference.pdf](https://cli.angular.io/reference.pdf) (cheat sheet)
* [https://github.com/angular/angular-cli](https://github.com/angular/angular-cli)

### Example Apps
#### Example Apps

* https://github.com/aviabird/angularspree (covers everything)

## Redux
### Redux

* [http://redux.js.org](http://redux.js.org)
* [https://gist.github.com/btroncone/a6e4347326749f938510](https://gist.github.com/btroncone/a6e4347326749f938510)
* [https://code-cartoons.com/a-cartoon-intro-to-redux-3afb775501a6](https://code-cartoons.com/a-cartoon-intro-to-redux-3afb775501a6)
* [https://www.youtube.com/watch?v=WIqbzHdEPVM](https://www.youtube.com/watch?v=WIqbzHdEPVM)
* [https://egghead.io/courses/getting-started-with-redux](https://egghead.io/courses/getting-started-with-redux)

### Observables
#### Observables

* [http://reactivex.io/documentation/observable.html](http://reactivex.io/documentation/observable.html)

## VS Code Plug-ins

There's no mandated IDE, but if you choose VS Code here's some helpful plug-ins
There's no mandated IDE, but if you choose Visual Studio Code here's some helpful plug-ins

### Super Helpful
### Really Helpful

* TSLint
* SassLint
* TS Hero
* Beautify
* Git Lens
* gitignore
* Move TS - Move files and automatically update imports

### Helpful

* Angular 2+ Snippets
* Angular v4 TypeScript Snippets
* Git Lens
* Beautify
* Document This
* Git History
* TODO Parser
Expand All @@ -76,122 +76,10 @@ There's no mandated IDE, but if you choose VS Code here's some helpful plug-ins
```

* F1 + `Parse TODOs (all files)` to see all TODOs
* Move TS - Move files and automatically update imports

### Of Interest

* Eclipse Keymap
* Code Spell Checker
* List of words to exclude coming soon
* Eclipse Keymap

Example settings

```
{
"gitlens.blame.line.enabled": false,
"gitlens.codeLens.recentChange.enabled": false,
"gitlens.codeLens.authors.enabled": false,
"gitlens.blame.highlight.locations": [
"gutter",
"overview"
],
"gitlens.currentLine.enabled": false,
"gitlens.hovers.currentLine.enabled": false,
"editor.fontSize": 12,
"editor.formatOnSave": true,
"editor.rulers": [
140
],
"editor.renderLineHighlight": "none",
"search.exclude": {
"node_modules": true,
"**/node_modules": true,
"**/bower_components": true,
"coverage": true,
"components/*/backend/vendor": true,
"*.orig": true
},
"search.useIgnoreFilesByDefault": true,
"tslint.validateWithDefaultConfig": true,
"tslint.configFile": "tslint.json",
"tslint.autoFixOnSave": true,
"tslint.alwaysShowStatus": true,
"tslint.alwaysShowRuleFailuresAsWarnings": true,
"explorer.autoReveal": false,
"extensions.ignoreRecommendations": false,
"TodoParser": {
"folderExclude": [
"node_modules",
".vscode"
]
},
"cSpell.userWords": [
"Guids",
"action",
"api",
"cnsi",
"cnsis",
"confirmation",
"dialog",
"falsies",
"guid",
"iapi",
"initialise",
"initialised",
"injectable",
"memberof",
"ngrx",
"normalizr",
"strat",
"unsubscribe",
"vars"
],
"cSpell.language": ",en-GB",
"cSpell.enabledLanguageIds": [
"c",
"css",
"cpp",
"csharp",
"fonts",
"go",
"handlebars",
"javascript",
"javascriptreact",
"json",
"latex",
"markdown",
"php",
"plaintext",
"python",
"restructuredtext",
"text",
"typescript",
"typescriptreact",
"yml",
"html"
],
"files.exclude": {
"**/.git": true,
"**/.svn": true,
"**/.hg": true,
"**/CVS": true,
"**/.DS_Store": true,
"**/tmp": true,
"**/node_modules": true,
"**/bower_components": true,
"**/dist": true,
"**/.orig": true
},
"files.watcherExclude": {
"**/.git/objects/**": true,
"**/.git/subtree-cache/**": true,
"**/node_modules/**": true,
"**/tmp/**": true,
"**/bower_components/**": true,
"**/dist/**": true
},
}
```

## Guides

Expand Down
2 changes: 1 addition & 1 deletion website/docs/developer/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ Configuration information can be found in two places
* Informs the frontend where the backend is
* `./src/frontend/packages/core/src/environments/environment.ts` for developer vs production like config
* This contains more general settings for the frontend and does not usually need to be changed
* `config.properies`
* `config.properties`
* Backend configuration
Loading

0 comments on commit 4209358

Please sign in to comment.