Skip to content

Commit

Permalink
chore: Link to Markdown paths internally
Browse files Browse the repository at this point in the history
Newer versions of MkDocs rightfully flag links that point to relative
or absolute URL paths in the rendered tree as issues. Update those
links to pointers to their respective Markdown sources instead, so
that MkDocs can on its own figure out the correct links when rendering.
  • Loading branch information
fghaas committed Aug 14, 2023
1 parent 3cb828e commit b006c18
Show file tree
Hide file tree
Showing 38 changed files with 84 additions and 84 deletions.
6 changes: 3 additions & 3 deletions docs/background/disaster-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: What is the Disaster Recovery feature and why you want it
---
# Disaster recovery

When you [create a new server](../../howto/openstack/nova/new-server) in
When you [create a new server](../howto/openstack/nova/new-server.md) in
{{brand}} you will notice an option named **Disaster recovery**, which
is enabled by default.

Expand All @@ -24,7 +24,7 @@ background, and why you should consider enabling it.
The *Disaster Recovery* (DR) feature is available via the {{gui}} and
applies to servers and volumes that use our [Ceph](https://ceph.io/en/)
backend. That would be **all** servers but the ones of the `s`
[flavor](../../reference/flavors/#compute-tiers).
[flavor](../reference/flavors/index.md#compute-tiers).

## How it works

Expand All @@ -45,7 +45,7 @@ Provided snapshots are available, you can restore a server or a single
volume to any of those snapshots. For instance, you may discover that
due to faulty application logic or simply a bug, you are now
experiencing data corruption. Then, one of your options would be to [go
back in time](/howto/openstack/nova/restore-srv-to-snap) by restoring
back in time](../howto/openstack/nova/restore-srv-to-snap.md) by restoring
one of the available snapshots and keep going from there.

## Restoration time
Expand Down
26 changes: 13 additions & 13 deletions docs/background/gui-vs-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can do many tasks in {{brand}} via the
[{{gui}}](https://{{gui_domain}}) or via the OpenStack API, e.g., with
the help of the
[OpenStack CLI](../../howto/getting-started/enable-openstack-cli) tool.
[OpenStack CLI](../howto/getting-started/enable-openstack-cli.md) tool.
For some tasks, though, you *will need* the OpenStack API.

But when does it make sense to prefer a particular way of working?
Expand All @@ -13,19 +13,19 @@ What are the reasons, if any, for choosing one method over the other?

Ease of use is probably the main reason for choosing the {{gui}} over
the OpenStack API. Provided you have an [account in
{{brand}}](../../howto/getting-started/create-account), you can simply
{{brand}}](../howto/getting-started/create-account.md), you can simply
log in and then follow step-by-step guides to create entities such as
[networks](../../howto/openstack/neutron/new-network),
[servers](../../howto/openstack/nova/new-server), or even
[Kubernetes clusters](../../howto/openstack/magnum/new-k8s-cluster).
[networks](../howto/openstack/neutron/new-network.md),
[servers](../howto/openstack/nova/new-server.md), or even
[Kubernetes clusters](../howto/openstack/magnum/new-k8s-cluster.md).
You can just as easily perform administrative tasks like creating
[security
groups](../../howto/openstack/neutron/create-security-groups), setting
up [region-to-region VPN](../../howto/openstack/neutron/vpnaas)
groups](../howto/openstack/neutron/create-security-groups.md), setting
up [region-to-region VPN](../howto/openstack/neutron/vpnaas.md)
connections, [deleting
networks](../../howto/openstack/neutron/delete-network), modifying
[billing data](../../howto/account-billing/change-billing-data), or
[managing invoices](../../howto/account-billing/manage-invoices).
networks](../howto/openstack/neutron/delete-network.md), modifying
[billing data](../howto/account-billing/change-billing-data.md), or
[managing invoices](../howto/account-billing/manage-invoices.md).

All in all, there are many instances when the {{gui}} is all you want
and, at the same time, is more than enough for what you want.
Expand All @@ -45,11 +45,11 @@ via the OpenStack API, for there is no counterpart tool in the {{gui}}
toolbox.

For instance, whenever you need to
[move servers between regions](../../howto/openstack/nova/move-server-between-regions),
[move servers between regions](../howto/openstack/nova/move-server-between-regions.md),
then `openstack` is your only option. Another instance where you work
with the OpenStack API and various CLI tools, is when you have to
interact with the [S3 API](../../howto/object-storage/s3) or the
[Swift API](../../howto/object-storage/swift).
interact with the [S3 API](../howto/object-storage/s3/index.md) or the
[Swift API](../howto/object-storage/swift/index.md).

