Skip to content

Commit

Permalink
chore: remove reusable content pages
Browse files Browse the repository at this point in the history
  • Loading branch information
IronCore864 committed Nov 8, 2024
1 parent 079eca4 commit 68afce1
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/explanation/service-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Simply put, you can configure a list of other services in the `requires` section

When Pebble starts a service, it also starts the services which that service depends on (configured with `requires`). Conversely, when stopping a service, Pebble also stops services which depend on that service.

For the start order of the services, see [Service start order](./service-start-order.md).
For the start order of the services, see [Service start order](./service-start-order.txt).

For example, if service `nginx` requires `logger`, `pebble start nginx` will start both `nginx` and `logger` (in an undefined order). Running `pebble stop logger` will stop both `nginx` and `logger`; however, running `pebble stop nginx` will only stop `nginx` (`nginx` depends on `logger`, not the other way around).
2 changes: 1 addition & 1 deletion docs/explanation/service-start-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ When multiple services need to be started together, they're started in order acc

The `before` option is a list of services that this service must start before (it may or may not `requires` them, see [Service dependencies](./service-dependencies.md)). Or if it's easier to specify this ordering the other way around, `after` is a list of services that this service must start after.

```{include} /reuse/service-start-order.md
```{include} /reuse/service-start-order.txt
:start-after: Start: Service start order note
:end-before: End: Service start order note
```
4 changes: 2 additions & 2 deletions docs/how-to/install-pebble.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To install the latest version of Pebble, you can choose any of the following met

To install the binary for the latest version of Pebble:

```{include} /reuse/install.md
```{include} /reuse/install.txt
:start-after: Start: Install Pebble binary
:end-before: End: Install Pebble binary
```
Expand All @@ -27,7 +27,7 @@ Alternatively, you can install the latest version of Pebble from source:

## Verify the Pebble installation

```{include} /reuse/verify.md
```{include} /reuse/verify.txt
:start-after: Start: Verify the Pebble installation
:end-before: End: Verify the Pebble installation
```
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to/service-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,12 +190,12 @@ In the updated layer above, the `frontend` service requires the `backend`
service to be started before it, and the `backend` service requires the
`database` service to be started before it.

```{include} /reuse/service-start-order.md
```{include} /reuse/service-start-order.txt
:start-after: Start: Service start order note
:end-before: End: Service start order note
```

For more information on `before` and `after`, see [Service start order](../explanation/service-start-order.md).
For more information on `before` and `after`, see [Service start order](../explanation/service-start-order.txt).

## Verify service dependencies

Expand Down
4 changes: 0 additions & 4 deletions docs/reuse/install.md → docs/reuse/install.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
nosearch: true
---

Start: Install Pebble binary

1. Visit the [latest release page](https://github.com/canonical/pebble/releases/latest) to determine the latest tag, for example, `v1.12.0`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
nosearch: true
---

Start: Service start order note

```{note}
Expand Down
4 changes: 0 additions & 4 deletions docs/reuse/verify.md → docs/reuse/verify.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
nosearch: true
---

Start: Verify the Pebble installation

Once the installation is complete, verify that `pebble` has been installed correctly by running:
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ After this tutorial, you will have a basic understanding of what Pebble is and h

The easiest way to install the latest Pebble release is by downloading the binary. If you prefer a different installation method, see {ref}`how_to_install_pebble`.

```{include} /reuse/install.md
```{include} /reuse/install.txt
:start-after: Start: Install Pebble binary
:end-before: End: Install Pebble binary
```

## Verify the Pebble installation

```{include} /reuse/verify.md
```{include} /reuse/verify.txt
:start-after: Start: Verify the Pebble installation
:end-before: End: Verify the Pebble installation
```
Expand Down

0 comments on commit 68afce1

Please sign in to comment.