Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Notion database integration #365

Open
maxscience opened this issue May 11, 2023 · 6 comments
Open

Feature request: Notion database integration #365

maxscience opened this issue May 11, 2023 · 6 comments
Labels
discussion This issue is not supposed to be used to track work, only for discussions or spawning work effort/weeks enhancement New feature or request status/needs-clarification This issue requires further information prior to becoming ready for work status/pending This issue is not ready to be worked yet, but doesn't need clarification

Comments

@maxscience
Copy link

maxscience commented May 11, 2023

Context

At Cryptonet we use a Notion database to track milestones (have a look at our Sitrep for an example) and unfortunately it's an overhead to keep Starmaps updated and in sync with Notion.

Request

We'd like to have Starmaps sync automatically with a Notion database as it should be possible via APIs https://developers.notion.com/reference/database and in particular these properties:

This guide should also be helpful.

@SgtPooki
Copy link
Contributor

I think the best solution here would be creating a notion -> github sync that creates the github issues in your repo in a format that starmap can read.

A main feature of starmap (that we don't plan on changing) is using github as our source.

Another option would be reading from github writing to notion.

@maxscience
Copy link
Author

Indeed I implied a notion -> GitHub sync

@SgtPooki
Copy link
Contributor

SgtPooki commented May 11, 2023

Rough requirements for this to work:

  • we need notion API key
  • we need a github repo to write issues to. (where would this be for different teams? Same repo? maybe pln-planning-tools/notion-sync ?)
  • we need a scheduled github workflow that
    • reads notion database
    • converts each notion database milestone to appropriate starmap format: ETA, issue title, description, children
    • agreed upon format of 1-1 mapping from notion milestone to github issue (so updates/deletes can work)
    • writes converted milestones as github issues (or updates/deletes)
    • Closes issues marked as closed in notion

We would probably need some identifier in the notion-converted-github-issues with the notion page/block ID to ensure there is a 1-1 mapping, but this could become incredibly complex if we're using the same github repo for all notion-synced-milestones across teams. If we're NOT using the same repo for different teams notion-synced-milestones, then we run into complexity with maintaining github tokens or permissions for the gh-token user. Maybe the latter is less of a concern

@SgtPooki SgtPooki added enhancement New feature or request status/needs-clarification This issue requires further information prior to becoming ready for work discussion This issue is not supposed to be used to track work, only for discussions or spawning work status/pending This issue is not ready to be worked yet, but doesn't need clarification effort/weeks labels May 11, 2023
@github-project-automation github-project-automation bot moved this to Needs Grooming in IPFS-GUI (PL EngRes) May 12, 2023
@AlexxNica
Copy link
Collaborator

I think the best solution here would be creating a notion -> github sync that creates the github issues in your repo in a format that starmap can read.

A main feature of starmap (that we don't plan on changing) is using github as our source.

Another option would be reading from github writing to notion.

@SgtPooki what can't we add more providers instead of just GitHub? I feel like everything we could represent as a format the parser can understand would be enough. And even then we could just add plugins to parsers to integrate with more sources. Is there more context to this requirement?

@p-shahi
Copy link

p-shahi commented May 18, 2023

the libp2p team is also currently using a mix of Notion and GitHub issues to track items. Here is our Notion database: https://pl-strflt.notion.site/baa54137b67e4e4ea146d552067c8b9a?v=0bd8332f355b47b8b75a55fe76347856

It would be ideal if this Notion db could be synced to Starmap.

@maxscience
Copy link
Author

Hi @p-shahi I've outlined the Notion db proposal at https://www.notion.so/pl-strflt/SitRep-Milestones-db-template-for-EngRes-teams-0f922ee6832c4de0ad81c0b3bb59fcda?pvs=4
As if more teams adopt this db structure then the Stamps integration can be feasible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion This issue is not supposed to be used to track work, only for discussions or spawning work effort/weeks enhancement New feature or request status/needs-clarification This issue requires further information prior to becoming ready for work status/pending This issue is not ready to be worked yet, but doesn't need clarification
Projects
None yet
Development

No branches or pull requests

4 participants