Landing Page WIP

cloudfoundry · Jul 20, 2020 · d26b948 · d26b948
1 parent 45cd11c
commit d26b948
Show file tree

Hide file tree

Showing 22 changed files with 305 additions and 525 deletions.
diff --git a/.github/documentation.yml 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 <<EOT >> ~/.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
diff --git 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=<Your GitHub username> USE_SSH=true yarn deploy
+$ GIT_USER=<Your GitHub username> 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
diff --git a/website/blog/2019-05-29-hello-world.md b/website/blog/2019-05-29-hello-world.md
diff --git a/website/blog/2019-05-30-welcome.md b/website/blog/2019-05-30-welcome.md
diff --git a/website/docs/old-index.html b/website/docs/old-index.html
diff --git a/website/docs/talks.md b/website/docs/talks.md
@@ -0,0 +1,7 @@
+---
+id: talks
+title: Talks and Presentations
+sidebar_label: Talks 
+---
+
+Coming soon
diff --git 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'),
         },