diff --git a/docs/explanation/service-dependencies.md b/docs/explanation/service-dependencies.md index 34044b63e..982caa374 100644 --- a/docs/explanation/service-dependencies.md +++ b/docs/explanation/service-dependencies.md @@ -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). diff --git a/docs/explanation/service-start-order.md b/docs/explanation/service-start-order.md index 0bfe3a602..d50123a4d 100644 --- a/docs/explanation/service-start-order.md +++ b/docs/explanation/service-start-order.md @@ -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 ``` \ No newline at end of file diff --git a/docs/how-to/install-pebble.md b/docs/how-to/install-pebble.md index 9dac34fba..118297b80 100644 --- a/docs/how-to/install-pebble.md +++ b/docs/how-to/install-pebble.md @@ -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 ``` @@ -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 ``` diff --git a/docs/how-to/service-dependencies.md b/docs/how-to/service-dependencies.md index 8299f34ca..ae9640815 100644 --- a/docs/how-to/service-dependencies.md +++ b/docs/how-to/service-dependencies.md @@ -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 diff --git a/docs/reuse/install.md b/docs/reuse/install.txt similarity index 96% rename from docs/reuse/install.md rename to docs/reuse/install.txt index 49394249f..d6547f214 100644 --- a/docs/reuse/install.md +++ b/docs/reuse/install.txt @@ -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`. diff --git a/docs/reuse/service-start-order.md b/docs/reuse/service-start-order.txt similarity index 95% rename from docs/reuse/service-start-order.md rename to docs/reuse/service-start-order.txt index a01589b48..f00d84e8c 100644 --- a/docs/reuse/service-start-order.md +++ b/docs/reuse/service-start-order.txt @@ -1,7 +1,3 @@ ---- -nosearch: true ---- - Start: Service start order note ```{note} diff --git a/docs/reuse/verify.md b/docs/reuse/verify.txt similarity index 95% rename from docs/reuse/verify.md rename to docs/reuse/verify.txt index 04fd1ca93..669057a9f 100644 --- a/docs/reuse/verify.md +++ b/docs/reuse/verify.txt @@ -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: diff --git a/docs/tutorial/getting-started.md b/docs/tutorial/getting-started.md index 93086b6f3..04ee2fb6a 100644 --- a/docs/tutorial/getting-started.md +++ b/docs/tutorial/getting-started.md @@ -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 ```