diff --git a/.github/documentation.yml b/.github/documentation.yml new file mode 100644 index 0000000000..6e616e5e6d --- /dev/null +++ b/.github/documentation.yml @@ -0,0 +1,63 @@ +name: documentation + +on: + pull_request: + branches: [master] + push: + branches: [master] + +jobs: + checks: + if: github.event_name != 'push' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-node@v1 + with: + node-version: '12.x' + - name: Test Build + run: | + if [ -e yarn.lock ]; then + yarn install --frozen-lockfile + elif [ -e package-lock.json ]; then + npm ci + else + npm i + fi + npm run build + gh-release: + if: github.event_name != 'pull_request' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-node@v1 + with: + node-version: '12.x' + - name: Add key to allow access to repository + env: + SSH_AUTH_SOCK: /tmp/ssh_agent.sock + run: | + mkdir -p ~/.ssh + ssh-keyscan github.com >> ~/.ssh/known_hosts + echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa + chmod 600 ~/.ssh/id_rsa + cat <> ~/.ssh/config + Host github.com + HostName github.com + IdentityFile ~/.ssh/id_rsa + EOT + - name: Release to GitHub Pages + env: + USE_SSH: true + GIT_USER: git + run: | + git config --global user.email "actions@gihub.com" + git config --global user.name "gh-actions" + if [ -e yarn.lock ]; then + yarn install --frozen-lockfile + elif [ -e package-lock.json ]; then + npm ci + else + npm i + fi + npx docusaurus deploy diff --git a/index.yaml b/index.yaml deleted file mode 100755 index 2d8ee50438..0000000000 --- a/index.yaml +++ /dev/null @@ -1,76 +0,0 @@ -apiVersion: v1 -entries: - console: - - apiVersion: v1 - created: 2018-01-09T11:48:55.233833731Z - description: A Helm chart for deploying Stratos UI Console - digest: 378df78adeebfad7d81b63a9f01afbb830c35cf948e3b662349e1d20a0972955 - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/1.0.0/console-helm-chart-1.0.0.tgz - version: 1.0.0 - - apiVersion: v1 - created: 2017-12-08T13:21:38.611521378Z - description: A Helm chart for deploying Stratos UI Console - digest: 8e8994171cf7ba37c4b37564c8efa07f1fd66dda347900b592ebfaae5407bf3d - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/0.9.9/console-helm-chart-0.9.9.tgz - version: 0.9.9 - - apiVersion: v1 - created: 2017-11-23T16:31:10.781104928Z - description: A Helm chart for deploying Stratos UI Console - digest: 97bdf40f53053815016e223d49082ba16984b9b5a0a5a2d237ef45bb42183ad8 - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/0.9.8/console-helm-chart-0.9.8.tgz - version: 0.9.8 - - apiVersion: v1 - created: 2017-11-09T11:58:41.085073375Z - description: A Helm chart for deploying Stratos UI Console - digest: 1a297cebb9bf8d34fe4d679203082fb89894d9b90583988fb0a1349a27dde920 - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/0.9.7/console-helm-chart-0.9.7.tgz - version: 0.9.7 - - apiVersion: v1 - created: 2017-11-01T11:57:35.330202636Z - description: A Helm chart for deploying Stratos UI Console - digest: 08611ec5de41a71567a033c4975752f31ca895b26316592a75d6dc93c2968e5f - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/0.9.6/console-helm-chart-0.9.6.tgz - version: 0.9.6 - - apiVersion: v1 - created: 2017-09-21T14:17:00.259268006+01:00 - description: A Helm chart for deploying Console - digest: c0aa7067eebd02cbf775f1adde1948ff679f3753f5d6bb7403798260ad8278d7 - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/0.9.5/console-helm-chart-0.9.5.tgz - version: 0.9.5 - - apiVersion: v1 - created: 2017-08-21T16:05:19.606723792Z - description: A Helm chart for deploying Console - digest: 488b5011edcc0b22a28f4e70e576351cc6b9f0f34198fb366cc53cddc197c9d1 - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/0.9.2/console-helm-chart-0.9.2.tgz - version: 0.9.2 - - apiVersion: v1 - created: 2017-08-01T10:54:22.706325757Z - description: A Helm chart for deploying Console - digest: 5c7c2769771d7648647ed33a9e7c326c95cf550cb165aa3144dc8f8062dc66bb - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/0.9.1/console-helm-chart-0.9.1.tgz - version: 0.9.1 - - apiVersion: v1 - created: 2017-07-27T13:08:56.409964314Z - description: A Helm chart for deploying Console - digest: e05d4dd12d3e518ce8d123480196008815988dc59fa3653ad4593042e92cc36b - name: console - urls: - - https://github.com/cloudfoundry-incubator/stratos/releases/download/0.9.0/console-helm-chart-0.9.0.tgz - version: 0.9.0 -generated: 2018-01-09T11:48:55.232685995Z diff --git a/website/README.md b/website/README.md index ee0ccc9d18..684b2ea124 100644 --- a/website/README.md +++ b/website/README.md @@ -1,33 +1,37 @@ -# Website +# Stratos Website This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. -### Installation +> Run the commands below in the `website` folder. + +### Installing Dependencies ``` -$ yarn +$ npm ``` ### Local Development ``` -$ yarn start +$ npm 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. +> Note this command will open a web browser on the locally served site (http://localhost:3000) + ### Build ``` -$ yarn build +$ npm build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. ### Deployment +We use GitHub pages - this command is a convenient way to build the website and push to the `gh-pages` branch. + ``` -$ GIT_USER= USE_SSH=true yarn deploy +$ GIT_USER= USE_SSH=true npm 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. diff --git a/website/blog/2019-05-28-hola.md b/website/blog/2019-05-28-hola.md deleted file mode 100644 index 5552da124f..0000000000 --- a/website/blog/2019-05-28-hola.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -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 diff --git a/website/blog/2019-05-29-hello-world.md b/website/blog/2019-05-29-hello-world.md deleted file mode 100644 index 3b33193938..0000000000 --- a/website/blog/2019-05-29-hello-world.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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/). - - - -This is a test post. - -A whole bunch of other information. diff --git a/website/blog/2019-05-30-welcome.md b/website/blog/2019-05-30-welcome.md deleted file mode 100644 index 3b5affedce..0000000000 --- a/website/blog/2019-05-30-welcome.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -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! diff --git a/website/docs/old-index.html b/website/docs/old-index.html deleted file mode 100644 index a6bdc1e312..0000000000 --- a/website/docs/old-index.html +++ /dev/null @@ -1 +0,0 @@ -

