summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authors-makin <sally.makin@canonical.com>2023-01-27 20:52:59 +0000
committerGitHub <noreply@github.com>2023-01-27 14:52:59 -0600
commit2580ca7b685b88f471b1a5d4a04eda75c7c91e07 (patch)
tree75ac695770c9c04ce87897ac5cdc253b236330ec
parent28b8703111d2c334b34dcde4cb9d04a7793b8814 (diff)
downloadcloud-init-git-2580ca7b685b88f471b1a5d4a04eda75c7c91e07.tar.gz
docs: minor polishing (#1979)
Minor changes for Diataxis: 1) Added "reverse" to front page section blocks so they display correctly on mobile/smaller screens. 2) Added links to security/performance pages from Explanation section. These were linking directly to the pages in the Development section and will eventually become more like signposts as more content is added/revised.
-rw-r--r--doc/rtd/development/index.rst2
-rw-r--r--doc/rtd/explanation/analyze.rst (renamed from doc/rtd/development/analyze.rst)0
-rw-r--r--doc/rtd/explanation/index.rst2
-rw-r--r--doc/rtd/explanation/security.rst (renamed from doc/rtd/development/security.rst)0
-rw-r--r--doc/rtd/index.rst14
5 files changed, 11 insertions, 7 deletions
diff --git a/doc/rtd/development/index.rst b/doc/rtd/development/index.rst
index 8c077d8e..9768fab5 100644
--- a/doc/rtd/development/index.rst
+++ b/doc/rtd/development/index.rst
@@ -26,8 +26,6 @@ Debugging and reporting
:maxdepth: 1
../howto/bugs.rst
- security.rst
- analyze.rst
logging.rst
debugging.rst
diff --git a/doc/rtd/development/analyze.rst b/doc/rtd/explanation/analyze.rst
index 93961928..93961928 100644
--- a/doc/rtd/development/analyze.rst
+++ b/doc/rtd/explanation/analyze.rst
diff --git a/doc/rtd/explanation/index.rst b/doc/rtd/explanation/index.rst
index ea015a40..c6114096 100644
--- a/doc/rtd/explanation/index.rst
+++ b/doc/rtd/explanation/index.rst
@@ -16,3 +16,5 @@ knowledge and become better at using and configuring ``cloud-init``.
events.rst
instancedata.rst
vendordata.rst
+ security.rst
+ analyze.rst
diff --git a/doc/rtd/development/security.rst b/doc/rtd/explanation/security.rst
index c1ffd9ce..c1ffd9ce 100644
--- a/doc/rtd/development/security.rst
+++ b/doc/rtd/explanation/security.rst
diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst
index 1d581129..81045051 100644
--- a/doc/rtd/index.rst
+++ b/doc/rtd/index.rst
@@ -37,11 +37,9 @@ that can be integrated with your cloud.
Step-by-step guides covering key operations and common tasks
- .. grid-item-card:: **Explanation**
- :link: explanation/index
- :link-type: doc
-
- Discussion and clarification of key topics
+.. grid:: 1 1 2 2
+ :gutter: 3
+ :reverse:
.. grid-item-card:: **Reference**
:link: reference/index
@@ -49,6 +47,12 @@ that can be integrated with your cloud.
Technical information - specifications, APIs, architecture
+ .. grid-item-card:: **Explanation**
+ :link: explanation/index
+ :link-type: doc
+
+ Discussion and clarification of key topics
+
-----
Having trouble? We would like to help!