build: clone repository "docs" and configuration when syncing project docs #467
Conversation
There was a problem hiding this comment.
@lukegalbraithrussell LGTM! This is so nice for avoiding possible confusions of PRs around 📚 ✨
.github/workflows/sync-docs.yml
Outdated
There was a problem hiding this comment.
🪓 Thank you sync docs workflow file 🫡
docs/sidebar.js
Outdated
| link: { | ||
| type: 'doc', | ||
| id: 'slack-github-action/sending-techniques/sending-techniques', | ||
| }, |
There was a problem hiding this comment.
🔗 Ooh this is fascinating to me:
There was a problem hiding this comment.
@lukegalbraithrussell Thanks for these fast follows! JSON is a super nice improvement to the sidebar organization I believe 🤖
Please feel free to merge this whenever for testing as needed - I'm excited for something cool 🚢 💨
|
|
||
| The private repo containing the tools.slack.dev site pulls these in at build time. | ||
|
|
||
| Maintainers need to use the `run workflow` button associated with the `deploy` workflow in that private repo to update the docs with changes from here. |
There was a problem hiding this comment.
🧠 Thanks for adding this! IIRC this can be a forgotten happening after we merge kind contributions 📚 ✨
There was a problem hiding this comment.
📝 For the self: This might be useful to soon add to #439
.github/maintainers_guide.md
Outdated
| sidebar values take the form of "slack-github-action/path-within-docs/" | ||
|
|
||
| or, in other words - full path but remove "docs" |
There was a problem hiding this comment.
Nit: Having an example for this might save searches and some thinking 😉
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #467 +/- ##
=======================================
Coverage 99.86% 99.86%
=======================================
Files 7 7
Lines 722 722
=======================================
Hits 721 721
Misses 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary
This PR sets up the repo to be optimized for being pulled into slackapi.github.io's sources.json. Two main things here:
removes the outdated syncing workflow
adds the sidebar.js to this repo. This is then read into the tools docs repo. Modifying this sidebar now can happen alongside docs edits.
Requirements (place an
xin each[ ])