Skip to content
This repository has been archived by the owner on Jan 24, 2023. It is now read-only.

Commit

Permalink
Fixes #4335: Create Stratos static web site with better documentation
Browse files Browse the repository at this point in the history
structure using docusaurus. Initial commit.
  • Loading branch information
vvaradhan committed Jul 13, 2020
1 parent eb211ce commit 2989e8b
Show file tree
Hide file tree
Showing 56 changed files with 14,148 additions and 61 deletions.
20 changes: 20 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
33 changes: 33 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

```
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions website/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
11 changes: 11 additions & 0 deletions website/blog/2019-05-28-hola.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: hola
title: Hola
author: Gao Wei
author_title: Docusaurus Core Team
author_url: https://github.com/wgao19
author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4
tags: [hola, docusaurus]
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17 changes: 17 additions & 0 deletions website/blog/2019-05-29-hello-world.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
id: hello-world
title: Hello
author: Endilie Yacop Sucipto
author_title: Maintainer of Docusaurus
author_url: https://github.com/endiliey
author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
tags: [hello, docusaurus]
---

Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).

<!--truncate-->

This is a test post.

A whole bunch of other information.
13 changes: 13 additions & 0 deletions website/blog/2019-05-30-welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: welcome
title: Welcome
author: Yangshun Tay
author_title: Front End Engineer @ Facebook
author_url: https://github.com/yangshun
author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4
tags: [facebook, hello, docusaurus]
---

Blog features are powered by the blog plugin. Simply add files to the `blog` directory. It supports tags as well!

Delete the whole directory if you don't want the blog features. As simple as that!
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 5 additions & 1 deletion docs/access.md → website/docs/deploy/access.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Accessing Stratos
---
id: access
title: Accessing Stratos
sidebar_label: Accessing Stratos
---

Depending on the deployment mode, you may require access to an UAA. Stratos also has the option to configure a local user account which removes the need for a UAA in non-Cloud Foundry deployments.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Deploying with the All-In-One Docker Container
---
id: all-in-one
title: Deploying with the All-In-One Docker Container
sidebar_label: Deploy as Docker Container
---

The all-in-one container sets up the Stratos components in a single container.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# Deploying as a Cloud Foundry Application
---
id: cloud-foundry
title: Deploying as a Cloud Foundry Application
sidebar_label: Deploy on Cloud Foundry
---

## Deployment Steps

The quickest way to install Stratos is to deploy it as a Cloud Foundry application.

You can do it in two ways:

1. [Deploy Stratos from source](#Deploy-Stratos-from-source)
1. [Deploy Stratos from docker image](#Deploy-Stratos-from-docker-image)
1. [Deploy Stratos from source](#deploy-stratos-from-source)
1. [Deploy Stratos from docker image](#deploy-stratos-from-docker-image)

You will then be able to open a web browser and navigate to the console URL:

`https://console.<DOMAIN>`

Where `<DOMAIN>` is the default domain configured for your Cloud Foundry cluster.

To login use the following credentials detailed [here](../../docs/access.md).
To login use the following credentials detailed [here](access.md).

