Skip to content

Commit

Permalink
Use .md links (pt. 1)
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Berendt <[email protected]>
  • Loading branch information
berendt committed Jun 20, 2024
1 parent 4310bfe commit b4379d7
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 27 deletions.
6 changes: 3 additions & 3 deletions docs/guides/deploy-guide/bootstrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ sidebar_position: 40

The prerequisite for bootstraping the nodes of a cluster the Manager node has to be
prepares. What a Manager node is and how to prepare it is documented in the
[Manager chapter of the Deploy Guide](./manager).
[Manager chapter of the Deploy Guide](./manager.md).

All the nodes must also have already been provisioned. How manual provisioning is done
is documented in the [Provisioning chapter of the Deploy Guide](./provisioning).
is documented in the [Provisioning chapter of the Deploy Guide](./provisioning.md).

:::

Before the nodes can be bootstrapped, they must all have already been provisioned.
The guide for this can be found in the section [Provisioning of bare-metal nodes](./provisioning).
The guide for this can be found in the section [Provisioning of bare-metal nodes](./provisioning.md).

The following steps are applied to bootstrap all nodes. After the completion of the bootstrap,
the nodes are already ready for use.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/deploy-guide/examples/testbed.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ sidebar_label: Testbed
# Testbed

This section has moved. You can now find the content in the
[Other Guides](../../other-guides) as
[Testbed Guide](../../other-guides/testbed).
[Other Guides](../../other-guides/index.md) as
[Testbed Guide](../../other-guides/testbed/).
12 changes: 6 additions & 6 deletions docs/guides/deploy-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ OSISM is deployed in a series of successive steps. The steps are documented in t

The prerequisite for the deployment of a cluster is a configuration repository.
What a configuration repository is and how it is created is described in the
[Configuration Guide](../configuration-guide/configuration-repository#creating-a-new-configuration-repository).
[Configuration Guide](../configuration-guide/configuration-repository.md#creating-a-new-configuration-repository).

:::

* Step 1: [Preparation of the seed node](./seed)
* Step 2: [Preparation of the manager node](./manager)
* Step 3: [Provisioning of the bare-metal nodes](./provisioning)
* Step 4: [Bootstrap of the bare-metal nodes](./bootstrap)
* Step 5: [Deployment of the services](./services)
* Step 1: [Preparation of the seed node](./seed.md)
* Step 2: [Preparation of the manager node](./manager.md)
* Step 3: [Provisioning of the bare-metal nodes](./provisioning.md)
* Step 4: [Bootstrap of the bare-metal nodes](./bootstrap.md)
* Step 5: [Deployment of the services](./services/index.md)
4 changes: 2 additions & 2 deletions docs/guides/deploy-guide/manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 20
:::info

The prerequisite for deploying the Manager node is a Seed node. What a Seed node is
and how to prepare it is documented in the [Seed chapter of the Deploy Guide](./seed).
and how to prepare it is documented in the [Seed chapter of the Deploy Guide](./seed.md).

:::

Expand Down Expand Up @@ -37,7 +37,7 @@ Requirements for the manager node:

Change into the `environments/manager` directory of the configuration repository
on the seed node. The deployment of the seed node itself is documented in the
[Deploy Guide for the seed node](../deploy-guide/seed).
[Deploy Guide for the seed node](../deploy-guide/seed.md).

```
cd environments/manager
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/deploy-guide/seed.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 10

The prerequisite for the deployment of a cluster is a configuration repository.
What a configuration repository is and how it is created is described in the
[Configuration Guide](../configuration-guide/configuration-repository#creating-a-new-configuration-repository).
[Configuration Guide](../configuration-guide/configuration-repository.md#creating-a-new-configuration-repository).

:::

Expand Down Expand Up @@ -38,8 +38,8 @@ previously created with Cookiecutter and the [osism/cfg-cookiecutter](https://gi
repository.

The creation of the configuration repository is covered in chapter
[Creation of a configuration repository](../configuration-guide/configuration-repository#creating-a-new-configuration-repository)
of the [Configuration Guide](../configuration-guide).
[Creation of a configuration repository](../configuration-guide/configuration-repository.md#creating-a-new-configuration-repository)
of the [Configuration Guide](../configuration-guide/index.md).

A configuration repository is stored on a Git server (e.g. GitHub, Gitlab, ...). The
configuration repository is individual for each environment and is therefore not provided
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/deploy-guide/services/ceph.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ open source projects, please refer to

Before starting the Ceph deployment, the configuration and preparation of the
OSD devices must be completed. The steps that are required for this can be found in the
[Ceph Configuration Guide](../../configuration-guide/ceph#osd-devices).
[Ceph Configuration Guide](../../configuration-guide/ceph.md#osd-devices).

:::

Expand Down Expand Up @@ -145,7 +145,7 @@ Step 3 is then performed **later after** the OpenStack Keystone service has been

:::

1. [Configure the RGW service](./../../configuration-guide/ceph#rgw-service)
1. [Configure the RGW service](./../../configuration-guide/ceph.md#rgw-service)

2. Apply role `ceph-rgws` to deploy the Ceph RGW services.

Expand Down
12 changes: 6 additions & 6 deletions docs/guides/deploy-guide/services/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ sidebar_position: 100

The prerequisite for depoying the services of a cluster is the bootstrap of
the nodes. How to bootstrap the nodes is documented in the
[Bootstrap chapter of the Deploy Guide](../bootstrap).
[Bootstrap chapter of the Deploy Guide](../bootstrap.md).

:::

When setting up a new cluster, the services are deployed in a specific order.

1. [Infrastructure](./infrastructure)
2. [Network](./network)
3. [Logging & Monitoring](./logging-monitoring)
4. [Ceph](./ceph)
5. [OpenStack](./openstack)
1. [Infrastructure](./infrastructure.md)
2. [Network](./network.md)
3. [Logging & Monitoring](./logging-monitoring.md)
4. [Ceph](./ceph.mdx)
5. [OpenStack](./openstack.md)
2 changes: 1 addition & 1 deletion docs/guides/deploy-guide/services/infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 10
# Infrastructure

Common issues with deploying infrastructure services required by OpenStack
are documented in the [OpenStack Troubleshooting Guide](../../troubleshooting-guide/openstack).
are documented in the [OpenStack Troubleshooting Guide](../../troubleshooting-guide/openstack.md).


1. Optional: In order to reduce the active observation time for the deployment of the components,
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/deploy-guide/services/logging-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 40
# Logging & Monitoring

Common issues with deploying logging & monitoring services provided by Kolla
are documented in the [OpenStack Troubleshooting Guide](../../troubleshooting-guide/openstack).
are documented in the [OpenStack Troubleshooting Guide](../../troubleshooting-guide/openstack.md).

1. OpenSearch

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/deploy-guide/services/openstack.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 60
# OpenStack

Common issues with deploying OpenStack services are documented in the
[OpenStack Troubleshooting Guide](../../troubleshooting-guide/openstack).
[OpenStack Troubleshooting Guide](../../troubleshooting-guide/openstack.md).

:::info

Expand Down

0 comments on commit b4379d7

Please sign in to comment.