add dev docs notice

edibotopic · edibotopic · commit 98c5880de9ec · 2025-02-24T12:23:14.000Z
it is possible that a regular user could visit a page intended for
developers.

for example, a user who wants to install UP4W to use it on their machine
ends up in the installation page for developers.

this adds a notice that these are not for general use.

in future, we might want to move them, but this is OK for now.
diff --git a/docs/dev_docs_notice.txt b/docs/dev_docs_notice.txt
@@ -0,0 +1,8 @@
+<!-- Include start dev -->
+```{admonition} Developer documentation
+:class: important
+This page contains information of relevance to the
+development, testing and debugging of the Ubuntu Pro
+for WSL application and is not intended for general use.
+```
+<!-- Include end dev -->
diff --git a/docs/howto/02-install.md b/docs/howto/02-install.md
@@ -7,6 +7,10 @@ myst:
 
 # Install individual components of Ubuntu Pro for WSL for development
 
+```{include} ../dev_docs_notice.txt
+    :start-after: <!-- Include start dev -->
+    :end-before: <!-- Include end dev -->
+```
 
 This guide will show you how to install UP4W for local development and testing.
 
diff --git a/docs/howto/03-restart.md b/docs/howto/03-restart.md
@@ -7,6 +7,10 @@ myst:
 
 # Restart Ubuntu Pro for WSL during development
 
+```{include} ../dev_docs_notice.txt
+    :start-after: <!-- Include start dev -->
+    :end-before: <!-- Include end dev -->
+```
 
 Some configuration changes only apply when you restart UP4W. Here is a guide on how to restart it. There are two options.
 
diff --git a/docs/howto/06-access-the-logs.md b/docs/howto/06-access-the-logs.md
@@ -7,6 +7,10 @@ myst:
 
 # Access Ubuntu Pro for WSL logs for debugging
 
+```{include} ../dev_docs_notice.txt
+    :start-after: <!-- Include start dev -->
+    :end-before: <!-- Include end dev -->
+```
 
 At some point you may want to read the UP4W logs, most likely for debugging purposes. The agent and the service store their logs separately. This guide shows you where to find each of the logs.
 
diff --git a/docs/howto/07-toggle-features.md b/docs/howto/07-toggle-features.md
@@ -7,6 +7,10 @@ myst:
 
 # Enable opt-in features of Ubuntu Pro for WSL during development
 
+```{include} ../dev_docs_notice.txt
+    :start-after: <!-- Include start dev -->
+    :end-before: <!-- Include end dev -->
+```
 
 Some features in UP4W are opt-in or can be toggled on and off via the Windows Registry.
 While the code is arranged such that CI always tests with those features enabled,
diff --git a/docs/howto/reset-factory.md b/docs/howto/reset-factory.md
@@ -7,6 +7,10 @@ myst:
 
 # How to reset Ubuntu Pro for WSL back to factory settings
 
+```{include} ../dev_docs_notice.txt
+    :start-after: <!-- Include start dev -->
+    :end-before: <!-- Include end dev -->
+```
 
 You can reset Ubuntu Pro for WSL to factory settings following these steps:
 
diff --git a/docs/reference/07-windows-agent-command-line-reference.md b/docs/reference/07-windows-agent-command-line-reference.md
@@ -7,6 +7,11 @@ myst:
 
 # Windows Agent CLI
 
+```{include} ../dev_docs_notice.txt
+    :start-after: <!-- Include start dev -->
+    :end-before: <!-- Include end dev -->
+```
+
 > See first: [UP4W - Windows Agent](ref::up4w-windows-agent)
 
 
diff --git a/docs/reference/08-wsl-pro-service-command-line-reference.md b/docs/reference/08-wsl-pro-service-command-line-reference.md
@@ -7,6 +7,11 @@ myst:
 
 # WSL Pro Service CLI
 
+```{include} ../dev_docs_notice.txt
+    :start-after: <!-- Include start dev -->
+    :end-before: <!-- Include end dev -->
+```
+
 > See first: [UP4W - WSL Pro Service](ref::up4w-wsl-pro-service)
 
 ## Usage
diff --git a/docs/reference/09-qa-process-reference.md b/docs/reference/09-qa-process-reference.md
@@ -7,6 +7,11 @@ myst:
 
 # QA Process
 
+```{include} ../dev_docs_notice.txt
+    :start-after: <!-- Include start dev -->
+    :end-before: <!-- Include end dev -->
+```
+
 ## Generalities
 
 ```{note}
