Update base README, point to website (#4488)

* 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 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>
cloudfoundry · Aug 7, 2020 · b713c78 · b713c78
1 parent 50617f7
commit b713c78
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -9,64 +9,25 @@
 
 Stratos is an Open Source Web-based UI (Console) for managing Cloud Foundry. It allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks.
 
-If you are looking for a version of Stratos, you can find ..
-- V1 in the [v1-master](https://github.com/cloudfoundry/stratos/tree/v1-master) branch.
-- V2 in the [v2-master](https://github.com/cloudfoundry/stratos/tree/v2-master) branch.
+![Stratos Application view](website/static/images/screenshots/app-summary.png)
 
-![Stratos Application view](docs/images/screenshots/app-summary.png)
+Please visit our new [documentation site](https://stratos.app/). There you can discover
 
-## Quick Start
+1. Our [introduction](https://stratos.app/docs/), including quick start, contributing and troubleshooting guides.
+1. How to [deploy](https://stratos.app/docs/deploy/overview) Stratos in a number of environments.
+    1. [Cloud Foundry](https://stratos.app/docs/deploy/cloud-foundry/cloud-foundry), as an application.
+    1. [Kubernetes](https://stratos.app/docs/deploy/kubernetes), using a Helm chart.
+    1. [Docker](https://stratos.app/docs/deploy/all-in-one), as a single container deploying all components.
+1. Configuring advanced features such a [Single Sign On](https://stratos.app/docs/advanced/sso) and Cloud Foundry '[invite to org](https://stratos.app/docs/advanced/invite-user-guide)'.
+1. Guides for [developers](https://stratos.app/docs/developer/introduction).
+1. How to [extend](https://stratos.app/docs/extensions/introduction) Stratos [functionality](https://stratos.app/docs/extensions/frontend) and apply a custom [theme](https://stratos.app/docs/extensions/theming).
 
-To get started quickly, we recommend following the steps to deploy the Stratos Console as a Cloud Foundry Application - see [here](deploy/cloud-foundry).
-
-If you have [docker](https://www.docker.com/community-edition) installed, you can quickly deploy Stratos using the all-in-one container:
-```
-$ docker run -p 4443:443 splatform/stratos:latest 
-```
-
-Once that has finished, you can then access Stratos by visiting https://localhost:4443.
-
-## Deploying Stratos
-
-Stratos can be deployed in the following environments:
-
-1. Cloud Foundry, as an application. See [guide](deploy/cloud-foundry)
-2. Kubernetes, using a Helm chart. See [guide](deploy/kubernetes)
-3. Docker, single container deploying all components. See [guide](deploy/all-in-one)
-
-## Troubleshooting
-
-Please see our [Troubleshooting](docs/troubleshooting) page.
-
-## Further Reading
-
-Take a look at the [Feature Set](docs/features.md) for details on the feature set that Stratos provides.
-
-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.
-
-Browse through features and issues in the project's [issues](https://github.com/cloudfoundry/stratos/issues) page.
-
-What kind of code is in Stratos? We've integrated [Code Climate](https://codeclimate.com) for some code quality and maintainability metrics. Take a stroll around the [project page](https://codeclimate.com/github/cloudfoundry/stratos)
-
-## Contributing
-
-We very much welcome developers who would like to get involved and contribute to the development of the Stratos project. Please refer to the [Contributing guide](CONTRIBUTING.md) for more information.
-
-For information to help getting started with development, please read the [Developer's Guide](docs/developers-guide.md).
-
-## Support and feedback
-
-We have a channel (#stratos) on the Cloud Foundy Slack where you can ask questions, get support or give us feedback. We'd love to hear from you if you are using Stratos.
-
-You can join the Cloud Foundry Slack here - https://slack.cloudfoundry.org/  - and then join the #stratos channel.
 
 ## Acknowledgements
 
 Tested with Browserstack
 
-<a href="https://www.browserstack.com"><img width="240px" src="docs/images/Browserstack-logo.svg" alt="Browserstack"></a>
+<a href="https://www.browserstack.com"><img width="240px" src="website/static/images/Browserstack-logo.svg" alt="Browserstack"></a>
 
 ## License
 

diff --git a/website/docs/extensions/v4-migration.md b/website/docs/extensions/v4-migration.md
@@ -43,4 +43,4 @@ To aid in migrating we've provided these instructions.
 ## Further Guidance
 Our ACME demo (`src/frontend/packages/example-extensions` and `src/frontend/packages/example-theme`) and SUSE repo ([theme](https://github.com/SUSE/stratos/tree/master/src/frontend/packages/suse-theme) and [extensions](https://github.com/SUSE/stratos/tree/master/src/frontend/packages/suse-extensions)) have both been updated and are fully compatible with the 4.0 changes. Both are a good source for examples.
 
-If there any questions or issues please reach out to us either on out Github [repo](https://github.com/cloudfoundry/stratos) or Slack room [#stratos](https://cloudfoundry.slack.com/?redir=%2Fmessages%2Fstratos).
+If there any questions or issues please reach out to us either on our Github [repo](https://github.com/cloudfoundry/stratos) or Slack room [#stratos](https://cloudfoundry.slack.com/?redir=%2Fmessages%2Fstratos).
diff --git a/website/docs/introduction.md b/website/docs/introduction.md
@@ -1,12 +1,12 @@
 ---
 id: introduction
-title: STRATOS
+title: Introduction
 sidebar_label: Introduction 
 ---
 
 Stratos is an Open Source Web-based UI for Cloud Foundry and Kubernetes.
 
-> Note: The Kubernetes additions to Stratos are currently maintained by SUSE and we are in the process of upstreaming these to the cloudfoundry GitHub repository and making them a standard part of the Stratos build and install.
+> Note: The Kubernetes additions to Stratos are currently maintained by SUSE and we are investigating the process of upstreaming these to the cloudfoundry GitHub repository. These would then become a standard part of Stratos build and install.
 
 For Cloud Foundry, it allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks.