docs: shortens readme due to new tools site docs#424
docs: shortens readme due to new tools site docs#424lukegalbraithrussell merged 2 commits intomainfrom
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #424 +/- ##
=======================================
Coverage 99.85% 99.85%
=======================================
Files 7 7
Lines 702 702
=======================================
Hits 701 701
Misses 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
zimeg
left a comment
There was a problem hiding this comment.
LGTM and thanks for such a fast follow up on this 🙏 ✨
I left a comment around wording and calling out the tools.slack.dev link that aren't blocking, and a section that perhaps we can follow up on later? Having a single source of truth for now is exciting! 📚
| ## Sending variables | ||
|
|
||
| There are different [techniques to send data](#sending-techniques) into Slack | ||
| and whichever one is chosen will require a certain set of customized inputs, as | ||
| described later. | ||
|
|
||
| You can provide data to send to Slack from this GitHub Action and either source: | ||
|
|
||
| - The default event [context][event-context] with a [payload][event-payload] | ||
| matching the GitHub event. | ||
| - A custom payload with optional [variables][variables] provided in the GitHub | ||
| Action step. | ||
|
|
||
| These input options are valid for all techniques, but some techniques require | ||
| specific constraints with certain requirements for valid inputs. | ||
|
|
||
| Additional [configurations](#additional-configurations) and other details are | ||
| also available for more customizations to the provided payload. |
There was a problem hiding this comment.
🤔 I'm thinking this section might be nice to include on the website's sidebar?
Linking to a specific technique left some confusion about these details for me 🔍
There was a problem hiding this comment.
ohhh yeah i can see that. i'll make a follow up task!
Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>
Summary
README short because docs site long
Requirements (place an
xin each[ ])