Hello GH Pages

diff --git a/website/docs/talks.md b/website/docs/talks.md new file mode 100644 index 0000000000..11be680b02 --- /dev/null +++ b/website/docs/talks.md @@ -0,0 +1,7 @@ +--- +id: talks +title: Talks and Presentations +sidebar_label: Talks +--- + +Coming soon \ No newline at end of file diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index b07cd3461e..aeb2441df0 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -1,26 +1,26 @@ module.exports = { - title: 'Stratos', - tagline: 'Getting started with Stratos development', + title: 'STRATOS', + tagline: 'A Rich Open-Source UI for Cloud Foundry and Kubernetes', url: 'https://stratos.app', baseUrl: '/', favicon: 'img/favicon.ico', - organizationName: 'cloudfoundry', // Usually your GitHub org/user name. - projectName: 'stratos', // Usually your repo name. + organizationName: 'cloudfoundry', + projectName: 'stratos', themeConfig: { navbar: { - title: 'Stratos', + title: 'STRATOS', logo: { - alt: 'My Site Logo', - src: 'img/logo.svg', + alt: 'Stratos', + src: 'img/logo.png', }, links: [ { to: 'docs/', activeBasePath: 'docs', label: 'Docs', - position: 'left', + position: 'right', }, - {to: 'blog', label: 'Blog', position: 'left'}, + // {to: 'blog', label: 'Blog', position: 'left'}, { href: 'https://github.com/cloudfoundry/stratos', label: 'GitHub', @@ -35,11 +35,11 @@ module.exports = { title: 'Docs', items: [ { - label: 'Style Guide', + label: 'Getting Started', to: 'docs/', }, { - label: 'Second Doc', + label: 'Deploying Stratos', to: 'docs/doc2/', }, ], @@ -48,34 +48,27 @@ module.exports = { title: 'Community', items: [ { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', - }, - { - label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', + label: 'Slack', + href: 'https://cloudfoundry.slack.com/?redir=%2Fmessages%2Fstratos', }, { - label: 'Twitter', - href: 'https://twitter.com/docusaurus', + label: 'GitHub', + href: 'https://github.com/cloudfoundry/stratos', }, ], }, + { title: 'More', items: [ { - label: 'Blog', - to: 'blog', - }, - { - label: 'GitHub', - href: 'https://github.com/cloudfoundry/stratos', + label: 'Presentations and Talks', + to: 'docs/talks', }, ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} Cloud Foundry Foundation`, }, }, presets: [ @@ -90,12 +83,6 @@ module.exports = { editUrl: 'https://github.com/cloudfoundry/stratos/edit/master/website/', }, - blog: { - showReadingTime: true, - // Please change this to your repo. - editUrl: - 'https://github.com/cloudfoundry/stratos/edit/master/website/blog/', - }, theme: { customCss: require.resolve('./src/css/custom.css'), }, diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 74ba0f27f3..8e93764abc 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -7,14 +7,15 @@ /* You can override the default Infima variables here. */ :root { - --ifm-color-primary: #25c2a0; - --ifm-color-primary-dark: rgb(33, 175, 144); - --ifm-color-primary-darker: rgb(31, 165, 136); - --ifm-color-primary-darkest: rgb(26, 136, 112); - --ifm-color-primary-light: rgb(70, 203, 174); - --ifm-color-primary-lighter: rgb(102, 212, 189); - --ifm-color-primary-lightest: rgb(146, 224, 208); + --ifm-color-primary: #2196f3; + --ifm-color-primary-dark: #0d89ec; + --ifm-color-primary-darker: #0c81df; + --ifm-color-primary-darkest: #0a6bb7; + --ifm-color-primary-light: #3ba2f4; + --ifm-color-primary-lighter: #48a9f5; + --ifm-color-primary-lightest: #70bbf7; --ifm-code-font-size: 95%; + --ifm-navbar-link-color: #fff; } .docusaurus-highlight-code-line { @@ -23,3 +24,57 @@ margin: 0 calc(-1 * var(--ifm-pre-padding)); padding: 0 var(--ifm-pre-padding); } + +img.featureImage_src-pages- { + filter: grayscale(100%); + height: 100px; + width: 100px; +} + +img.cf-logo { + width: auto; +} + +.navbar__items.navbar__items--right .react-toggle { + display: none; +} + +.navbar { + /*background-color: #2196f3;*/ + background-color: #333; +} + +.navbar__brand:hover { + color: var(--ifm-link-hover-color); +} + +.main-wrapper .hero { + min-height: 480px; +} + +.main-wrapper .hero a.button.button--outline.button--secondary { + color: #fff; +} + +.main-wrapper .hero a.button.button--outline.button--secondary:hover { + color: #2196f3; +} + +.container { + text-align: left; +} + +.container .buttons_src-pages- { + justify-content: start; + padding-top: 20px; +} + +.hero__subtitle { + font-size: 36px; +} + +/* Reduce the text sizes */ + +#__docusaurus article h1 { + font-size: 32px; +} \ No newline at end of file diff --git a/website/src/pages/index.js b/website/src/pages/index.js index de04f5c846..6b13d57ca2 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -1,51 +1,85 @@ -import React from 'react'; -import clsx from 'clsx'; -import Layout from '@theme/Layout'; import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import useBaseUrl from '@docusaurus/useBaseUrl'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import Layout from '@theme/Layout'; +import clsx from 'clsx'; +import React from 'react'; + import styles from './styles.module.css'; const features = [ { title: <>Easy to Use, - imageUrl: 'img/undraw_docusaurus_mountain.svg', + imageUrl: 'img/easy.svg', + description: ( + <> + Stratos provides an easy to use web-based management user interface + designed to meet the needs of both administrators and developers. + + ), + }, + { + title: <>Cloud Foundry, + imageUrl: 'img/cloudfoundry.png', description: ( <> - Docusaurus was designed from the ground up to be easily installed and - used to get your website up and running quickly. + Stratos is the de-facto UI for Cloud Foundry, providing a rich management experience + for all you Cloud Foundry needs... and we're an offical Cloud Foundry project too! ), + cls: 'cf-logo' }, { - title: <>Focus on What Matters, - imageUrl: 'img/undraw_docusaurus_tree.svg', + title: <>Kubernetes, + imageUrl: 'img/kubernetes.svg', description: ( <> - Docusaurus lets you focus on your docs, and we'll do the chores. Go - ahead and move your docs into the docs directory. + Stratos sports a growing feature set for Kubernetes developers, extened its reach further + towards providing a single-pane-of-glass for your Cloud Native application development needs. ), }, { - title: <>Powered by React, - imageUrl: 'img/undraw_docusaurus_react.svg', + title: <>Extensible, + imageUrl: 'img/extend.svg', description: ( <> - Extend or customize your website layout by reusing React. Docusaurus can - be extended while reusing the same header and footer. + Stratos is built with extensibility in mind and we continue to expand and improve the + extensibility experience for developers ), }, + { + title: <>Open Source, + imageUrl: 'img/open-source.svg', + description: ( + <> + Stratos is Open Source with an Apache 2.0 License. Our codes lives on GitHub and we're a project within + the Cloud Foundry Foundation + + ), + }, + { + title: <>Easy to Deploy, + imageUrl: 'img/deploy.svg', + description: ( + <> + Stratos is easy to deploy and can be deployed as an application to Cloud Foundry, to Kubernetes + and run locally as a Docker container + + ), + }, + + ]; -function Feature({imageUrl, title, description}) { +function Feature({imageUrl, title, description, cls}) { const imgUrl = useBaseUrl(imageUrl); return (
{imgUrl && ( -
- {title} +
+ {title}
)}

{title}

@@ -59,8 +93,8 @@ function Home() { const {siteConfig = {}} = context; return ( + title={`Home`} + description="Stratos - Web-based Management Interface for Cloud Foundry and Kubernetes">

{siteConfig.title}

diff --git a/website/static/img/cloudfoundry.png b/website/static/img/cloudfoundry.png new file mode 100644 index 0000000000..0c81f62f51 Binary files /dev/null and b/website/static/img/cloudfoundry.png differ diff --git a/website/static/img/deploy.svg b/website/static/img/deploy.svg new file mode 100644 index 0000000000..097f164ef5 --- /dev/null +++ b/website/static/img/deploy.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/website/static/img/easy.svg b/website/static/img/easy.svg new file mode 100644 index 0000000000..1e32c1c49d --- /dev/null +++ b/website/static/img/easy.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/website/static/img/extend.svg b/website/static/img/extend.svg new file mode 100644 index 0000000000..3c4cbcf5ee --- /dev/null +++ b/website/static/img/extend.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/website/static/img/favicon.ico b/website/static/img/favicon.ico index c01d54bcd3..21f49bc43b 100644 Binary files a/website/static/img/favicon.ico and b/website/static/img/favicon.ico differ diff --git a/website/static/img/kubernetes.svg b/website/static/img/kubernetes.svg new file mode 100644 index 0000000000..bd6b1464fe --- /dev/null +++ b/website/static/img/kubernetes.svg @@ -0,0 +1,84 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + \ No newline at end of file diff --git a/website/static/img/logo.png b/website/static/img/logo.png new file mode 100644 index 0000000000..03d4990b89 Binary files /dev/null and b/website/static/img/logo.png differ diff --git a/website/static/img/open-source.svg b/website/static/img/open-source.svg new file mode 100644 index 0000000000..c40cc14486 --- /dev/null +++ b/website/static/img/open-source.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/website/static/img/undraw_docusaurus_mountain.svg b/website/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index 431cef2f7f..0000000000 --- a/website/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website/static/img/undraw_docusaurus_react.svg b/website/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index e417050433..0000000000 --- a/website/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website/static/img/undraw_docusaurus_tree.svg b/website/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index a05cc03dda..0000000000 --- a/website/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1 +0,0 @@ -docu_tree \ No newline at end of file