Skip to content

Remove legacy code around MS Word Terms of Service. #377

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 18, 2020
Merged

Remove legacy code around MS Word Terms of Service. #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fd5d3b
Remove legacy code around MS Word Terms of Service.
josh-padnick Nov 17, 2020
754d583
Merge branch 'master' into remove-pandoc
josh-padnick Nov 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,13 @@ ADD Gemfile.lock Gemfile.lock
RUN bundle install

# Install Java, which is required for s3_website
# Install texlive libraries, which are required for Pandoc
RUN apt-get update && \
apt-get install -y default-jre && \
apt-get install -y texlive texlive-xetex texlive-latex-recommended texlive-latex-extra texlive-lang-cjk && \
rm -rf /var/lib/apt/lists/*

# Install s3_website, which is used to publish generated files to S3
RUN s3_website install

# Install Pandoc
RUN curl -sSL https://github.com/jgm/pandoc/releases/download/2.3/pandoc-2.3-1-amd64.deb -o/tmp/pandoc.deb && \
dpkg -i /tmp/pandoc.deb && \
rm -f /tmp/pandoc.deb

# Copy source
RUN mkdir -p /src
VOLUME ["/src"]
Expand Down
16 changes: 1 addition & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,6 @@ The fastest way to launch this site is to use [Docker](https://www.docker.com/).
1. Start Jekyll server: `bundle exec jekyll serve --livereload`
1. Go to `http://localhost:4000`

## Updating /assets/msword/gruntwork-terms.docx

Jekyll will automatically generate an MS Word version of our terms of service at `/assets/msword/gruntwork-terms.docx`
using [Pandoc](https://pandoc.org/) when `docker-compose up` is first run. Unfortunately, when changes are made to
`/_data/terms-of-service.yml`, these changes do not automatically re-generate a new `gruntwork-terms.docx` file. The
current solution is to re-run `docker-compose up`.

Hopefully, in the future, Jekyll will support the ability to indicate which files should trigger which regeneration pages.

### /assets/msword/styles.docx

If you want to edit the styles used to generate `/assets/msword/gruntwork-terms.docx`, update the styles saved in
`/assets/msword/styles.docx` and re-run `docker-compose up`.

## Deploying

To deploy the site to S3/CloudFront:
Expand All @@ -47,7 +33,7 @@ To deploy the site to S3/CloudFront:

1. Built with [Jekyll](http://jekyllrb.com/). This website is completely static and we use basic HTML or Markdown for
everything.
1. Gruntwork Terms Of Service Word Document is generated using [Pandoc](http://pandoc.org/index.html) right after `jekyll build` when running `docker-compose up`.
1. Preview environments are built with [Netlify](https://netlify.com).
1. Hosted on Amazon S3, with CloudFront as a CDN. Using [s3_website](https://github.com/laurilehmijoki/s3_website) to
automatically upload static content to S3.
1. We use [Bootstrap](http://www.getbootstrap.com/) and [Less](http://lesscss.org/).
Expand Down
2 changes: 1 addition & 1 deletion jekyll-serve.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

set -e

bundle exec jekyll build
bundle exec jekyll build --incremental
bundle exec jekyll serve --livereload --drafts --host 0.0.0.0