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

feat: Integrate Outline #4366

Open
wants to merge 1 commit into
base: preview
Choose a base branch
from

Conversation

SaadBazaz
Copy link

@SaadBazaz SaadBazaz commented May 4, 2024

This is a sample Pull Request as I explore the possibility to allow users to use an external knowledgebase (in this case, Outline) instead of the default Pages editor in Plane.

Why?

I've elaborated on this on Discord, and have drawn this out on X (here). Here goes another:

I believe open-source benefits better by working together, instead of rebuilding the same thing over and over. At the bare minimum, they should be interoperable with one another.

Plane and Outline are a classic case: Plane focuses on project management, Agile practices, all that. And that's what they're best at. I'd love to see them improve their project management interfaces, make them flexible and basically replace Linear. Pages? Not their strong suite.

On the other hand, knowledgebasing is pretty much the fundamental concept of Outline. What Outline lacks is dynamicity; the ability to show dynamic data which is integrated with its own knowledgebase (elaborated here). So while they focus on making their knowledgebase product strong, why not let Plane take the load of task management?

What?

I think having a godmode option which allows admins to toggle this feature, and configure Outline properly would work.

Let's say a user turns on the Outline integration. What do we expect to happen?

User stories

  • When navigating to Plane -> Projects -> my-project -> Pages, it shows empty by default (of course)
  • When the user creates their first page, it is saved in Outline under: Outline -> Plane Collection -> my-project (or a UID) -> {Page Title}
  • An iframe is creating in Plane, in which the Outline editor is shown (navigated to the created document). The user can edit there.
  • (To make it bidirectional) Whenever the document is updated on Outline, a webhook is sent to Plane. Possible events: page name changes, page deletion, page creation, etcetera.

How?

I need to identify what exactly needs to be done to achieve the above, but my first question is:

Are we even on the right track? Is there a better way to do this?

@CLAassistant
Copy link

CLAassistant commented May 4, 2024

CLA assistant check
All committers have signed the CLA.

@SaadBazaz
Copy link
Author

cc @aaryan610

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants