Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update base README, point to website #4488

Merged
merged 44 commits into from
Aug 7, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
2989e8b
Fixes #4335: Create Stratos static web site with better documentation
vvaradhan Jul 13, 2020
45cd11c
1) Re-organize some more existing doc files.
vvaradhan Jul 13, 2020
d26b948
Landing Page WIP
nwmac Jul 20, 2020
7181236
Documentation tweaks
nwmac Jul 20, 2020
5b394a0
Use better action names
nwmac Jul 20, 2020
bcb5529
More visual improvements to landing page
nwmac Jul 20, 2020
5741bf9
More doc and landing page improvements
nwmac Jul 22, 2020
7383f69
Remove publish workflow for now
nwmac Jul 22, 2020
208baa0
Typo fix
nwmac Jul 22, 2020
fff9924
Moer documentation improvements
nwmac Jul 22, 2020
2bbb535
Remove extra title from helm doc
nwmac Jul 22, 2020
388245c
Fix script when used from npm
nwmac Jul 22, 2020
796729c
Improve layout on mobile devices
nwmac Jul 22, 2020
17aaf09
More documentation improvements
nwmac Jul 22, 2020
3f093d4
Fix typo
nwmac Jul 22, 2020
fd17825
Merge downstream (#4441)
richard-cox Jul 20, 2020
dd34fc5
Show all favorites for an endpoint favorite if there is only one (#4440)
nwmac Jul 20, 2020
244f9fe
Merge downstream - JSON Viewer with dark mode & Header Fixes (#4444)
richard-cox Jul 20, 2020
9c94d60
Fix issues with tests not running if build upload fails (#4453)
nwmac Jul 21, 2020
56f0389
Improve autoscaler e2e logging (#4456)
richard-cox Jul 21, 2020
a4e14c1
Fix check-e2e-pr.sh for pr's from other repos (#4459)
richard-cox Jul 21, 2020
560b524
Convert Client Secret Input Fields to `password` (#4455)
richard-cox Jul 21, 2020
17f4f11
Insecure tlsv10 and tlsv11 ciphers in Stratos UI, bsc#1173295 (#411) …
richard-cox Jul 21, 2020
de9fb7a
[Security] Bump codecov from 3.7.0 to 3.7.1 (#4457)
dependabot-preview[bot] Jul 21, 2020
85290ad
Bump lodash from 4.17.15 to 4.17.19 (#4452)
dependabot[bot] Jul 21, 2020
e3ae282
Website update: Wed 22 Jul 2020 21:55:00 BST
nwmac Jul 22, 2020
99bd6ad
Website update: Wed 22 Jul 2020 21:56:45 BST
nwmac Jul 22, 2020
71bf0ad
Website update: Wed 22 Jul 2020 21:58:22 BST
nwmac Jul 22, 2020
43ffaf6
Remove dist
nwmac Jul 22, 2020
fa55ff2
FIx deploy script to remove old files
nwmac Jul 22, 2020
7147c81
Moer tidy ups
nwmac Jul 23, 2020
c3c9c73
Add CNAME file when publishing
nwmac Jul 23, 2020
67b08dc
Add talks doc
nwmac Jul 23, 2020
f659099
* Fix broken links due to reorganization of documents
vvaradhan Jul 24, 2020
b9bdeda
* Fix Getting Started broken link in page footer
vvaradhan Jul 24, 2020
fbd53ae
Only publish if there are website changes
nwmac Jul 24, 2020
ca1e052
Merge remote-tracking branch 'origin/master' into website
nwmac Jul 24, 2020
a47e5dd
Remove old doc
nwmac Jul 24, 2020
e4785a6
Publish website on merge
nwmac Jul 24, 2020
8b9dc27
Apply new theming process to acme example
richard-cox Jul 28, 2020
092bf5f
First pass at customization docs, most of themeing done
richard-cox Jul 28, 2020
993a137
Final pass at customization docs
richard-cox Jul 29, 2020
65f2127
Update base README, point to website
richard-cox Jul 31, 2020
a41bcd2
Merge remote-tracking branch 'origin/master' into root-readme-docs
richard-cox Aug 7, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update base README, point to website
  • Loading branch information
richard-cox committed Jul 31, 2020
commit 65f21275afc2b7ae0412710920a4371200a283a2
61 changes: 11 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. We update our status page each week to summarize what we are working on - see the [Status Page](docs/status_updates.md).

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

Expand Down
4 changes: 2 additions & 2 deletions website/docs/introduction.md
Original file line number Diff line number Diff line change
@@ -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 in the process of upstreaming these to the cloudfoundry GitHub repository. These will 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.

Expand Down