Even though the command syntax of `openstack` may sometimes look overly
complicated, the potential for scripting can speed up many operations
Expand Down
2 changes: 1 addition & 1 deletion docs/background/kubernetes/gardener/hibernation.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ Last but not least, the act of waking a cluster up may temporarily fail,
because while the cluster was hibernating, the tenant came close to its
volume, RAM, CPU, etc. quota, and attempting to re-instantiate the
worker nodes and re-activate the cluster would breach the [quota
limit](/../../../reference/quotas/openstack).
limit](../../../reference/quotas/openstack.md).
2 changes: 1 addition & 1 deletion docs/background/project-deletion.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ required, and those are **not** available for {{brand}} users.

If you wish to disable a project, you can do so via the {{rest_api}}.
Make sure
[you have access](/howto/getting-started/accessing-cc-rest-api)
[you have access](../howto/getting-started/accessing-cc-rest-api.md)
to it, and then consult the documentation to actually
[disable a project](https://apidoc.cleura.cloud/#api-AccessControl_Openstack-OSEditOpenstackProject).
2 changes: 1 addition & 1 deletion docs/contrib/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ simply be improved? There are multiple ways for you to help make this
site better, and we welcome all of them.

You can make modifications and contributions [using
Git](modifications), and we apply certain [checks](quality) to ensure
Git](modifications.md), and we apply certain [checks](quality.md) to ensure
consistent documentation quality.

## Technical Writing Resources
Expand Down
2 changes: 1 addition & 1 deletion docs/contrib/modifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ git add <files-to-add>
git commit
```

Please see our [notes on commit messages](../quality).
Please see our [notes on commit messages](quality.md).

Finally, create a pull request (PR) from your changes:

Expand Down
2 changes: 1 addition & 1 deletion docs/howto/account-billing/rest-invoice-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ using the {{rest_api}}.
## Prerequisites

Before retrieving any of your invoice data, you need to
[create a token](/howto/getting-started/accessing-cc-rest-api)
[create a token](../getting-started/accessing-cc-rest-api.md)
for the current session.

## Saving invoice data
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/getting-started/accessing-cc-rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{{brand}} provides a REST API, which you can take advantage of with a
tool like `curl`. But before you do, you must create a token for the
current session. For that, you only need to have an
[account in {{brand}}](/howto/getting-started/create-account).
[account in {{brand}}](create-account.md).

## Creating a token

Expand Down
2 changes: 1 addition & 1 deletion docs/howto/kubernetes/gardener/hibernate-shoot-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ cluster again), you will be paying *less* for the cluster.
We assume you have already used {{k8s_management_service}} in {{brand}} to spin up a
Kubernetes cluster, which is now humming away. If you've never done
this before, please feel free to [follow this
guide](../create-shoot-cluster).
guide](create-shoot-cluster.md).

## Hibernating a cluster

Expand Down
2 changes: 1 addition & 1 deletion docs/howto/kubernetes/gardener/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ NAME STATUS ROLES AGE VER
shoot--p40698--test-cluster-czg4zf-z1-5d7b5-bfl7p Ready <none> 156m v1.24.3
```
> Please note that in contrast to an [OpenStack Magnum-managed Kubernetes cluster](../../../openstack/magnum/new-k8s-cluster) (where the output of `kubectl get nodes` includes control plane and worker nodes), in a {{k8s_management_service}} cluster the same command *only* lists the worker nodes.
> Please note that in contrast to an [OpenStack Magnum-managed Kubernetes cluster](../../openstack/magnum/new-k8s-cluster.md) (where the output of `kubectl get nodes` includes control plane and worker nodes), in a {{k8s_management_service}} cluster the same command *only* lists the worker nodes.
## Deploying an application
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/kubernetes/gardener/rolling-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ By default, Kubernetes clusters created with {{k8s_management_service}}
in {{brand}} are upgraded automatically. Those upgrades take place
during a specified maintenance window, and you may find out more about
[what they involve and how they
work](../../../../background/kubernetes/gardener/autoupgrades). Besides
work](../../../background/kubernetes/gardener/autoupgrades.md). Besides
the automatic upgrades, you can manually apply any upgrades available
for your cluster.

Expand Down
4 changes: 2 additions & 2 deletions docs/howto/kubernetes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ In {{brand}}, you have several options for deploying and managing
Kubernetes clusters.

[{{gui}}](https://{{gui_domain}}) includes management interfaces for
[{{k8s_management_service}}](gardener/) and [OpenStack Magnum](magnum/). To manage
[{{k8s_management_service}}](gardener/index.md) and [OpenStack Magnum](magnum/index.md). To manage
Magnum clusters, you can also use the [OpenStack command-line
interface](../getting-started/enable-openstack-cli/).
interface](../getting-started/enable-openstack-cli.md).

