Pulsar website using docusaurus #2206
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
merlimat
added
doc
|
@merlimat I think we can merge this when it passed CI. since all the changes are under |
sijie
approved these changes
Jul 23, 2018
sijie
added a commit
to sijie/pulsar
that referenced
this pull request
Jul 26, 2018
### Motivation We introduced docusaurus in apache#2206 for building the new documentation site. docusaurus is using [yarn](https://yarnpkg.com/en/docs/install#mac-stable) for building. It will leave `yarn.lock` file after builds. ### Changes Add `yarn.lock` into gitignore file
merlimat
pushed a commit
that referenced
this pull request
Jul 26, 2018
### Motivation We introduced docusaurus in #2206 for building the new documentation site. docusaurus is using [yarn](https://yarnpkg.com/en/docs/install#mac-stable) for building. It will leave `yarn.lock` file after builds. ### Changes Add `yarn.lock` into gitignore file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Improve the documentation and usability of the pulsar website. This moves the website and documentation to a new framework (https://docusaurus.io/) which will make it easier to maintain going forward.
Modifications
A new version of the website in site2 directory. Also updates the pulsar build docker to add the new website build dependencies.
Result
A more usable website and documentation.
A preview of the site can be seen here: https://cckellogg.github.io/incubator-pulsar
All the links and images might not work on this site since it's a test only site