Notion and Confluence connectors for docs-drift

Open
#55 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python

Research direction

Start by reading the docs-drift integration and configuration entry points to find how repository documents are discovered and compared. The issue specifies Notion and Confluence Cloud, read-only access scoped to selected pages or spaces, and search, page-text, and listing tools. Done means the validation repository reports a stale Notion runbook against a changed configuration default, with links to both.

Written by the indexing model from the issue text.

Description

area: connectors idea

Idea

Let docs-drift compare code against documentation that lives outside the repository.

Problem

Many teams keep runbooks and architecture docs in Notion or Confluence. docs-drift can read only the repository, so it misses the docs people actually use.

Proposed initial scope

  • Notion and Confluence Cloud connections with read-only access to chosen pages or spaces.
  • Read tools: search pages, get a page as text, list a space's or database's pages.
  • Scope chosen when connecting, so a job can't read the whole wiki.

Validation

Change a configuration default in a test repository, leave the Notion runbook stale, and confirm docs-drift reports the mismatch with links to both.

Dominant language
Python
Stars
1
Forks
1
Avg merge
1h 9m
Merged PRs (30d)
322

Getting set up

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.

More from piotrekno1/second-shift

All issues in piotrekno1/second-shift

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.