GitbookIO / GitbookIO/integrations

Feature request: Slack integration - provide more context about what was updated

Open
#177 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

improvement integration-slack
Dominant language
TypeScript
Stars
131
Forks
96
Avg merge
7h 8m
Merged PRs (30d)
31

Description

Hey Gitbook team 👋

I really love that you have a Slack plugin, but right now it's not super useful outside of saying that "something was updated in x space". For example:

GitBook [App]
Content of Example Space Name has been updated

This isn't very useful information. We want to keep our wider team informed of changes to our Gitbook docs - even if they don't have a seat on Gitbook. Right now this is a very manual process, because I have to go and summarise the changes each time we push a change.

Instead, it would be lovely if the Slack integration posted a message like:

GitBook [App]
Content of Example Space Name has been updated by Firstname Lastname: Add background info on xyz

Pages updated:

This makes it super easy to understand what was changed, who changed it, and where I can see the new content. I tried to do some of this in PR #168 but unfortunately it doesn't seem that the right data is available via the API.

Hope this is something you're able to add to your backlog. Thank you! 😄

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the issue and PR #168, then verify which author, change-summary, and updated-page data the GitBook API exposes for the Slack integration. Done means the integration can post the requested actor, summary, and linked pages, or clearly documents the API limitation preventing those details.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.