nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 21:19:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
hookshot/docs/SUMMARY.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

Add skeleton for docs
2021-11-29 10:26:11 +00:00
# Summary
Add some nice emoji titles to summary (#110) * Add some nice emoji titles to summary * Create 110.docs * Rename 110.docs to 110.doc
2021-12-28 18:07:43 +00:00
- [ℹ️ Hookshot](./hookshot.md)
- [⚙️ Setup](./setup.md)
- [📃 Sample Configuration](./setup/sample-configuration.md)
Imporve the README for first time readers (#726) * New README * Plural feeds * Add a nice screeny * Apply wordsmithing Co-authored-by: Justin Carlson <justinc@element.io> * Actually reference the screenshot * Better screenshot --------- Co-authored-by: Justin Carlson <justinc@element.io>
2023-04-24 15:48:00 +01:00
- [Feeds](./setup/feeds.md)
Figma Support (#105) * Add support for Figma files * tweaks * Final pieces needed for support * Documentation * Add config check * Support using an alternative userId for Figma (to support legacy bots) * Reinstate key fixer * lint
2022-01-06 17:13:58 +00:00
- [Figma](./setup/figma.md)
Add skeleton for docs
2021-11-29 10:26:11 +00:00
- [GitHub](./setup/github.md)
- [GitLab](./setup/gitlab.md)
- [JIRA](./setup/jira.md)
Add support for prometheus (#99) * Add support for prometheus metrics * Automatically build metrics documentation * Slight linter tidyup * add changelog * fix workflow * hush yarn
2021-12-16 15:05:03 +00:00
- [Webhooks](./setup/webhooks.md)
Add some nice emoji titles to summary (#110) * Add some nice emoji titles to summary * Create 110.docs * Rename 110.docs to 110.doc
2021-12-28 18:07:43 +00:00
- [👤 Usage](./usage.md)
Add documentation on various things (#90) * Add details on webhooks * More doc things * More docs * More documentation changes * Tidy tidy * Lots more documentation * Support defaults for all GitHub configuration options * Add metrics changes * s/Added/Add
2021-12-21 16:41:19 +00:00
- [Dynamic Rooms](./usage/dynamic_rooms.md)
- [Authenticating](./usage/auth.md)
- [Room Configuration](./usage/room_configuration.md)
- [GitHub Repo](./usage/room_configuration/github_repo.md)
Add setup command for GitLab (#321) * Cleanup gitlab auth command * Add support for the `!hookshot gitlab project` command * Improve docs * changelog * add new page * Wording Co-authored-by: Tadeusz Sośnierz <tadzik@tadzik.net> * Remove useless comment Co-authored-by: Tadeusz Sośnierz <tadzik@tadzik.net>
2022-04-26 16:04:24 +01:00
- [GitLab Project](./usage/room_configuration/gitlab_project.md)
Add commands to remove/list Jira connections (#503) * Add commands to remove/list Jira connections * Add docs page for Jira connections * Clarify "instance" and webhook reqs in Jira docs - Jira has "instances" instead of "organizations", so use the former term - Don't suggest that webhook support can work for multiple instances - Mention that webhooks require special access - Make some minor grammar changes
2022-10-03 09:54:14 -04:00
- [JIRA Project](./usage/room_configuration/jira_project.md)
Add some nice emoji titles to summary (#110) * Add some nice emoji titles to summary * Create 110.docs * Rename 110.docs to 110.doc
2021-12-28 18:07:43 +00:00
- [📊 Metrics](./metrics.md)
Add Sentry support (#754) * Add sentry support * Add basic listening for errors on express. * Additional event types * Add a default config * changelog * Improve wording * Add docs
2023-05-18 12:05:23 +01:00
- [Sentry](./sentry.md)
Add troubleshooting doc. (#882) * Add troubleshooting doc. * Create 882.doc Signed-off-by: Will Hunt <will@half-shot.uk> * Rename 882.doc to 882.doc Signed-off-by: Will Hunt <will@half-shot.uk> --------- Signed-off-by: Will Hunt <will@half-shot.uk>
2024-01-16 09:43:56 +00:00
- [🆘 Troubleshooting](./troubleshooting.md)
Add some nice emoji titles to summary (#110) * Add some nice emoji titles to summary * Create 110.docs * Rename 110.docs to 110.doc
2021-12-28 18:07:43 +00:00
Add contributing file (#134) * Add contributing file * Rewrite and point at matrix-appservice-bridge * Add documentation * Ensure we install matrix-appservice-bridge when building docs * Also install for release * changelog * add contrib file * Remove artifact step, it doesn't render so nicely * Update README.md
2022-06-08 16:30:46 +01:00
# 🧑‍💻 Development
- [Contributing](./contributing.md)
Fix mdbook title
2021-12-28 19:59:19 +00:00
# 🥼 Advanced
Add some nice emoji titles to summary (#110) * Add some nice emoji titles to summary * Create 110.docs * Rename 110.docs to 110.doc
2021-12-28 18:07:43 +00:00
- [Provisioning](./advanced/provisioning.md)
- [Workers](./advanced/workers.md)
Add support for native e2ee (#299) * Add support for native e2ee * Various temps to coax it into working * Formatting nitpicks * Include stable registration config key for msc2409 * Update default config with encryption options * Manage admin rooms with bot-sdk DMs This also enables encryption for new admin rooms when appropriate. * Update config comments for encryption settings - Add comment to clarify Redis (the `queue` section) must be configured in order for encryption to work - Mention that the `encryption` section is optional, and omitting it will disable encryption support * Update docs for encryption support * Add changelog * Add to docs some notes about encryption state * Move all post-join logic to onRoomJoin * Block post-join actions on crypto setup Requires https://github.com/turt2live/matrix-bot-sdk/pull/269 * Fix linter error * Update encryption docs and changelog - Mention that worker mode isn't supported with encryption yet - Mention removal of Pantalaimon-based encryption * Update worker docs with encryption config notice * Share main appservice config with feed bots This is required to safely enable encryption for the bots that post GenericHook messages. * Make slight clarification for queue config * Minor fixes * Block post-join actions on feed bot crypto setup Same as a9e6e11d but for the sub-bots that post GenericHook messages. * Get joined rooms from intent instead of bot This refreshes the list of known rooms for crypto events. * Use Element fork of bot-sdk for crypto fixes Co-authored-by: Andrew Ferrazzutti <andrewf@element.io>
2022-12-09 15:25:36 +00:00
- [🔒 Encryption](./advanced/encryption.md)
Add Generic Webhooks Widget interface (#140) * Start work on improved widget interface for admin room * Add changes needed for InviteView * More widget bits * Lots more work to support setup widgets * Redesign work * Fix build order for web * Remove unused invite code * Update configs * Cleanup * Support widget branding * Tidy up web app * Support generic service config lookup * Stronger typings for configuration * Improve error text * fix patch * changelog * First pass on documentation * Fix tests * fixes * Don't require room state / admin rooms for room config requests * Fix no render when secrets isn't provided * rework if logic * Fixes after feedback * more review fixes * Cleanup unused code * fix indent * Update matrix-appservice-bridge to 4.0.1 * Update widget API
2022-04-08 16:16:12 +01:00
- [🪀 Widgets](./advanced/widgets.md)
Implement separate bot users per service (#573) * Add service bots config * Add joined rooms manager and keep track of joined rooms * Add bot users manager and ensure registration and profiles * Improve joined rooms manager and set up already joined rooms * Handle invites with service bots * Handle messages with service bots * Use service bots for connections * Use service bots in widget and provisioning APIs * Use service bots in setup connections * Use service bots for feed connections * Handle admin rooms for service bots * Fix confused event type and service type in provisioning and widget APIs * Fix generic webhooks service name * Fix enabled services config * Handle power level change * Create widgets with service scope * Use service bots for gitlab repo connections * Use service bots for gitlab issue connections * Use service bots for generic webhook connections * Use service bots for figma file connections * Use service bots when verifying state events * Use service bots for github repo connections * Use service bots for github discussion connections * Use service bots for github discussion space connections * Use service bots for github project connections * Use service bots for github issue connections * Use service bots for github user space connections * Use service bots for jira connections * Make sure ghost users are invited for gitlab issue comments * Configure one service per service bot * Add changelog * Update tests * Fix up following rebase * Fix comment * Use getter for enabled services * Ensure homeserver can be reached before registering bots * Add intent getter on bot user * Update config comment * Merge joined rooms manager with bot users manager * Remove unused localpart from bot user class * Refactor to pass in bot users manager * Improve priority sort function Co-authored-by: Christian Paul <christianp@matrix.org> * Fix priority sort Higher priority should come first * Add debug log when invites are rejected * Use different state key for scoped setup widgets * Use different subtitles to differentiate service bots setup widgets * Refactor bot user setup into bot users manager * Refactor to reduce duplication in widget API * Consistent room ID and intent args order * Add docs and update changelog * Add overrideUserId deprecation warning * Add service bots link Co-authored-by: Christian Paul <christianp@matrix.org> Co-authored-by: Will Hunt <will@half-shot.uk>
2023-01-13 10:32:09 -05:00
- [Service Bots](./advanced/service_bots.md)
Reference in New Issue Copy Permalink