forked from rpms/leapp-repository
99 lines
3.3 KiB
Diff
99 lines
3.3 KiB
Diff
From 51b26776405a926882509c3f62d0bedbb4eab188 Mon Sep 17 00:00:00 2001
|
|
From: Michal Hecko <mhecko@redhat.com>
|
|
Date: Mon, 14 Apr 2025 10:07:53 +0200
|
|
Subject: [PATCH 10/37] docs(configuring-ipu): add experimental features
|
|
section
|
|
|
|
With the upcoming introduction of documentation of the LiveMode feature,
|
|
a question arises where to put the documentation. This patch introduces
|
|
a new subsection 'Experimental features' under the 'Configuring IPU'
|
|
section, so we have one place to where to put such features.
|
|
---
|
|
.../{ => configuring-ipu}/configuring-ipu.md | 0
|
|
.../experimental-features/index.rst | 23 +++++++++++++++++++
|
|
docs/source/configuring-ipu/index.rst | 23 +++++++++++++++++++
|
|
docs/source/index.rst | 2 +-
|
|
4 files changed, 47 insertions(+), 1 deletion(-)
|
|
rename docs/source/{ => configuring-ipu}/configuring-ipu.md (100%)
|
|
create mode 100644 docs/source/configuring-ipu/experimental-features/index.rst
|
|
create mode 100644 docs/source/configuring-ipu/index.rst
|
|
|
|
diff --git a/docs/source/configuring-ipu.md b/docs/source/configuring-ipu/configuring-ipu.md
|
|
similarity index 100%
|
|
rename from docs/source/configuring-ipu.md
|
|
rename to docs/source/configuring-ipu/configuring-ipu.md
|
|
diff --git a/docs/source/configuring-ipu/experimental-features/index.rst b/docs/source/configuring-ipu/experimental-features/index.rst
|
|
new file mode 100644
|
|
index 00000000..7a26116e
|
|
--- /dev/null
|
|
+++ b/docs/source/configuring-ipu/experimental-features/index.rst
|
|
@@ -0,0 +1,23 @@
|
|
+Experimental features
|
|
+========================================================
|
|
+
|
|
+This section provides descriptions of all available experimental
|
|
+features. Low-level details and design decisions of these features
|
|
+are provided.
|
|
+
|
|
+.. warning::
|
|
+ Actor configuration is currently a preview of the feature, it might change in future releases.
|
|
+
|
|
+.. toctree::
|
|
+ :maxdepth: 4
|
|
+ :caption: Contents:
|
|
+ :glob:
|
|
+
|
|
+
|
|
+
|
|
+.. Indices and tables
|
|
+.. ==================
|
|
+..
|
|
+.. * :ref:`genindex`
|
|
+.. * :ref:`modindex`
|
|
+.. * :ref:`search`
|
|
diff --git a/docs/source/configuring-ipu/index.rst b/docs/source/configuring-ipu/index.rst
|
|
new file mode 100644
|
|
index 00000000..1be3ebcf
|
|
--- /dev/null
|
|
+++ b/docs/source/configuring-ipu/index.rst
|
|
@@ -0,0 +1,23 @@
|
|
+Configuring the in-place upgrade
|
|
+========================================================
|
|
+
|
|
+This section covers possible ways of modifying the in-place upgrade
|
|
+without making any code changes. Leapp offers multiple mechanism
|
|
+to affect the upgrade ranging from simple environmental variables
|
|
+to more robust configuration files. This section also covers available
|
|
+experimental features.
|
|
+
|
|
+.. toctree::
|
|
+ :maxdepth: 4
|
|
+ :caption: Contents:
|
|
+ :glob:
|
|
+
|
|
+ configuring-ipu
|
|
+ experimental-features/index
|
|
+
|
|
+.. Indices and tables
|
|
+.. ==================
|
|
+..
|
|
+.. * :ref:`genindex`
|
|
+.. * :ref:`modindex`
|
|
+.. * :ref:`search`
|
|
diff --git a/docs/source/index.rst b/docs/source/index.rst
|
|
index 33a920ec..27537ca4 100644
|
|
--- a/docs/source/index.rst
|
|
+++ b/docs/source/index.rst
|
|
@@ -19,7 +19,7 @@ providing Red Hat Enterprise Linux in-place upgrade functionality.
|
|
tutorials/index
|
|
project-structure/index
|
|
upgrade-architecture-and-workflow/index
|
|
- configuring-ipu
|
|
+ configuring-ipu/index
|
|
libraries-and-api/index
|
|
contrib-and-devel-guidelines
|
|
faq
|
|
--
|
|
2.49.0
|
|
|