Skip to content

Commit 411536e

Browse files
author
Dmitri Zimine
committed
Addressing review comments.
1 parent ee89dfc commit 411536e

3 files changed

Lines changed: 11 additions & 9 deletions

File tree

docs/source/packs.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ Managing Packs
2828
Exchange <https://exchange.stackstorm.org>`_. To make it happen, we deprecated few old things.
2929
Check the :doc:`upgrade notes </upgrade_notes>` and :doc:`/reference/pack_management_transition`.
3030

31-
|st2| packs are managed through ``st2 pack ...`` commands: ``st2 pack -h`` will give you a useful overview if you just need a quick start.
31+
|st2| packs are managed through ``st2 pack ...`` commands: ``st2 pack -h`` will give you a useful
32+
overview if you just need a quick start.
3233

33-
A few packs (such as the ``core`` pack for basic StackStorm actions) come pre-installed with StackStorm. ``list`` and ``get`` are the primary commands to work with local packs:
34+
A few packs (such as the ``core`` pack for basic StackStorm actions) come pre-installed
35+
with StackStorm. ``list`` and ``get`` are the primary commands to work with local packs:
3436

3537
.. code-block:: bash
3638
@@ -153,7 +155,7 @@ The value must be a colon delimited string of directory paths. For example:
153155
Directories are always searched from left to right in the order they are
154156
specified, with the system packs directory always searched first.
155157

156-
Pack configuration is represented by ```/opt/stackstorm/<packname>.yaml``` and must
158+
Pack configuration is represented by ```/opt/stackstorm/configs/<packname>.yaml``` and must
157159
conform to a configuration schema, ```config.schema.yaml``` file in pack's directory.
158160
Details of this powerful functionaltiy are in :doc:`/reference/pack_configs` section.
159161

docs/source/reference/pack_management_transition.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Good bye st2contrib, long live StackStorm Exchange
2727
--------------------------------------------------
2828

2929
`StackStorm Exchange <https://exchange.stackstorm.org/>`__ is the new pack index maintained by the StackStorm team. Any pack from StackStorm Exchange can be installed with ``st2 pack install <pack>``
30-
in the CLI. No WebUI support yet.
30+
in the CLI.
3131

3232
Exchange packs are hosted in the `StackStorm-Exchange organization
3333
<https://github.com/stackstorm-exchange>`__ on GitHub. To submit **a new pack** to the StackStorm Exchange, follow the instructions in

docs/source/reference/packs.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Canonical pack as laid out on the file system.
2626
requirements-tests.txt # requirements for python tests
2727
icon.png # 64x64 .png icon
2828
29-
Some old packs also have a configuration file at ``/opt/stackstorm/configs/<pack_name>.yaml``
29+
Some old packs also have a configuration file at ``/opt/stackstorm/<pack_name>/config.yaml``
3030
that defines any shared configuration used by the actions and sensors, e.g. usernames, region names, hostnames, etc. New pack rely on :doc:`configuration schema</reference/pack_configs>` and keep their configuration files under ``/opt/stackstorm/configs```.
3131

3232
At the topmost level are the main folders ``actions``, ``rules``, ``sensors``, ``aliases`` and ``policies`` as well as some shared files:
@@ -158,9 +158,9 @@ The following example simply echoes a greeting.
158158

159159
.. literalinclude:: /../../st2/contrib/hello_st2/policies/policy1.yaml
160160

161-
8. Install the pack. We encourage using git, if you do so, ``st2 pack`` will greatly simplify
162-
your pack management. However you can figure out your own workflow for editing and versioning packs;
163-
you'll be placing the files to ``/opt/stackstorm/packs`` and [re-]loading the content.
161+
8. Install the pack. We encourage using git, if you do so, ``st2 pack`` will greatly simplify your
162+
pack management. However you can define your own tools and workflow for editing and versioning
163+
packs; you'll be placing the files to ``/opt/stackstorm/packs`` and [re-]loading the content.
164164

165165
7.1 Use git and ``pack install`` (**recommended**):
166166

@@ -173,7 +173,7 @@ you'll be placing the files to ``/opt/stackstorm/packs`` and [re-]loading the co
173173
st2 pack install file:///$PWD
174174
175175
When you make code changes, ``run st2 pack install`` again: it will do the upgrade.
176-
Once you push it to GitHub, you could install or update it right from there: ::
176+
Once you push it to GitHub, you will install and update it right from there: ::
177177

178178
st2 pack install https://github.com/MY/PACK
179179

0 commit comments

Comments
 (0)