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

Github book #20

Open
pricelessbrewing opened this issue Aug 13, 2018 · 5 comments
Open

Github book #20

pricelessbrewing opened this issue Aug 13, 2018 · 5 comments
Assignees

Comments

@pricelessbrewing
Copy link

Link to github book doesn't work, looks like github book has changed versions and it links to the legacy version.

When I create an account and login, I don't see the brewtarget book at all.

Any particular reason github book is being used in the first place? Perhaps switch to github pages?

@malavv
Copy link
Contributor

malavv commented Aug 13, 2018

Gitbook is a great choice for book editing.

It has offline editing with a WYSIWYG, versioning, simplified management of collaboration, and localization. It's easy to see why this team is growing fast.

Github Pages is making exactly that, a webpage. You could implement a build system managing the book pages with hooks, but this is just a crude and prone to break way of getting to the same results (it's what we had before)

Now, I must say, it's been a while since the last time I went and looked at the manual. As you pointed out, everything seems broken since their move to the latest version. I applied their "automatic" conversion tool, but the results seems far from satisfactory.

Gitbook's flow used to be the same as Github, where you fork a book, edit it, and push a change request. Looking at their new UI, I'm not sure this is still the case. It looks like you need to be part of an organization, and have been added as a writer.

I'll take a look at it tonight, and try to fix this. I'll send you an invitation to be a writer after that. Then, we can discuss about what might be the process where we make someone a writer.

You can find Brewtarget's (currently broken) User Manual here.

@malavv malavv closed this as completed Aug 13, 2018
@malavv malavv reopened this Aug 13, 2018
@malavv
Copy link
Contributor

malavv commented Aug 15, 2018

Alright so after looking into this, here is my summary.

I suggest we keep using the legacy version of the Gitbook tool. From a practical perspective, it only means changing the URL to the following:

I do not believe changing version is imperative, as their documentation seem to indicate the change is very optional at the moment. While offering nearly nothing new, the new version of Gitbook looses (for the moment) the following features (as they are not yet implemented)

  • Localization
  • Exporting to PDF
  • Having a desktop WYSIWYG editor

If anyone wants to edit the book, the process is still the same.

  1. Going to Github and forking the manual.
  2. Edit the book
    1. Either manually using traditional Markdown editors
    2. Or using the legacy editor by signin in to legacy.gitbook.com and creating a personal book linked with this Github content.
  3. Make a normal pull request on Github for your changes to be merged.

@GBayliss
Copy link

This is still broken on http://www.brewtarget.org/

Can't say that I could figure out what was happening with gitbook, it tried to get me to create and organization and all sorts of nonsense only to find that the brewtarget information is nowhere to be found. Does anyone have rights to update the website and point users to the latest builds and documentation instead of going round in circles?

@mikfire
Copy link
Contributor

mikfire commented Nov 14, 2022

I will see if I was ever granted that level of access. Otherwise, I will try if I can find @rocketman768 and ask him to either grant me access or put in a redirect or something.

@malavv
Copy link
Contributor

malavv commented Nov 14, 2022 via email

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

No branches or pull requests

4 participants