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 <[email protected]>
canonical · Dec 20, 2024 · f5532ef · f5532ef
1 parent 41b2368
commit f5532ef
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 8 deletions.
diff --git 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
@@ -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
@@ -26,7 +26,8 @@ Design the Pebble services
 --------------------------
 
 A `Pebble layer
-<https://github.com/canonical/pebble#layer-specification>`_
+<https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/
+layer-specification/>`_
 is composed of metadata, checks and services. The latter is present in
 ``rockcraft.yaml`` as a `top-level field
 <https://canonical-rockcraft.readthedocs-hosted.com/en/latest/reference/

diff --git a/docs/reference/rockcraft.yaml.rst b/docs/reference/rockcraft.yaml.rst
@@ -274,4 +274,4 @@ Example
     :language: yaml
 
 
-.. _`Pebble Layer Specification format`:  https://github.com/canonical/pebble#layer-specification
+.. _`Pebble Layer Specification format`:  https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/
diff --git a/rockcraft/pebble.py b/rockcraft/pebble.py
@@ -59,7 +59,7 @@ class Check(CraftBaseModel):
     """Lightweight schema validation for a Pebble checks.
 
     Based on
-    https://github.com/canonical/pebble#layer-specification
+    https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/
     """
 
     override: Literal["merge", "replace"]
@@ -98,7 +98,7 @@ class Service(CraftBaseModel):
     """Lightweight schema validation for a Pebble service.
 
     Based on
-    https://github.com/canonical/pebble#layer-specification
+    https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/
     """
 
     override: Literal["merge", "replace"]

diff --git a/schema/rockcraft.json b/schema/rockcraft.json
@@ -4,7 +4,7 @@
   "$defs": {
     "Check": {
       "additionalProperties": false,
-      "description": "Lightweight schema validation for a Pebble checks.\n\nBased on\nhttps://github.com/canonical/pebble#layer-specification",
+      "description": "Lightweight schema validation for a Pebble checks.\n\nBased on\nhttps://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/",
       "properties": {
         "override": {
           "enum": [
@@ -286,7 +286,7 @@
     },
     "Service": {
       "additionalProperties": false,
-      "description": "Lightweight schema validation for a Pebble service.\n\nBased on\nhttps://github.com/canonical/pebble#layer-specification",
+      "description": "Lightweight schema validation for a Pebble service.\n\nBased on\nhttps://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/",
       "properties": {
         "override": {
           "enum": [
Original file line number	Diff line number	Diff line change
Expand Up		@@ -274,4 +274,4 @@ Example
		:language: yaml


		.. _`Pebble Layer Specification format`: https://github.com/canonical/pebble#layer-specification
		.. _`Pebble Layer Specification format`: https://canonical-pebble.readthedocs-hosted.com/en/latest/reference/layer-specification/