mirror of https://github.com/jlengrand/error-prone-support.git synced 2026-03-10 08:11:25 +00:00

Files

Jelmer Borst 5ca95eb36d Set up documentation website generation and deployment (#253 )

Generating the website is done by Jekyll with a theme called `just-the-docs`. 
Deployment of the website is done via GitHub Pages.

See:
- https://github.com/jekyll/jekyll
- https://github.com/just-the-docs/just-the-docs

2022-10-04 09:08:23 +02:00

_includes

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

_sass/custom

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

assets/images

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

_config.yml

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

.gitignore

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

404.md

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

bugpatterns.md

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

favicon.ico

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

Gemfile

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

README.md

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

refastertemplates.md

Set up documentation website generation and deployment (#253 )

2022-10-04 09:08:23 +02:00

README.md

Error Prone Support website

This directory contains the majority of the source code that powers error-prone.picnic.tech. The website is statically generated using Jekyll.

Local development

To view the website on localhost, first follow the Jekyll installation instructions. Once done, in this directory execute:

bundle install
../generate-docs.sh && bundle exec jekyll serve --livereload

The website will now be available on port 4000. Source code modifications (including the result of rerunning ../generate-docs.sh) will automatically be reflected. (An exception is _config.yml: changes to this file require a server restart.) Subsequent server restarts do not require running bundle install, unless Gemfile has been updated in the interim.

If you are not familiar with Jekyll, be sure to check out its documentation. It is recommended to follow the provided step-by-step tutorial.

Deployment

The website is regenerated and deployed using the deploy-website.yaml GitHub Actions workflow any time a change is merged to master.