Skip to content

[WIP] Packs documentation #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emedvedev merged 14 commits into from
Nov 28, 2016
Merged

[WIP] Packs documentation #312

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3b5f757
Update pack docs
emedvedev Nov 11, 2016
c440961
Refinements
emedvedev Nov 11, 2016
878cd6a
Update upgrade notes.
Kami Nov 11, 2016
45c9713
Fix most of the contrib references
emedvedev Nov 11, 2016
18cc330
Fix @LindsayHill's comments
emedvedev Nov 11, 2016
d4176b0
Bring back dontrib reference and fix a typo
Nov 23, 2016
8057b10
Merge remote-tracking branch 'origin/master' into packs-docs
Nov 23, 2016
ec0265c
Fix the installation step for "working with packs"
emedvedev Nov 23, 2016
d85b184
Add the new page for migration notes and reference it in the "upgrade…
emedvedev Nov 23, 2016
2b14ecc
added orphan to reference/exchange so tests pass
LindsayHill Nov 23, 2016
020ddd1
Addressing comments
emedvedev Nov 28, 2016
c1b807b
ChatOps section
emedvedev Nov 28, 2016
cf43e79
Fix the new image links
emedvedev Nov 28, 2016
1880d85
Remove extra deploy reference
emedvedev Nov 28, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,17 @@ sphinx-autobuild -H 127.0.0.1 -b html ./docs/source/ ./docs/build/html

:github_st2:`st2/st2common/st2common/operators.py </st2common/st2common/operators.py>`

* Link to Github st2contrib repo:
* Link to Github StackStorm-Exchange org:

:github_contrib:`Link to docker README on st2contrib<packs/docker/README.md>`
:github_exchange:`Link to a sensu pack repo inside Exchange<stackstorm-sensu>`

* Link to st2contrib and st2incubator repos on Github (using a global we set up in source/conf.py)
* Link to StackStorm Exchange website with a filter query:

`st2contrib`_
`st2incubator`_
:web_exchange:`Sensu<sensu>`

* Link to the Exchange website on Github (using a global we set up in source/conf.py)

`exchange`_

* The pattern to include an example from `/st2/contrib/examples`: make example file name a reference on github. May say that it is deployed to `/usr/share/doc/st2/examples/`, and auto-include the file:

Expand Down
4 changes: 2 additions & 2 deletions docs/source/actions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ passed in, action will be considered as failed (first flag in the result tuple
indicating action status is ``False``).

For a more complex example, please refer to the `actions in the Libcloud pack in
the contrib repository <https://github.com/StackStorm/st2contrib/tree/master/packs/libcloud/actions>`_.
StackStorm Exchange <https://github.com/StackStorm-Exchange/libcloud/tree/master/actions>`_.

Configuration File
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -663,7 +663,7 @@ To see all predefined actions:

.. rubric:: What's Next?

* Explore packs and actions contributed by |st2| developers and community in the `StackStorm st2contrib repo on Github <https://github.com/StackStorm/st2contrib/>`_.
* Explore packs and actions contributed by |st2| developers and community in the `StackStorm Exchange <https://exchange.stackstorm.org>`_.
* Check out `tutorials on stackstorm.com <http://stackstorm.com/category/tutorials/>`__ on creating actions, and other practical examples of automating with |st2|.

.. _JSON Schema: http://json-schema.org/documentation.html
Expand Down
2 changes: 1 addition & 1 deletion docs/source/chatops/notifications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Notifications
If you read through the :ref:`ref-chatops` section, you are familiar with notifications.
Even without ChatOps, notifications can be used to post messages to external systems
like Chat clients, send emails etc. Notifications require an action that is registered with
|st2| (e.g., the `post_message <https://github.com/StackStorm/st2contrib/blob/master/packs/slack/actions/post_message.yaml>`_ action in the the ``slack`` pack)
|st2| (e.g., the `post_message <https://github.com/StackStorm-Exchange/slack/tree/master/actions/post_message.yaml>`_ action in the the ``slack`` pack)

@humblearner humblearner Nov 15, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/slack/stackstorm-slack

and a notification rule to go with it. Notifications are implemented as triggers, rules and actions.
A special ``core.st2.notifytrigger`` is emitted by the system on completion of every action.
A rule to match the trigger to a notify action results in notifications being sent out.
Expand Down
9 changes: 6 additions & 3 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,14 @@ def previous_version(ver):
'github_mistral': ('https://github.com/StackStorm/mistral/tree/master/%s', None),
'github_contrib':
('https://github.com/StackStorm/st2contrib/tree/master/%s', None),
'github_exchange':
('https://github.com/StackStorm-Exchange/%s', None),
'github_devenv': ('https://github.com/StackStorm/devenv/tree/master/%s', None),
'github_st2web': ('https://github.com/StackStorm/st2web/tree/master/%s', None),
'ops_latest':
('https://downloads.stackstorm.net/releases/st2/' + release + '/%s/', None)
('https://downloads.stackstorm.net/releases/st2/' + release + '/%s/', None),
'web_exchange':
('https://exchange.stackstorm.org/#%s', None),
}

# Inserted at the bottom of all rst files.
Expand All @@ -124,8 +128,7 @@ def previous_version(ver):

rst_epilog = """
%s
.. _st2contrib: http://www.github.com/stackstorm/st2contrib
.. _st2incubator: http://www.github.com/stackstorm/st2incubator
.. _exchange: https://exchange.stackstorm.org/
.. |bwc| replace:: Brocade Workflow Composer
.. |ipf| replace:: IP Fabric Automation Suite
""" % product_replace
Expand Down
4 changes: 2 additions & 2 deletions docs/source/install/deb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Ubuntu / Debian
===============

If you're just looking for a "one-liner" installation, check the :doc:`top-level install guide </install/index>`. Otherwise, you
If you're just looking for a "one-liner" installation, check the :doc:`top-level install guide </install/index>`. Otherwise, you
can use this guide for step-by step instructions for installing |st2| on a single Ubuntu/Debian 64 bit system as per
the :doc:`Reference deployment </install/overview>`.

Expand Down Expand Up @@ -111,7 +111,7 @@ Verify
-----------------

At this point you have a minimal working installation, and can happily play with |st2|:
follow :doc:`/start` tutorial, :ref:`deploy examples <start-deploy-examples>`, explore and install packs from `st2contrib`_.
follow :doc:`/start` tutorial, :ref:`deploy examples <start-deploy-examples>`, explore and install packs from `StackStorm Exchange <https://exchange.stackstorm.org>`__.

But there is no joy without WebUI, no security without SSL termination, no fun without ChatOps, and no money without Brocade Workflow Composer. Read on, move on!

Expand Down
4 changes: 2 additions & 2 deletions docs/source/install/rhel6.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
RHEL 6 / CentOS 6
=================

If you're just looking for a "one-liner" installation, check the :doc:`top-level install guide </install/index>`. Otherwise, you
If you're just looking for a "one-liner" installation, check the :doc:`top-level install guide </install/index>`. Otherwise, you
can use this guide for step-by step instructions for installing |st2| on a single RHEL 6/CentOS 6 64 bit system per
the :doc:`Reference deployment </install/overview>`.

Expand Down Expand Up @@ -181,7 +181,7 @@ Verify

At this point you have a minimal working installation, and can happily play with |st2|: follow
:doc:`/start` tutorial, :ref:`deploy examples <start-deploy-examples>`, explore and install packs
from `st2contrib`_.
from `StackStorm Exchange <https://exchange.stackstorm.org>`__.

But there is no joy without WebUI, no security without SSL termination, no fun without ChatOps,
and no money without Brocade Workflow Composer. Read on, move on!
Expand Down
4 changes: 2 additions & 2 deletions docs/source/install/rhel7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
RHEL 7 / CentOS 7
=================

If you're just looking for a "one-liner" installation, check the :doc:`top-level install guide </install/index>`. Otherwise, you
If you're just looking for a "one-liner" installation, check the :doc:`top-level install guide </install/index>`. Otherwise, you
can use this guide for step-by step instructions for installing |st2| on a single RHEL 7/CentOS 7 64 bit system per
the :doc:`Reference deployment </install/overview>`.

Expand Down Expand Up @@ -153,7 +153,7 @@ Verify
-----------------

At this point you have a minimal working installation, and can happily play with |st2|:
follow :doc:`/start` tutorial, :ref:`deploy examples <start-deploy-examples>`, explore and install packs from `st2contrib`_.
follow :doc:`/start` tutorial, :ref:`deploy examples <start-deploy-examples>`, explore and install packs from `StackStorm Exchange <https://exchange.stackstorm.org>`__.

But there is no joy without WebUI, no security without SSL termination, no fun without ChatOps, and no money without Brocade Workflow Composer. Read on, move on!

Expand Down
Loading