diff --git a/README.md b/README.md index a234c26d99..ac285a9c41 100644 --- 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 -Browserstack +Browserstack ## License diff --git a/website/docs/extensions/v4-migration.md b/website/docs/extensions/v4-migration.md index 9ec035b6b6..1317327c26 100644 --- 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 index 653818524c..f9706d79a5 100644 --- 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.