getslashdeploy / roadmap

Manage your deployments without leaving Slack
https://getslashdeploy.com
2 stars 0 forks source link

Customizable usage message #9

Closed assimovt closed 5 years ago

assimovt commented 5 years ago

It would be nice to have a customizable help/how message to teach new users how to /deploy. What do you think of a an entry in .slashdeploy.yml that's markdown that's access via /deploy usage or similar

assimovt commented 5 years ago

Now /deploy help <repo> πŸ“–is available in SlashDeploy πŸŽ‰

From the updated documentation:

The free-form usage text to let your users know of anything special about deploying this repository. For instance, supported deployment tasks, locking conventions, or even deployment/code ownership. You can also use Slack formatting and emojis in here. Users can then read the usage help with /deploy help <repo> command.

Simply, add usage section in your .slashdeploy.yml file and you're all set. Here is an example:

usage: |
  *Usage doc on how to deploy this repo:*

  You can even use Slack formatting with emojis :raised_hands:

Enjoy!