From f5532efe9a38a1f4270005ba719656c9967a70d0 Mon Sep 17 00:00:00 2001 From: Ben Hoyt Date: Sat, 21 Dec 2024 07:44:47 +1300 Subject: [PATCH] docs: update link to Pebble layer specification (#779) As of a few months ago we have a proper docs site and the README is minimal, so update this link. --------- Co-authored-by: Tiago Nobrega --- docs/conf.py | 2 +- docs/explanation/pebble.rst | 2 +- docs/how-to/rocks/convert-to-pebble-layer.rst | 3 ++- docs/reference/rockcraft.yaml.rst | 2 +- rockcraft/pebble.py | 4 ++-- schema/rockcraft.json | 4 ++-- 6 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1696d2792..8c82dbf5d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -94,7 +94,7 @@ linkcheck_ignore = [ "http://0.0.0.0:8080", "https://github.com/canonical/craft-actions#rockcraft-pack", - "https://github.com/canonical/pebble#layer-specification", + "https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/", "https://juju.is/cloud-native-kubernetes-usage-report-2021#selection-criteria-for-container-images", "https://matrix.to/#/#rocks:ubuntu.com", # Ignore changelog links to Rockcraft releases, because the changelog entries diff --git a/docs/explanation/pebble.rst b/docs/explanation/pebble.rst index e2157c61a..cae929ea5 100644 --- a/docs/explanation/pebble.rst +++ b/docs/explanation/pebble.rst @@ -84,4 +84,4 @@ convert a Docker entrypoint to a Pebble layer. .. _tini: https://github.com/krallin/tini .. _s6-overlay: https://github.com/just-containers/s6-overlay .. _imperative wrapper scripts (as suggested in the Docker documentation): https://docs.docker.com/engine/containers/multi-service_container/#use-a-wrapper-script -.. _Pebble layer specification: https://github.com/canonical/pebble#layer-specification +.. _Pebble layer specification: https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/ diff --git a/docs/how-to/rocks/convert-to-pebble-layer.rst b/docs/how-to/rocks/convert-to-pebble-layer.rst index 34d8fbdb3..9cd00dd82 100644 --- a/docs/how-to/rocks/convert-to-pebble-layer.rst +++ b/docs/how-to/rocks/convert-to-pebble-layer.rst @@ -26,7 +26,8 @@ Design the Pebble services -------------------------- A `Pebble layer -`_ +`_ is composed of metadata, checks and services. The latter is present in ``rockcraft.yaml`` as a `top-level field