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

GitBook's own version control: yay or nay? #41

Closed
contraexemplo opened this issue Oct 23, 2019 · 9 comments
Closed

GitBook's own version control: yay or nay? #41

contraexemplo opened this issue Oct 23, 2019 · 9 comments

Comments

@contraexemplo
Copy link
Contributor

@contraexemplo contraexemplo commented Oct 23, 2019

I merged the new organization again and GitBook didn't render it right again (don't worry, I reverted the merge!). So I have a new idea:

GitBook offers the following feature:

  • We can sync as many branches as we want from GitHub
  • We are also able to transform them into versions (doc version 1.0.0, etc) publicly accessible to anyone or delete a whole deprecated version easily

My meta GitBook showcases this. I set up the open-collectivebranch (https://github.com/contraexemplo/metadocumentation/tree/open-collective) as the main docs/most current documentation and there's a link to the redirect branch (https://github.com/contraexemplo/metadocumentation/tree/redirect) with the old version of said documentation. We could do the same for the new organization while keeping the old version live as well.

@contraexemplo

This comment has been minimized.

Copy link
Contributor Author

@contraexemplo contraexemplo commented Oct 23, 2019

@contraexemplo

This comment has been minimized.

Copy link
Contributor Author

@contraexemplo contraexemplo commented Oct 25, 2019

Follow up after the meeting I had with @alanna: I will try this tomorrow and see how it goes. We agreed that we are at a point of the project that moving on to other tasks will be more beneficial to the docs. We also agreed that talking to the developers about developing a strategy to document new versions of the app is much needed—and if we choose to stick with GitBook in the end, this feature may be handy.

Tasks for tomorrow:

  • Check the Releases functionality page again to identify the best strategy for our documentation
  • Perform some tests on my test GitBook
  • Stage changes through GitBook
  • Evaluation: did it work as expected?
  • Write a blog post about all of this!
@contraexemplo

This comment has been minimized.

Copy link
Contributor Author

@contraexemplo contraexemplo commented Oct 25, 2019

@alanna I was able to successfully import and render the new organization using the Release functionality: https://docs.opencollective.com/help/v/v2/

@alanna

This comment has been minimized.

Copy link
Contributor

@alanna alanna commented Oct 28, 2019

Great! It looks good. So is the plan to continue editing the V2 release and then migrate it to be the main docs by the end of the project?

@contraexemplo

This comment has been minimized.

Copy link
Contributor Author

@contraexemplo contraexemplo commented Oct 28, 2019

@alanna Yes, we would mark it as the main branch and it would take the place from the current documentation.

@contraexemplo

This comment has been minimized.

Copy link
Contributor Author

@contraexemplo contraexemplo commented Nov 5, 2019

v2 is now the default docs for everyone on GitBook but I need to make a change here to make that branch the main one here. @alanna I don't have the access permissions to do this, would you be able to make that change?

@alanna

This comment has been minimized.

Copy link
Contributor

@alanna alanna commented Nov 6, 2019

I'm not sure how to do that, @contraexemplo - I think I succeeded in making you an admin of this repo just now so can you try again? If you need me to do it let me know how.

@contraexemplo

This comment has been minimized.

Copy link
Contributor Author

@contraexemplo contraexemplo commented Nov 7, 2019

Thanks @alanna! v2 is now the main branch on GitBook and GitHub. 🎉

@alanna

This comment has been minimized.

Copy link
Contributor

@alanna alanna commented Nov 8, 2019

@contraexemplo can you change "V2" to something more descriptive like "help" or "docs" so it shows up here?

Screen Shot 2019-11-08 at 1 15 11 PM

@contraexemplo contraexemplo moved this from To do to Done in Google Season of Docs 2019 Nov 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2 participants
You can’t perform that action at this time.