Skip to content

Commit 4b94394

Browse files
authored
Merge pull request #340 from StackStorm/LH/typos
Typos, formatting, v2.1 header
2 parents cc91521 + 61b8292 commit 4b94394

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

docs/source/upgrade_notes.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Upgrade Notes
44
=============
55

6-
|st2| in development
7-
--------------------
6+
|st2| v2.1
7+
----------
88

99
* **WARNING:** The following changes may require you to update your custom packs during the upgrade.
1010

@@ -17,18 +17,18 @@ Upgrade Notes
1717

1818
The ``st2ctl`` and ``st2-register-content`` scripts are now doing additional validation. If you
1919
happen to have a pack which doesn't satisfy these new validation criteria, it will fail to load.
20-
Therefore, to upgrade from `2.0.*` StackStorm instance to `2.1.*`, follow this:
20+
Therefore, to upgrade StackStorm from v2.0.* to 2.1.*, follow this:
2121

22-
1. Use `yam` or `apt-get` to upgrade to the newest version.
22+
1. Use ``yum`` or ``apt-get`` to upgrade to the newest version.
2323

2424
2. Update community packs to the latest version from
25-
`StackStorm Exchange <https://exchange.stackstorm.org/>`__.
25+
`StackStorm Exchange <https://exchange.stackstorm.org/>`__.
2626

27-
2. Run `st2ctl reload`.
27+
3. Reload the content with ``st2ctl reload``.
2828

29-
3. If you happen to have packs that don't satisfy the rules above, the validation fails
29+
4. If you happen to have packs that don't satisfy the rules above, the validation fails
3030
and the pack load will throw errors. Fix the packs to conform the rules above,
31-
and run `st2ctl reload` again.
31+
and reload the content again.
3232

3333
In 2.1.0, |st2| attempts to auto-correct some validation failures and display a warning.
3434
In future release this auto-correction will be removed. Please update your packs ASAP.
@@ -47,8 +47,8 @@ Upgrade Notes
4747
* The ``packs`` pack is deprecated starting from 2.1; in future versions it will be completely
4848
replaced with the ``st2 pack <...>`` commands and API endpoints.
4949

50-
* Pack metadata file (``pack.yaml``) can now contain a new ``ref`` attribute, in addition to `name`.
51-
`ref` acts as a unique identifier; it offers for a more readable ``name``. For example, if a pack name is ``Travis CI``, a repo containing it is stackstorm-travis_ci, and ``ref`` is ``travis_ci``. Previously the pack files would live in ``travis_ci/`` directory and pack directory name served as a unique identifier for a pack.
50+
* Pack metadata file (``pack.yaml``) can now contain a new ``ref`` attribute, in addition to ``name``.
51+
``ref`` acts as a unique identifier; it offers for a more readable ``name``. For example, if a pack name is ``Travis CI``, a repo containing it is stackstorm-travis_ci, and ``ref`` is ``travis_ci``. Previously the pack files would live in ``travis_ci/`` directory and pack directory name served as a unique identifier for a pack.
5252

5353
* Support for ``.gitinfo`` file has been removed and as such ``packs.info`` action has also been
5454
removed. All the pack directories at ``/opt/stackstorm/packs`` are now direct git checkouts of the corresponding pack repositories from exchange or your own origin, so this file is not needed anymore.
@@ -145,7 +145,7 @@ Upgrade Notes
145145
|st2| v2.0
146146
----------
147147

148-
* `st2ctl reload` now also registers rules by default. Prior to this release we used to register
148+
* ``st2ctl reload`` now also registers rules by default. Prior to this release we used to register
149149
actions, aliases, sensors, triggers and configs. Now rules are also registered by default.
150150

151151
|st2| v1.6

0 commit comments

Comments
 (0)