If you run into issues, please refer to the [Troubleshooting Guide](#troubleshooting) below.

> The console will pre-configure the host Cloud Foundry endpoint. No other CF instance should be registered unless the instructions in
the section [Associate Cloud Foundry database service](#Associate-Cloud-Foundry-database-service) are followed.
the section [Associate Cloud Foundry database service](#associate-cloud-foundry-database-service) are followed.
All other deployment methods (helm, docker all-in-one, etc) allow the registration of multiple CF instances by default.

Note:
Expand Down Expand Up @@ -61,7 +65,7 @@ applications:

This will set the the UAA client and UAA secret used to invite users for the default CF only.

See the [invite users guide](../../docs/invite-user-guide.md) for more information about user invites in Stratos.
See the [invite users guide](../guides/admin/invite-user-guide) for more information about user invites in Stratos.

#### Use of the Default Embedded SQLite Database

Expand All @@ -80,7 +84,7 @@ git checkout tags/stable -b stable
cf push
```

If the cf push exceeds the time allowed see the instructions [here](#Pre-building-the-UI)
If the cf push exceeds the time allowed see the instructions [here](#pre-building-the-ui)

#### Pre-building the UI

Expand Down Expand Up @@ -123,7 +127,7 @@ cf push console -o splatform/stratos:stable -m 128M -k 384M
Alternatively cf push using a manifest

- download [manifest-docker.yml](../../manifest-docker.yml) or create your own manifest file:
- download [manifest-docker.yml](../../../manifest-docker.yml) or create your own manifest file:
```yaml
applications:
- name: console
Expand Down Expand Up @@ -155,7 +159,7 @@ applications:

When SSO Login is enabled, Stratos will also auto-connect to the Cloud Foundry it is deployed in using the token obtained during the SSO Login flow.

For more information - see [Single-Sign On](../../docs/sso.md).
For more information - see [Single-Sign On](../guides/admin/sso).

## Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Deploying in Kubernetes
---
id: kubernetes
title: Deploying in Kubernetes
sidebar_label: Deploy on Kubernetes
---

Stratos can be deployed to Kubernetes using [Helm](https://github.com/kubernetes/helm).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Invite User Guide
---
id: invite-user-guide
title: Invite User Guide
sidebar_label: Invite Users
---

Stratos provides a way for Cloud Foundry administrators and organization managers to invite users to an organization or space.

Expand Down
6 changes: 5 additions & 1 deletion docs/sso.md → website/docs/guides/admin/sso.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Single Sign On
---
id: sso
title: Single Sign On
sidebar_label: Configure Single Sign On
---

By default, Stratos will authenticate against a UAA using username and password, for both logging into Stratos and when connecting Cloud Foundry endpoints.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Contributing to Stratos UI
---
id: contributing
title: Contributing to Stratos UI
sidebar_label: Contributing to Stratos UI
---

## Reporting issues

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
id: issue_template
title: Issue report template
sidebar_label: Issue report template
---

<!--- For bugs and general issues -->
### Stratos Version
<!-- What version of Stratos does this related to? -->
<!-- Version information can be seen in the `About` page reached via the User Icon top right -->
<!-- If directly using code which branch, commit, etc did the source come from, what repository was it cloned from? -->
### Frontend Deployment type
<!--- Where is the frontend deployed? -->
<!--- Put an 'x' in one of the boxes below. -->
Expand All @@ -25,11 +27,11 @@

### Actual behaviour

### Steps to reproduce the behaviour
### Steps to reproduce the behavior

### Log output covering before error and any error statements
```
Insert your log here
Insert log hereCopy
```


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
id: pull_request_template
title: Pull request template for contributions to Stratos
sidebar_label: PR template
---

<!--- Provide a general summary of your changes in the Title above -->

## Description
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Customizing Stratos
---
id: customizing
title: Customizing Stratos
sidebar_label: Customizing Stratos
---

Stratos provides a mechanism for customization - the following customizations are currently supported:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# E2E Tests
---
id: developers-guide-e2e-tests
title: E2E Tests
sidebar_label: E2E Tests
---

The Stratos E2E test suite exercises the Stratos UI using protractor/web-driver.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Stratos Tech + Developer Environment
---
id: developers-guide-env-tech
title: Stratos Tech + Developer Environment
sidebar_label: Dev Environment
---

## ES6

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@

# Developing the Stratos Console
---
id: developers-guide
title: Developing the Stratos Console
sidebar_label: Stratos Development
---

1. [Introduction](#introduction)
1. [Frontend Development](#frontend-development)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Backend Plugins
---
id: backend-plugins
title: Backend Plugins
sidebar_label: Backend
---

This document provides a brief outline for extending the Stratos backend (Jetstream).

Expand Down
Loading

0 comments on commit 2989e8b

Please sign in to comment.