Skip to content

Migrate docs to Gitbook#222

Merged
asfgit merged 46 commits intoapache:masterfrom
tbouron:experiment/gitbook
Oct 25, 2017
Merged

Migrate docs to Gitbook#222
asfgit merged 46 commits intoapache:masterfrom
tbouron:experiment/gitbook

Conversation

@tbouron
Copy link
Member

@tbouron tbouron commented Oct 16, 2017

tbouron and others added 30 commits October 16, 2017 14:54
Adds gitbook to packages.json so you don't have to explicitly install
it. Integrates gitbook into npm to make it nice and fast to get started.
`npm install` will install everything and set up gitbook; `npm run
serve` and `npm run build` will run the equivalent gitbook commands. No
need to worry about gitbook being on the path or being globally
installed.

Also a couple of other tweaks to remove some npm and gitbook warning
messages.
They do not render correctly with GitBook. They are also redundant:
GitBook will automatically apply it to external links.
In HTML, provide a hint that the OS selection buttons are at the top of
the page. Add headers to each language section so it makes sense when
rendered as PDF.
Must not use hyphens in gitbook variable names
Copy link
Member

@m4rkmckenna m4rkmckenna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome @tbouron & @rdowner

If there are no objections ill merge this shortly

@tbouron
Copy link
Member Author

tbouron commented Oct 25, 2017

Thanks @m4rkmckenna !

However, can you hold off a wee bit more? I just realised that while internal relative links are perfectly fine for the docs, it might cause issues for downstream projects therefore I would like to update those links to use the same trick we did before, i.e. {{book.url}}/relative/path/to/root.md.

I'll ping you once it's done

@tbouron
Copy link
Member Author

tbouron commented Oct 25, 2017

@m4rkmckenna Done, should be good to go now

@m4rkmckenna
Copy link
Member

Thanks @tbouron merging now

@asfgit asfgit merged commit 5af439f into apache:master Oct 25, 2017
asfgit pushed a commit that referenced this pull request Oct 25, 2017
ahgittin added a commit to ahgittin/brooklyn-docs that referenced this pull request Sep 4, 2018
This reverts commit 6dee84d, reversing
changes made to e1d08e5.
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.

4 participants