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

Add Editorial Workflow support for GitLab and BitBucket backends #568

Open
tech4him1 opened this Issue Aug 30, 2017 · 15 comments

Comments

Projects
None yet
8 participants
@tech4him1
Copy link
Collaborator

tech4him1 commented Aug 30, 2017

- Do you want to request a feature or report a bug?
feature

The new GitLab and BitBucket backends do not support editorial workflow yet. Since GitLab's API does not support low-level metadata like GH does, we will need to find a different method.

@tech4him1 tech4him1 referenced this issue Aug 30, 2017

Closed

(WIP) Add GitLab Backend #517

8 of 10 tasks complete
@erquhart

This comment has been minimized.

Copy link
Member

erquhart commented Aug 30, 2017

Agreed - we need to start using a branch for metadata instead of an orphan ref.

@tech4him1 tech4him1 changed the title Add Editorial Workflow support for GitLab backend Add Editorial Workflow support for GitLab and BitBucket backends Sep 9, 2017

@tech4him1

This comment has been minimized.

Copy link
Collaborator

tech4him1 commented Sep 12, 2017

I also think the metadata should contain as little actual information as possible, in the event it is deleted or lost.

@tech4him1

This comment has been minimized.

Copy link
Collaborator

tech4him1 commented Sep 12, 2017

@zanedev Do you have any thoughts on implementation of this in regards to BitBucket?

@zanedev

This comment has been minimized.

Copy link
Collaborator

zanedev commented Sep 12, 2017

@tech4him1 actually I haven't put much time or thought into how the whole editorial workflow is implemented for github yet. I did notice you can manage refs with the bitbucket api though, it may be possible in a similar way as github.

@zanedev

This comment has been minimized.

Copy link
Collaborator

zanedev commented Sep 12, 2017

I imagine after we plan it out here we would break out different tasks for each backend.

@arnaudschlupp

This comment has been minimized.

Copy link

arnaudschlupp commented Jul 30, 2018

Hi!, I would like to know if discussions about this one already started or if there are blockers to start this one out. Thanks a lot fo the amazing work you are doing here 👍

@marcos-abreu

This comment has been minimized.

Copy link

marcos-abreu commented Aug 22, 2018

It would be good to understand the architecture used for Github and what were the requirements that led to it. Basically just an overview, so we could propose some solutions for it. I have some time and would love to help get this feature out of the door.

@Undistraction

This comment has been minimized.

Copy link

Undistraction commented Aug 24, 2018

Is there currently any plan to support the editorial workflow on Gitlab in the near future?

@erquhart

This comment has been minimized.

Copy link
Member

erquhart commented Aug 27, 2018

Anyone willing to take this on would need to dig into the GitHub backend to understand how it works. I'd like to see #1669 in place beforehand as well.

In a nutshell, the editorial workflow uses pull requests instead of just committing to a Git repository's main branch, and "publishes" entries by merging the PR, all of which happens via API. Things are complicated by our use of a separate metadata branch in the GitHub backend, and #1669 outlines a way forward. But that aside, automating the mechanics of pull requests (including rebasing logic) is all that's needed to add workflow support to a backend.

@rudolf-zivver

This comment has been minimized.

Copy link

rudolf-zivver commented Oct 8, 2018

We'd like to contribute, and implement Editorial Workflows for GitLab, as it'd help us a lot to manage our documentation.

I'll go for the simplest solution, and won't try refactoring common things between backends, because it's been years since the last time I used JavaScript.

We'll see how far I get in a couple of days, then we'll figure out everything else.

-Rudolf

@rudolf-zivver

This comment has been minimized.

Copy link

rudolf-zivver commented Oct 12, 2018

I managed to get Editorial Workflows for GitLab working (with localForage IndexedDB metadata storage).
I'm not yet sure whether the metadata could be inferred from branches and merge requests or have to be stored in a separate branch.

I noticed that deleting a published entry doesn't use workflow which might be confusing to users.

@rudolf-zivver

This comment has been minimized.

Copy link

rudolf-zivver commented Oct 12, 2018

I ended up implementing metadata storage in a separate branch.
I couldn't find a way to create orphan branches with the GitLab API, so that branch have to be created manually with Git, but I hope this is an acceptable tradeoff.

We'll review and test the changes internally next week.

@davidkazuhiro

This comment has been minimized.

Copy link

davidkazuhiro commented Oct 19, 2018

Will this work with GitHub Enterprise as well?

@erquhart

This comment has been minimized.

Copy link
Member

erquhart commented Oct 26, 2018

Do you mean GitLab? The GitHub backend supports GHE and already has editorial workflow support.

@davidkazuhiro

This comment has been minimized.

Copy link

davidkazuhiro commented Oct 29, 2018

Nope I meant GHE. Thanks for the clarification!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment