Update docs: allowing GitLab SSH URLs to be used on pack download #1022
Conversation
Fix sphinx-autobuild host argument Set the Ubuntu base image to a version where Python 3.6 is the default
lcsaa
changed the title
Minor rewording to highlight GitLab URL support added in 3.4.
docs/source/packs.rst
Outdated
| @@ -133,6 +133,10 @@ version or **upgrade to latest** if the version is not specified. Your config fi | |||
| overwritten, so you can revert to an older version just as easily, but for production deployments | |||
| we recommend to always specify versions in case there are major changes in ``latest``. | |||
|
|
|||
| .. note:: | |||
|
|
|||
| New feature! As of StackStorm 3.4. It is also possible to download and install packs from GitLab using a SSH based URL through the web interface in the Actions section. | |||
There was a problem hiding this comment.
Looks like the section promises a new feature installing pack from gitlab server via Web UI only, while it's just a new format for pack install. IMO new format addition doesn't worth a dedicated "New Feature" Note, but I'm not opposed if we do that.
This change relates to StackStorm/st2#5050 PR and I think it would be enough providing an example with gitlab@ syntax somewhere in the "Installing a Pack" section above.
There was a problem hiding this comment.
@armab @asthLucas I've updated where the gitlab url is mentioned in the doc based on review comment.
I've based the example on what is in StackStorm/st2#5050 PR.
However I have to say that I have been using the git@ successfully with gitlab, so I'm not sure what scenarios require gitlab@.
|
LGTM |
| st2 pack install git@github.com/emedvedev/chatops_tutorial | ||
|
|
||
| # Install your own pack using gitlab URL (added in release 3.4) | ||
| st2 pack install gitlab@gitlab.com:example/examplepack |
Update docs/source/packs.rst
Fix sphinx-autobuild host argument
Set the Ubuntu base image to a version where Python 3.6 is the default