To assess which facility is more suitable for your specific deployment scenario and use case, refer to [this summary](../../background/kubernetes/index.md).
2 changes: 1 addition & 1 deletion docs/howto/kubernetes/magnum/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ documentation](https://docs.openstack.org/magnum/latest/user/#clustertemplate).

Once you have chosen your Cluster Template, you move on to [create a
cluster based on that
template](/howto/openstack/magnum/new-k8s-cluster). When you create
template](../../openstack/magnum/new-k8s-cluster.md). When you create
the cluster, you can define the number of nodes in your cluster, ask
for multiple master nodes with a load balancer in front, etc.
4 changes: 2 additions & 2 deletions docs/howto/object-storage/s3/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ standard `aws` CLI.

Either way, [in addition to installing and configuring the Python
`openstackclient`
module](../../getting-started/enable-openstack-cli/), you need to
module](../../getting-started/enable-openstack-cli.md), you need to
install one of the aforementioned utilities.

=== "Debian/Ubuntu"
Expand All @@ -28,5 +28,5 @@ install one of the aforementioned utilities.
## Availability

The S3 API is available in select {{brand}} regions. Refer to [the
feature support matrix](/reference/features/) for details on S3 API
feature support matrix](../../../reference/features/index.md) for details on S3 API
availability.
2 changes: 1 addition & 1 deletion docs/howto/object-storage/swift/expiry.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ be deleted, after they have passed an expiry threshold.
## Prerequisites

In order to manage object expiry, be sure that you have [installed and
configured](../) the `swift` command-line interface (CLI). There is
configured](index.md) the `swift` command-line interface (CLI). There is
presently no way to set object expiry with the `openstack` CLI.


Expand Down
6 changes: 3 additions & 3 deletions docs/howto/object-storage/swift/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
[OpenStack Swift](https://docs.openstack.org/swift/) (not to be
confused with [the programming language of the same
name](https://en.wikipedia.org/wiki/Swift_(programming_language))) is
an object-access API similar to, but distinct from, the [S3](../s3/) object
an object-access API similar to, but distinct from, the [S3](../s3/index.md) object
storage API.

In {{brand}}, you interact with the Swift API using either the `swift`
command-line interface (CLI), or the standard `openstack` CLI.

Either way, [in addition to installing and configuring the Python
`openstackclient`
module](../../getting-started/enable-openstack-cli/), you need to
module](../../getting-started/enable-openstack-cli.md), you need to
install the Python `swiftclient` module. Use either the package
manager of your operating system, or `pip`:

Expand All @@ -30,5 +30,5 @@ manager of your operating system, or `pip`:
## Availability

The OpenStack Swift API is available in select {{brand}}
regions. Refer to [the feature support matrix](/reference/features/)
regions. Refer to [the feature support matrix](../../../reference/features/index.md)
for details on Swift API availability.
2 changes: 1 addition & 1 deletion docs/howto/object-storage/swift/private-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Prerequisites

In order to create a Swift container, be sure that you have
[installed and configured](../) the required command-line interface
[installed and configured](index.md) the required command-line interface
(CLI) tools.


Expand Down
2 changes: 1 addition & 1 deletion docs/howto/object-storage/swift/public-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: You can use the Swift API to configure a container with public read
## Prerequisites

In order to create a Swift container, be sure that you have
[installed and configured](../) the required command-line interface
[installed and configured](index.md) the required command-line interface
(CLI) tools.


Expand Down
2 changes: 1 addition & 1 deletion docs/howto/object-storage/swift/tempurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ to it. This is known as a *temporary* URL, or TempURL.
## Prerequisites

In order to manage TempURLs, be sure that you have [installed and
configured](../) the `swift` command-line interface (CLI). There is
configured](index.md) the `swift` command-line interface (CLI). There is
presently no way to create TempURLs with the `openstack` CLI.

Also, ensure that you have configured a [private
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/object-storage/swift/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ of an object, rather than overwriting it in place.
## Prerequisites

In order to manage object versioning, be sure that you have [installed
and configured](../) the `swift` command-line interface (CLI). There
and configured](index.md) the `swift` command-line interface (CLI). There
is presently no way to set object expiry with the `openstack` CLI.

