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

INT-3729 - Stratos - Website: Update Docusaurus to nearest stable #111

Merged
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
15 changes: 15 additions & 0 deletions website/build-versions.sh
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,21 @@ function createVersionedDocs() (
label=$3

mkdir -p $currentWebsite/versioned_docs

# Workaround for broken links in versions 4.4.0 and before
printf '%s\n%s\n' "$target_version" "$version" | sort -V | head -n1
if [[ $? -eq 0 ]]; then
logInner "Version is 4.4.0 or less, applying workaround for broken links"
gnu_sed=sed
if [[ "$(uname)" == "Darwin" ]]; then
gnu_sed=gsed
fi
echo $gnu_sed
find $checkedOutRepo/website/versioned_docs/version-$label -type f -name "*.md" -exec ${gnu_sed} -i 's/cloud-foundry\/cloud-foundry/cloud-foundry\/cloud-foundry.md/g' {} \;
find $checkedOutRepo/website/versioned_docs/version-$label -type f -name "*.md" -exec ${gnu_sed} -i 's/](cloud-foundry)/(cloud-foundry.md)/g' {} \;
fi
# End of workaround

cp -r $checkedOutRepo/website/versioned_docs/version-$label $currentWebsite/versioned_docs
)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/deploy/cloud-foundry/db-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Associate a Cloud Foundry database service
sidebar_label: Database service bindings
---

As described in the standard `cf push` instructions [here](cloud-foundry) Stratos, when deployed via `cf push`,
As described in the standard `cf push` instructions [here](cloud-foundry.md) 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/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_label: Overview

Stratos can be deployed in the following environments:

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

Expand All @@ -20,7 +20,7 @@ Not all features are enabled in every environment - the Kubernetes deployment su

In this case, Stratos is deployed in a manner optimized for the management of a single Cloud Foundry instance.

For more information see the [guide](cloud-foundry/cloud-foundry).
For more information see the [guide](cloud-foundry/cloud-foundry.md).

### Deployed in Kubernetes

Expand Down
2 changes: 1 addition & 1 deletion website/docs/endpoints/cf/invite-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,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/cloud-foundry) 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/cloud-foundry.md) have been followed, you will not follow these steps for the default CF.

## Configuration for CF Push

Expand Down
5 changes: 3 additions & 2 deletions website/docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: introduction
title: Introduction
slug: /
sidebar_label: Introduction
---

Expand All @@ -14,7 +15,7 @@ For Kubernetes, it provides Developers with views of their Kubernetes resources,

## Quick Start

To get started quickly, we recommend following the steps to deploy the Stratos Console as a Cloud Foundry Application - see [here](deploy/cloud-foundry/cloud-foundry).
To get started quickly, we recommend following the steps to deploy the Stratos Console as a Cloud Foundry Application - see [here](deploy/cloud-foundry).

If you have [docker](https://www.docker.com/community-edition) installed, you can quickly deploy Stratos using the all-in-one container:

Expand All @@ -28,7 +29,7 @@ Once that has finished, you can then access Stratos by visiting https://localhos

Stratos can be deployed in the following environments:

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

Expand Down
17 changes: 4 additions & 13 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ module.exports = {
baseUrl: '/',
favicon: 'img/favicon.ico',
organizationName: 'cloudfoundry',
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
projectName: 'stratos',
themeConfig: {
navbar: {
Expand All @@ -19,7 +21,7 @@ module.exports = {
nextVersionLabel: 'Latest',
},
{
to: 'docs/',
to: 'docs/introduction',
activeBasePath: 'docs',
label: 'Docs',
position: 'right',
Expand All @@ -35,7 +37,7 @@ module.exports = {
title: 'Docs',
items: [{
label: 'Getting Started',
to: 'docs/',
to: 'docs/introduction',
},
{
label: 'Deploying Stratos',
Expand Down Expand Up @@ -70,16 +72,6 @@ module.exports = {
defaultMode: 'light',
disableSwitch: false,
respectPrefersColorScheme: true,
switchConfig: {
darkIcon: '🌙',
darkIconStyle: {
marginLeft: '2px',
},
lightIcon: '☀️',
lightIconStyle: {
marginLeft: '1px',
},
},
},
},
presets: [
Expand All @@ -88,7 +80,6 @@ module.exports = {
{
docs: {
// It is recommended to set document id as docs home page (`docs/` path).
homePageId: 'introduction',
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl: 'https://github.com/cloudfoundry/stratos/edit/master/website/',
Expand Down
Loading
Loading