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
Landing Page WIP
  • Loading branch information
nwmac committed Jul 20, 2020
commit d26b948b8902bf994f3d82fad45915f4ad8bb3a2
63 changes: 63 additions & 0 deletions .github/documentation.yml
Original file line number Diff line number Diff line change
@@ -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
76 changes: 0 additions & 76 deletions index.yaml

This file was deleted.

20 changes: 12 additions & 8 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 0 additions & 11 deletions website/blog/2019-05-28-hola.md

This file was deleted.

17 changes: 0 additions & 17 deletions website/blog/2019-05-29-hello-world.md

This file was deleted.

13 changes: 0 additions & 13 deletions website/blog/2019-05-30-welcome.md

This file was deleted.

1 change: 0 additions & 1 deletion website/docs/old-index.html

This file was deleted.

7 changes: 7 additions & 0 deletions website/docs/talks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
id: talks
title: Talks and Presentations
sidebar_label: Talks
---

Coming soon
51 changes: 19 additions & 32 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -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',
Expand All @@ -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/',
},
],
Expand All @@ -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: [
Expand All @@ -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'),
},
Expand Down
Loading