integration-docs: Update Github Actions for new doc format. #32781
Conversation
Niloth-p
force-pushed
the
update-docs-github-actions/pr
branch
from
d21f2d1 to
2c24ea3
Compare
|
|
||
| See also the [GitHub integration](/integrations/doc/github). | ||
| 1. {!create-a-generic-bot.md!} |
There was a problem hiding this comment.
Removed the "Note down the bot's email address and API key." line that was appended to this instruction.
| See also the [GitHub integration](/integrations/doc/github). | ||
| 1. {!create-a-generic-bot.md!} | ||
|
|
||
| 1. To send Zulip notifications whenever your workflow runs, add the |
There was a problem hiding this comment.
This was previously in 2 separate instructions, that has now been clubbed together, as they don't make much sense separately.
We introduce the action that needs to be added, and the values with which it needs to be configured in the same instruction.
|
|
||
| ### Related documentation | ||
|
|
||
| * [Zulip GitHub Actions repository][repo] |
There was a problem hiding this comment.
Since the link to the repo was added into the second instruction (in the last update), this link has been edited to re-use it, by adding the 'repo' ref link.
|
|
||
| * [Zulip GitHub Actions repository][repo] | ||
|
|
||
| * [Configuring the Zulip Send Message Action][README] |
There was a problem hiding this comment.
Configuring the Action -> Configuring the Zulip Send Message Action
|
I think this should really include steps that include the examples from https://github.com/zulip/github-actions-zulip/blob/main/send-message/README.md as the instructions for how to use this. We may not need the full set of options here; it's reasonable to say "For the full set of flags..." for that, but the sample configuration aka usage instructions for the Actions that you can copy-paste should be here. That's all you need to know, and the multiple steps of indirection that involve this not saying what to do and linking there are confusing. (It's unlikely those instructions will change materially over the next 2 years, so it's OK to duplicate them if need be). |
Fixes: Part of #29592.
Separated out from #32355.
Screenshots and screen captures:
Doc link
Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: