integrations: Update Openshift Documentation.

I have updated the Openshift docs to include numbers to increase its
readability.

Fixes part of #17633.
This commit is contained in:
Adam Birds
2021-03-15 22:15:01 +00:00
committed by Tim Abbott
parent 132bae3850
commit 3a91f5baf6

View File

@@ -1,43 +1,43 @@
This integration sends a notification every time a deployment is made
in an OpenShift instance.
{!create-stream.md!}
1. {!create-stream.md!}
{!download-python-bindings.md!}
1. {!download-python-bindings.md!}
Then, create a new commit including all the changes made to the
repository, and push it to your app.
1. Then, create a new commit including all the changes made to the
repository, and push it to your app.
After that, connect to the application through SSH. If you dont know
how to do this, log in to your OpenShift Online account, go to your
applications dashboard, and click **Want to log in to your
application?**. There youll find the apps SSH user, address, and
further information on SSH, in case you need it.
1. After that, connect to the application through SSH. If you dont know
how to do this, log in to your OpenShift Online account, go to your
applications dashboard, and click **Want to log in to your
application?**. There youll find the apps SSH user, address, and
further information on SSH, in case you need it.
![Connecting to application](/static/images/integrations/openshift/002.png)
![Connecting to application](/static/images/integrations/openshift/002.png)
{!change-zulip-config-file.md!}
1. {!change-zulip-config-file-indented.md!}
You can also specify which pushes will result in notifications and to
what stream the notifications will be sent by modifying the
`deployment_notice_destination` function in
`zulip_openshift_config.py`. By default, deployments triggered by
commits pushed to the `master` and `test-post-receive` branches will
result in a notification to stream `deployments`.
1. You can also specify which pushes will result in notifications and to
what stream the notifications will be sent by modifying the
`deployment_notice_destination` function in
`zulip_openshift_config.py`. By default, deployments triggered by
commits pushed to the `master` and `test-post-receive` branches will
result in a notification to stream `deployments`.
Save the file, and symlink
`$OPENSHIFT_PYTHON_DIR/virtenv/share/zulip/integrations/openshift/post-receive`
into the `~/app-root/repo/.openshift/action_hooks` directory.
1. Save the file, and symlink
`$OPENSHIFT_PYTHON_DIR/virtenv/share/zulip/integrations/openshift/post-receive`
into the `~/app-root/repo/.openshift/action_hooks` directory.
Whenever you make a push to the `master` branch of your applications
repository (or whichever branch you configured above), or if you force
a deployment, the Zulip OpenShift plugin will send an automated
notification.
1. Whenever you make a push to the `master` branch of your applications
repository (or whichever branch you configured above), or if you force
a deployment, the Zulip OpenShift plugin will send an automated
notification.
{!congrats.md!}
![OpenShift integration message](/static/images/integrations/openshift/001.png)
**Testing**
### Testing
You can test the plugin without changing your `master` branch by pushing to the `test-post-receive` branch.