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

Convert site to Jekyll. #74

Merged
merged 1 commit into from
Dec 16, 2015
Merged

Convert site to Jekyll. #74

merged 1 commit into from
Dec 16, 2015

Conversation

davidzchen
Copy link
Member

  • Converted Jsonnet website to Jekyll.
  • Add tooling for building the Jekyll tree, bringing up the site
    locally, and pushing a new version of the site to gh-pages
  • Add page to redirect users to new URL.

This is a pretty huge diff. It may be easier to digest by looking at the site branch on my fork: https://github.com/davidzchen/jsonnet/tree/site

The motivation for using Jekyll is that it is the official static site generator that is supported by GitHub. With this new pipeline, the Jsonnet website will be served out of https://google.github.io/jsonnet rather than https://google.github.io/jsonnet/doc

The way the new pipeline for publishing the site works is the following (see tools/scripts/push_docs.sh):

  1. Build a zip containing the Jekyll tree constructed from all files under doc/ and the included Jsonnet files from examples/ and benchmarks/.
  2. In a separate directory (either specified via argument to the script) clone the Jsonnet repository, git checkout gh-pages
  3. Replace the content of the repository with the contents of the zip archive containing the new version of the site.
  4. Commit and push.

I have also added a script that just builds the Jekyll tree, unzips it in a temp directory, and runs jekyll serve, which will bring up the site locally, viewable at http://localhost:4000.

@davidzchen davidzchen force-pushed the site branch 3 times, most recently from bee59fa to 04d1a98 Compare September 30, 2015 19:29
@davidzchen
Copy link
Member Author

Rebased and resolved merge conflicts.

@sparkprime
Copy link
Collaborator

Thanks. I'm in favor of this but I need to understand better what you've actually done here. We should talk about it face to face next week.

@davidzchen
Copy link
Member Author

Sounds good to me.

@davidzchen
Copy link
Member Author

I have rebased this patch and added pages to redirect users visiting the pages at the old URL to the new locations for the pages. I have all the pages locally.

* Converted Jsonnet website to Jekyll.
* Add tooling for building the Jekyll tree, bringing up the site
  locally, and pushing a new version of the site to gh-pages
* Add page to redirect users to the new URL.
* Add redirect pages to redirect users visiting the old pages (under
  /doc) to the new pages.
* Add CNAME file for jsonnet.org domain
* Add JS to redirect from http://google.github.io/jsonnet to
  http://jsonnet.org
@sparkprime
Copy link
Collaborator

This is all good, you should merge it when you're comfortable doing so

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.

2 participants