Skip to content

Commit

Permalink
1) Re-organize some more existing doc files.
Browse files Browse the repository at this point in the history 
2) Re-organize links in the doc file to refer to the new document
   hierarchy.
  • Loading branch information
@vvaradhan
vvaradhan committed Jul 13, 2020
1 parent 2989e8b commit 45cd11c
Show file tree
Hide file tree
Showing 12 changed files with 224 additions and 27 deletions.
174 changes: 174 additions & 0 deletions website/docs/LICENSE.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
6 changes: 5 additions & 1 deletion deploy/README.md → website/docs/deploy/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Deploying Stratos
---
id: deploy-readme
title: Deploying Stratos
sidebar_label: Overview
---

Stratos can be deployed in the following environments:

Expand Down
4 changes: 2 additions & 2 deletions website/docs/deploy/cloud-foundry.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ See the [invite users guide](../guides/admin/invite-user-guide) for more informa
#### Use of the Default Embedded SQLite Database

We do not recommend deploying Stratos to a production environment using the default embedded SQLite Database. Instead we recommend creating
and binding a database service instance to Stratos - for more information see [here](db-migration/README.md).
and binding a database service instance to Stratos - for more information see [here](db-migration).

### Deploy Stratos from source

Expand Down Expand Up @@ -143,7 +143,7 @@ Alternatively cf push using a manifest
```

## Associate Cloud Foundry database service
Follow instructions [here](db-migration/README.md).
Follow instructions [here](db-migration).

## Use SSO Login

Expand Down
8 changes: 6 additions & 2 deletions deploy/cloud-foundry/db-migration/README.md → ...docs/deploy/cloud-foundry/db-migration.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Associate a Cloud Foundry database service
---
id: db-migration
title: Associate a Cloud Foundry database service
sidebar_label: Database service bindings
---

As described in the standard `cf push` instructions [here](../README.md) Stratos, when deployed via `cf push`,
As described in the standard `cf push` instructions [here](../deploy-readme) Stratos, when deployed via `cf push`,
does not contain any way to persist data over application restarts and db entries such as registered endpoints
and user tokens are lost. To resolve this a Cloud Foundry db service can be bound to to it. Run through
the steps below to implement.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/deploy/kubernetes.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: kubernetes
title: Deploying in Kubernetes
sidebar_label: Deploy on Kubernetes
sidebar_label: Overview
---

Stratos can be deployed to Kubernetes using [Helm](https://github.com/kubernetes/helm).
Expand All @@ -16,4 +16,4 @@ You will need to have both the `kubectl` and `helm` CLIs installed and available

The Stratos Helm chart contains a `README.md` file that contains installation instructions and configuration documentation.

This document is also available in our GitHub repository here: [README.md](https://github.com/cloudfoundry/stratos/blob/master/deploy/kubernetes/console/README.md).
This document is also available in [here](helm-installation).
6 changes: 5 additions & 1 deletion deploy/kubernetes/console/README.md → ...te/docs/deploy/kubernetes/installation.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Stratos
---
id: helm-installation
title: Stratos Installation
sidebar_label: Deploy using Helm
---

Stratos is an Open Source Web-based Management console 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
8 changes: 4 additions & 4 deletions website/docs/guides/admin/invite-user-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Alternatively, you can use an existing UAA Client, if one is already available w

Configuration depends on how you have deployed Stratos.

1. For cf push, see [Configuration for CF Push](#Configuration-for-CF-Push)
1. For Kubernetes with Helm, see: [Configuration for Helm Installation](#Configuration-for-Helm-Installation)
1. For cf push, see [Configuration for CF Push](#configuration-for-cf-push)
1. For Kubernetes with Helm, see: [Configuration for Helm Installation](#configuration-for-helm-installation)

## Enabling User Invite support in Stratos

Expand All @@ -60,7 +60,7 @@ This action must be performed by an Administrator in Stratos.
1) Use the `Configure` button in the `User Invitation Support` section.
1) Supply the uaa client id and secret and click `Configure`

> Note: If Stratos has been deployed via `cf push` and the steps under the `Pre-configure invite UAA client` header in the [CF deploy guide](../deploy/cloud-foundry/README.md) have been followed, you will not follow these steps for the default CF.
> Note: If Stratos has been deployed via `cf push` and the steps under the `Pre-configure invite UAA client` header in the [CF deploy guide](../../deploy/cloud-foundry) have been followed, you will not follow these steps for the default CF.
## Configuration for CF Push

Expand Down Expand Up @@ -146,7 +146,7 @@ When developing locally, we recommend using [mailcatcher](https://mailcatcher.me

To install mailcatcher via docker, use the following command: `docker run -d -p 1080:80 -p 1025:25 --name mail tophfr/mailcatcher`. Once mailcatcher is installed, continue to follow the instructions below.

SMTP server details can be set via rhe usual environment variable approach or, when running locally, in the `jetstream/config.properties` file (see Backend Development - Configuration in [developers-guide](./developers-guide.md)). The config settings, with example values, are as follows:
SMTP server details can be set via rhe usual environment variable approach or, when running locally, in the `jetstream/config.properties` file (see Backend Development - Configuration in [developers-guide](../developers/developers-guide)). The config settings, with example values, are as follows:

```
SMTP_FROM_ADDRESS=Stratos<test@test.com>
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/customization/customizing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ We currently expose the following extension points in the Stratos UI:

