Fixes cloudfoundry#4335: Create Stratos static web site with better d…

…ocumentation (cloudfoundry#4446)

* Fixes cloudfoundry#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 (cloudfoundry#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 (cloudfoundry#4440)

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

* Missing changes

* Merge downstream - JSON Viewer with dark mode & Header Fixes (cloudfoundry#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 (cloudfoundry#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 (cloudfoundry#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 (cloudfoundry#4459)

- switch from TRAVIS_PULL_REQUEST_SLUG to TRAVIS_REPO_SLUG

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

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

Co-authored-by: Michal Jura <mjura@users.noreply.github.com>

* [Security] Bump codecov from 3.7.0 to 3.7.1 (cloudfoundry#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 (cloudfoundry#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

* * Review comments fix

* Fix broken link to an image in frontend extensions doc

* Final tweaks

Co-authored-by: Neil MacDougall <neil.macdougall@suse.com>
Co-authored-by: Neil MacDougall <nmacdougall@suse.com>
Co-authored-by: Richard Cox <richard-cox@users.noreply.github.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>
Co-authored-by: Richard Cox <richard.cox@suse.com>

.cfignore

@@ -21,3 +21,4 @@ deploy/uaa/
 docs/
 build/dev_config.json
 e2e-reports/
+website/

.codeclimate.yml

@@ -28,4 +28,5 @@ exclude_patterns:
 - "**/vendor/"
 - "**/*.d.ts"
 - "**/__vendor/"
-- "**/*_test.go"
+- "**/*_test.go"
+- "website/"

.github/workflows/documentation.yml

@@ -0,0 +1,66 @@
+name: documentation
+
+on:
+  pull_request:
+    branches: [master]
+  push:
+    branches: [master]
+
+jobs:
+  build-docs:
+    if: github.event_name != 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Test Build
+        run: |
+          cd website
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run build
+  publish-docs:
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Add key to allow access to repository
+        env:
+          SSH_AUTH_SOCK: /tmp/ssh_agent.sock
+        run: |
+          mkdir -p ~/.ssh
+          ssh-keyscan github.com >> ~/.ssh/known_hosts
+          echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa
+          chmod 600 ~/.ssh/id_rsa
+          cat <<EOT >> ~/.ssh/config
+          Host github.com
+          HostName github.com
+          IdentityFile ~/.ssh/id_rsa
+          EOT
+      - name: Release to GitHub Pages
+        env:
+          USE_SSH: true
+          GIT_USER: git
+        run: |
+          cd website
+          git config --global user.email "actions@gihub.com"
+          git config --global user.name "gh-actions"
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          echo "Deploying web site... hang tight"
+          ./deploy.sh

.gitignore

@@ -120,3 +120,6 @@ stratos-frontend-prebuild.zip
 src/frontend/assets
 src/frontend/sass
 go-vendor-*.tgz
+
+website/build
+website/site-dist

CONTRIBUTING.md

@@ -1,12 +1,12 @@
-# Contributing to Stratos UI
+# Contributing to Stratos
 
-Stratos UI is an open project and welcomes contributions. These guidelines are provided to help you understand how the project works and to make contributing smooth and fun for everybody involved.
+Stratos is an open project and welcomes contributions. These guidelines are provided to help you understand how the project works and to make contributing smooth and fun for everybody involved.
 
 There are two main forms of contribution: reporting issues and performing code changes.
 
 ## Reporting Issues
 
-If you find a problem with Stratos UI, report it using [GitHub issues](https://github.com/cloudfoundry/stratos/issues/new).
+If you find a problem with Stratos, report it using [GitHub issues](https://github.com/cloudfoundry/stratos/issues/new).
 
 Before reporting a new issue, please take a moment to check whether it has already been reported
 [here](https://github.com/cloudfoundry/stratos/issues). If this is the case, please:
@@ -29,7 +29,7 @@ This information will help to determine the cause and prepare a fix as fast as p
 ## Code Changes
 
 Code contributions come in various forms and sizes, from simple bug fixes to implementation
-of new features. Before making any non-trivial change, get in touch with the Stratos UI developers first. This can prevent wasted effort later.
+of new features. Before making any non-trivial change, get in touch with the Stratos developers first. This can prevent wasted effort later.
 
 To send your code change, use GitHub pull requests. The workflow is as follows:
 
@@ -43,7 +43,7 @@ To send your code change, use GitHub pull requests. The workflow is as follows:
 
   1. Publish the branch and create a pull request.
 
-  1. Stratos UI developers will review your change and possibly point out issues.
+  1. Stratos developers will review your change and possibly point out issues.
      Adapt the code under their guidance until all issues are resolved.
 
   1. Finally, the pull request will get merged or rejected.

README.md

@@ -44,7 +44,7 @@ Take a look at the [Feature Set](docs/features.md) for details on the feature se
 
 Get an [Overview](docs/overview.md) of Stratos, its components and the different ways in which it can be deployed.
 
-Take a look at the [Development Roadmap](docs/roadmap.md) to see where we are heading. We update our status page each week to summarize what we are working on - see the [Status Page](docs/status_updates.md).
+Take a look at the [Development Roadmap](docs/roadmap.md) to see where we are heading.
 
 Browse through features and issues in the project's [issues](https://github.com/cloudfoundry/stratos/issues) page.