Skip to content

Commit

Permalink
fix spelling errors in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
swapdisk authored and pirat89 committed May 19, 2023
1 parent 0cda973 commit 2c9be46
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions docs/source/_static/images/inplace-upgrade-workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/best-practices.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Best Practices for actor developmemt
# Best Practices for actor development

## Follow the contribution guidelines

Expand Down
2 changes: 1 addition & 1 deletion docs/source/compatibility-with-leapp-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion docs/source/deprecation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/el7toel8/actor-rhel7-to-rhel8.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/el7toel8/deprecation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/unit-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/workflow-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 2c9be46

Please sign in to comment.