We use Decorators to annotate components to indicate that they are Stratos extensions.

See [Extensions](extensions.md) for more detail and examples of front-end extensions.
See [Extensions](../extensions/frontend-extensions) for more detail and examples of front-end extensions.


### Changing the Initial Loading Indicator
Expand Down
4 changes: 2 additions & 2 deletions website/docs/guides/extensions/frontend-extensions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Next, run the customization script (this is done automatically when you do an `n
npm run customize
```

You can now run Stratos locally to see the customizations - see the [Developer's Guide](developers-guide.md) for details.
You can now run Stratos locally to see the customizations - see the [Developer's Guide](../developers/developers-guide) for details.

For a walk-through of extending Stratos, see [Example: Adding a Custom Tab](#example:-adding-a-custom-tab).
For a walk-through of extending Stratos, see [Example: Adding a Custom Tab](#example-adding-a-custom-tab).

## Extension Points

Expand Down
12 changes: 6 additions & 6 deletions website/docs/introduction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,25 @@ Stratos can be deployed in the following environments:

## Troubleshooting

Please see our [Troubleshooting](docs/troubleshooting) page.
Please see our [Troubleshooting](guides/troubleshooting/troubleshooting) page.

## Further Reading

Take a look at the [Feature Set](docs/features.md) for details on the feature set that Stratos provides.
Take a look at the [Feature Set](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.
Get an [Overview](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](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](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.
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](guides/contribution/contributing.md) for more information.

For information to help getting started with development, please read the [Developer's Guide](docs/developers-guide.md).
For information to help getting started with development, please read the [Developer's Guide](guides/developers/developers-guide.md).

## Support and feedback

Expand Down
8 changes: 4 additions & 4 deletions website/docs/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ When a user interacts with the Console and API requests need to be made to a giv

Stratos UI can be deployed in a number of environments:

* Deployed in Cloud Foundry, as an application. See [guide](../deploy/cloud-foundry)
* Deployed in Kubernetes, using a Helm chart. See [guide](../deploy/kubernetes)
* Deployed in Docker, single container deploying all components. See [guide](../deploy/all-in-one)
* Deployed in Cloud Foundry, as an application. See [guide](deploy/cloud-foundry)
* Deployed in Kubernetes, using a Helm chart. See [guide](deploy/kubernetes)
* Deployed in Docker, single container deploying all components. See [guide](deploy/all-in-one)

There are differences between the deployments as follows:

Expand All @@ -51,7 +51,7 @@ In this case, the front-end web application static resources are served by the A

By defaut, a non-persistent SQLite database is used - by automatically registering the cloud foundry endpoint and connecting to it on login, all data stored in the database can be treated as ephimeral, since it will be re-created next time a user logs in. Cloud Foundry Session Affinity is used to ensure that when scaling up the Console Application to multiple instances, the user is also directed to the instance which will know about them and their endpoints (since each Application instance will have its own local SQLite store).

Alternatively, Stratos can be configured [with a persistent Cloud Foundry database service](deploy/cloud-foundry/db-migration/README.md), which enables features requiring persistence such as user favorites.
Alternatively, Stratos can be configured [with a persistent Cloud Foundry database service](deploy/cloud-foundry/db-migration), which enables features requiring persistence such as user favorites.

### Deployed in Kubernetes

Expand Down
Loading

0 comments on commit 45cd11c

Please sign in to comment.