Also, ensure that you have configured a [private
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/openstack/magnum/new-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ CLI.
## Prerequisites

First and foremost, you need an [account in
{{brand}}](/howto/getting-started/create-account). Should you choose to
{{brand}}](../../getting-started/create-account.md). Should you choose to
work from your terminal, you will also need to [enable the OpenStack
CLI](/howto/getting-started/enable-openstack-cli). In that case, in
CLI](../../getting-started/enable-openstack-cli.md). In that case, in
addition to the Python `openstackclient` module, make sure you also
install the corresponding plugin module for Magnum. Use either the
package manager of your operating system or `pip`:
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/openstack/neutron/create-security-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ the default rules for their group and add new rule sets."_
Navigate to the [{{gui}}](https://{{gui_domain}}) page, and log into
your {{brand}} account. On the other hand, if you prefer to work with
the OpenStack CLI, please do not forget
to [source the RC file first](/howto/getting-started/enable-openstack-cli).
to [source the RC file first](../../getting-started/enable-openstack-cli.md).

=== "{{gui}}"
To create a security group click on _Security Groups_ in the left-hand
Expand Down Expand Up @@ -72,7 +72,7 @@ destination (egress) is allowed by default.

> For accounts created before 2022-11-16, the default security
> group ingress rules allow all incoming traffic.
> See [Adjust permissive default security group](/howto/openstack/neutron/create-security-groups/#adjust-permissive-default-security-group),
> See [Adjust permissive default security group](#adjust-permissive-default-security-group),
> to learn how to configure this security group according to
> our recommendations.
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/openstack/neutron/delete-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ either the {{gui}} or the OpenStack CLI.
## Prerequisites

Whether you choose to work from the {{gui}} or with the OpenStack CLI,
you need to [have an account](/howto/getting-started/create-account) in
you need to [have an account](../../getting-started/create-account.md) in
{{brand}}. Additionally, to use the OpenStack CLI, make sure to [enable
it](/howto/getting-started/enable-openstack-cli) for the region you
it](../../getting-started/enable-openstack-cli.md) for the region you
will be working in.

## Selecting a network
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/openstack/neutron/new-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ a new network using the {{gui}}, or using the OpenStack CLI.
## Prerequisites

Whether you choose to work from the {{gui}} or with the OpenStack CLI,
you need to [have an account](/howto/getting-started/create-account)
you need to [have an account](../../getting-started/create-account.md)
in {{brand}}. Additionally, to use the OpenStack CLI make sure to
[enable it first](/howto/getting-started/enable-openstack-cli).
[enable it first](../../getting-started/enable-openstack-cli.md).

## Creating a network

Expand Down
6 changes: 3 additions & 3 deletions docs/howto/openstack/neutron/vpnaas.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ CLI. Let us demonstrate the process following both approaches.
## Prerequisites

Whether you choose to work from the {{gui}} or with the OpenStack CLI,
you need to [have an account](/howto/getting-started/create-account) in
you need to [have an account](../../getting-started/create-account.md) in
{{brand}}. If you prefer to work with the [OpenStack
CLI](/howto/getting-started/enable-openstack-cli), then in addition to
CLI](../../getting-started/enable-openstack-cli.md), then in addition to
the Python `openstackclient` module, you need to install the
Python `neutronclient` module also. Use either the package manager
of your operating system or `pip`:
Expand All @@ -36,7 +36,7 @@ your favorite web browser, navigate to the
[{{gui}}](https://{{gui_domain}}) start page, and log into your
{{brand}} account. Should you decide to follow the OpenStack CLI route
instead, please make sure you have the appropriate [RC
file](/howto/getting-started/enable-openstack-cli) for each region
file](../../getting-started/enable-openstack-cli.md) for each region
involved.

=== "{{gui}}"
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/openstack/nova/boot-image-volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ the OpenStack CLI.
account if you have to.
=== "OpenStack CLI"
To work with the OpenStack CLI, make sure to properly [enable
it](/howto/getting-started/enable-openstack-cli) for the region your
it](../../getting-started/enable-openstack-cli.md) for the region your
boot-from-image server resides in.

## Shutting down the server
Expand Down Expand Up @@ -316,7 +316,7 @@ the OpenStack CLI.
![Choosing a flavor](assets/bfi-to-bfv/shot12.png)

Consider leaving the [*Disaster
recovery*](/background/disaster-recovery) option enabled, and see if you
recovery*](../../../background/disaster-recovery.md) option enabled, and see if you
want an external IP address for the server.

![Enabling disaster recovery and asking for external IP](assets/bfi-to-bfv/shot13.png)
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/openstack/nova/move-server-between-regions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ In order to move a server from one region to another, you will need
## Finding a volume's ID

To work with the OpenStack CLI, please do not forget to [source the RC
file first](/howto/getting-started/enable-openstack-cli/).
file first](../../getting-started/enable-openstack-cli.md).

Use the ID of the server instead of using the server name. This will
make sure that you are using the correct server.
Expand Down Expand Up @@ -345,7 +345,7 @@ openstack volume create --size <GB> --image <new_image_id> <new_volume_name>
## Creating a server from a volume

Now you need to create the new server using the system volume. To
create a new server, follow [this guide](../new-server/).
create a new server, follow [this guide](new-server.md).

=== "{{gui}}"
If you use the {{gui}}, when choosing a _boot source,_ select
Expand Down
Loading

0 comments on commit b006c18

Please sign in to comment.