153 lines
8.7 KiB
Diff
153 lines
8.7 KiB
Diff
|
From 2c9be460399429d3aeadac80fdae8892f28e4345 Mon Sep 17 00:00:00 2001
|
|||
|
|
From: Bob Mader <bmader@redhat.com>
|
|||
|
|
Date: Thu, 18 May 2023 10:48:31 -0500
|
|||
|
|
Subject: [PATCH 13/18] fix spelling errors in docs
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
docs/source/_static/images/inplace-upgrade-workflow.svg | 6 +++---
|
|||
|
|
docs/source/best-practices.md | 2 +-
|
|||
|
|
docs/source/compatibility-with-leapp-repository.md | 2 +-
|
|||
|
|
docs/source/dependencies.md | 2 +-
|
|||
|
|
docs/source/deprecation.md | 2 +-
|
|||
|
|
docs/source/el7toel8/actor-rhel7-to-rhel8.md | 2 +-
|
|||
|
|
docs/source/el7toel8/deprecation.md | 2 +-
|
|||
|
|
docs/source/unit-testing.md | 2 +-
|
|||
|
|
docs/source/workflow-apis.md | 2 +-
|
|||
|
|
9 files changed, 11 insertions(+), 11 deletions(-)
|
|||
|
|
|
|||
|
|
diff --git a/docs/source/_static/images/inplace-upgrade-workflow.svg b/docs/source/_static/images/inplace-upgrade-workflow.svg
|
|||
|
|
index 76d8e70..d470449 100644
|
|||
|
|
--- a/docs/source/_static/images/inplace-upgrade-workflow.svg
|
|||
|
|
+++ b/docs/source/_static/images/inplace-upgrade-workflow.svg
|
|||
|
|
@@ -1155,7 +1155,7 @@
|
|||
|
|
style="font-size:5.29167px;text-align:center;text-anchor:middle;stroke-width:0.264583"
|
|||
|
|
y="370.38736"
|
|||
|
|
x="24.260719"
|
|||
|
|
- sodipodi:role="line">Pre-Thrid Party</tspan><tspan
|
|||
|
|
+ sodipodi:role="line">Pre-Third Party</tspan><tspan
|
|||
|
|
style="font-size:5.29167px;text-align:center;text-anchor:middle;stroke-width:0.264583"
|
|||
|
|
y="377.4429"
|
|||
|
|
x="24.260719"
|
|||
|
|
@@ -1187,7 +1187,7 @@
|
|||
|
|
x="77.001747"
|
|||
|
|
y="370.38736"
|
|||
|
|
style="font-size:5.29167px;text-align:center;text-anchor:middle;stroke-width:0.264583"
|
|||
|
|
- id="tspan574">Thrid Party</tspan><tspan
|
|||
|
|
+ id="tspan574">Third Party</tspan><tspan
|
|||
|
|
id="tspan576"
|
|||
|
|
sodipodi:role="line"
|
|||
|
|
x="77.001747"
|
|||
|
|
@@ -1219,7 +1219,7 @@
|
|||
|
|
x="128.19006"
|
|||
|
|
y="370.29562"
|
|||
|
|
style="font-size:4.93889px;text-align:center;text-anchor:middle;stroke-width:0.264583"
|
|||
|
|
- id="tspan582">Post-Thrid Party</tspan><tspan
|
|||
|
|
+ id="tspan582">Post-Third Party</tspan><tspan
|
|||
|
|
id="tspan584"
|
|||
|
|
sodipodi:role="line"
|
|||
|
|
x="128.19006"
|
|||
|
|
diff --git a/docs/source/best-practices.md b/docs/source/best-practices.md
|
|||
|
|
index 79e1850..f3387e2 100644
|
|||
|
|
--- a/docs/source/best-practices.md
|
|||
|
|
+++ b/docs/source/best-practices.md
|
|||
|
|
@@ -1,4 +1,4 @@
|
|||
|
|
-# Best Practices for actor developmemt
|
|||
|
|
+# Best Practices for actor development
|
|||
|
|
|
|||
|
|
## Follow the contribution guidelines
|
|||
|
|
|
|||
|
|
diff --git a/docs/source/compatibility-with-leapp-repository.md b/docs/source/compatibility-with-leapp-repository.md
|
|||
|
|
index afdf237..40441ed 100644
|
|||
|
|
--- a/docs/source/compatibility-with-leapp-repository.md
|
|||
|
|
+++ b/docs/source/compatibility-with-leapp-repository.md
|
|||
|
|
@@ -10,7 +10,7 @@ when we agree it's worthwhile.
|
|||
|
|
|
|||
|
|
But we need a mechanism to be able to synchronize with other projects, when we
|
|||
|
|
provide new functionality in the upstream (master) branch without the need
|
|||
|
|
-of immadiate release of the new version of leapp. For these purposes the
|
|||
|
|
+of immediate release of the new version of leapp. For these purposes the
|
|||
|
|
`leapp-framework` capability is provided in the framework (python[23]-leapp) rpms.
|
|||
|
|
|
|||
|
|
## When and how change the capability
|
|||
|
|
diff --git a/docs/source/dependencies.md b/docs/source/dependencies.md
|
|||
|
|
index 8bac0ea..a94beab 100644
|
|||
|
|
--- a/docs/source/dependencies.md
|
|||
|
|
+++ b/docs/source/dependencies.md
|
|||
|
|
@@ -55,7 +55,7 @@ Requires: your-dependency
|
|||
|
|
And do not forget to increment value of `leapp-framework-dependencies`:
|
|||
|
|
|
|||
|
|
```spec
|
|||
|
|
-# IMPORTANT: everytime the requirements are changed, increment number by one
|
|||
|
|
+# IMPORTANT: every time the requirements are changed, increment number by one
|
|||
|
|
# - same for Provides in deps subpackage
|
|||
|
|
Requires: leapp-framework-dependencies = 1
|
|||
|
|
```
|
|||
|
|
diff --git a/docs/source/deprecation.md b/docs/source/deprecation.md
|
|||
|
|
index 28dbc14..b583758 100644
|
|||
|
|
--- a/docs/source/deprecation.md
|
|||
|
|
+++ b/docs/source/deprecation.md
|
|||
|
|
@@ -169,7 +169,7 @@ Reason: This model has been deprecated.
|
|||
|
|
Apparently, the `Reason` is not so good. It's just example. In real world
|
|||
|
|
example, you would like to provide usually a little bit better explanation.
|
|||
|
|
Anyway, much more interesting is the point, that the message is now printed
|
|||
|
|
-everytime the actor is executed.
|
|||
|
|
+every time the actor is executed.
|
|||
|
|
|
|||
|
|
Obviously we do not want to remove the actor yet, because in such a case, the
|
|||
|
|
model could be hardly called as deprecated - we need to keep the same
|
|||
|
|
diff --git a/docs/source/el7toel8/actor-rhel7-to-rhel8.md b/docs/source/el7toel8/actor-rhel7-to-rhel8.md
|
|||
|
|
index f4e45d4..06bdfae 100644
|
|||
|
|
--- a/docs/source/el7toel8/actor-rhel7-to-rhel8.md
|
|||
|
|
+++ b/docs/source/el7toel8/actor-rhel7-to-rhel8.md
|
|||
|
|
@@ -280,7 +280,7 @@ During development of your new actor, it is expected that you will test your wor
|
|||
|
|
|
|||
|
|
### Executing a single actor
|
|||
|
|
|
|||
|
|
-You should use snactor tool to run a single actor and verify its output. Assuming that there are no errors, the actor was placed inside a valid leapp repository and snactor tool is aware of such repository, you can call snactor run to execute it. Bellow we are executing the existing [OSReleaseCollector](https://github.com/oamg/leapp-repository/tree/master/repos/system_upgrade/el7toel8/actors/osreleasecollector) actor that provides information about operating system release from target system. For the `snactor run` command you can use either the actor’s folder name (osreleasecollector), the actor’s class name (OSReleaseCollector) or the value of the name attribute of the actor’s class (os_release_collector).
|
|||
|
|
+You should use snactor tool to run a single actor and verify its output. Assuming that there are no errors, the actor was placed inside a valid leapp repository and snactor tool is aware of such repository, you can call snactor run to execute it. Below we are executing the existing [OSReleaseCollector](https://github.com/oamg/leapp-repository/tree/master/repos/system_upgrade/el7toel8/actors/osreleasecollector) actor that provides information about operating system release from target system. For the `snactor run` command you can use either the actor’s folder name (osreleasecollector), the actor’s class name (OSReleaseCollector) or the value of the name attribute of the actor’s class (os_release_collector).
|
|||
|
|
|
|||
|
|
```shell
|
|||
|
|
# pwd
|
|||
|
|
diff --git a/docs/source/el7toel8/deprecation.md b/docs/source/el7toel8/deprecation.md
|
|||
|
|
index 0578b16..dcd1522 100644
|
|||
|
|
--- a/docs/source/el7toel8/deprecation.md
|
|||
|
|
+++ b/docs/source/el7toel8/deprecation.md
|
|||
|
|
@@ -24,7 +24,7 @@ framework, see [List of deprecated functionality in leapp](../deprecation.html#l
|
|||
|
|
- **RequiredTargetUserspacePackages** - Deprecated because the new solution has been designed. Use the `TargetUserspacePreupgradeTasks` instead (see the `install_rpms` field).
|
|||
|
|
- **RequiredUpgradeInitramPackages** - Deprecated because the new solution around the upgrade initramfs has been designed. Use the `TargetUserspaceUpgradeTasks` instead (see the `install_rpms` field).
|
|||
|
|
- **UpgradeDracutModule** - Replaced by `UpgradeInitramfsTasks` (see the `include_dracut_modules` field).
|
|||
|
|
- - **InitrdIncludes** - Deprecated becase the new solution around the target initramfs (read: initramfs created for the upgraded system) has been designed. Use the `TargetInitramfsTasks` instead (see the `include_files` field).
|
|||
|
|
+ - **InitrdIncludes** - Deprecated because the new solution around the target initramfs (read: initramfs created for the upgraded system) has been designed. Use the `TargetInitramfsTasks` instead (see the `include_files` field).
|
|||
|
|
|
|||
|
|
## v0.12.0 <span style="font-size:0.5em; font-weight:normal">(till April 2021)</span>
|
|||
|
|
- Models
|
|||
|
|
diff --git a/docs/source/unit-testing.md b/docs/source/unit-testing.md
|
|||
|
|
index 05d20df..d4feec9 100644
|
|||
|
|
--- a/docs/source/unit-testing.md
|
|||
|
|
+++ b/docs/source/unit-testing.md
|
|||
|
|
@@ -203,7 +203,7 @@ or
|
|||
|
|
pytest {PATH_TO_ACTOR}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
-It is also possible to run only slected tests based on their name:
|
|||
|
|
+It is also possible to run only selected tests based on their name:
|
|||
|
|
|
|||
|
|
```sh
|
|||
|
|
pytest -k "vim" # to run all tests contains vim in name
|
|||
|
|
diff --git a/docs/source/workflow-apis.md b/docs/source/workflow-apis.md
|
|||
|
|
index d27ac1e..c58cd2f 100644
|
|||
|
|
--- a/docs/source/workflow-apis.md
|
|||
|
|
+++ b/docs/source/workflow-apis.md
|
|||
|
|
@@ -112,7 +112,7 @@ Workflow APIs support having tests defined for them. We actually encourage you t
|
|||
|
|
|
|||
|
|
Tests for APIs are supposed to be defines in the `apis/tests` directory.
|
|||
|
|
|
|||
|
|
-### Depedencies
|
|||
|
|
+### Dependencies
|
|||
|
|
|
|||
|
|
Workflow APIs can depend on another Workflow API, to allow API compositiion. Actors using APIs with dependencies on
|
|||
|
|
other APIs just have to specify the API they want to use and do not need to know that those depend on other APIs.
|
|||
|
|
--
|
|||
|
|
2.41.0
|
|||
|
|
|