mirror of
https://github.com/jlengrand/error-prone-support.git
synced 2026-03-10 08:11:25 +00:00
Update .gitignore, fix typo, and sort links in README
This commit is contained in:
11
website/.gitignore
vendored
11
website/.gitignore
vendored
@@ -1,8 +1,13 @@
|
||||
# Jekyll generated files
|
||||
### Jekyll ###
|
||||
_site/
|
||||
.sass-cache/
|
||||
.jekyll-cache/
|
||||
.jekyll-metadata
|
||||
Gemfile.lock
|
||||
.sass-cache
|
||||
_site/
|
||||
|
||||
# Ignore folders generated by Bundler
|
||||
.bundle/
|
||||
vendor/
|
||||
|
||||
# Generated content
|
||||
*.bak
|
||||
|
||||
@@ -6,7 +6,7 @@ statically generated using [Jekyll][jekyll].
|
||||
|
||||
# Local development
|
||||
|
||||
To view the webite on `localhost`, first follow the [Jekyll installation
|
||||
To view the website on `localhost`, first follow the [Jekyll installation
|
||||
instructions][jekyll-docs-installation]. Once done, in this directory execute:
|
||||
|
||||
```sh
|
||||
@@ -20,7 +20,7 @@ code modifications will automatically be reflected. (An exception is
|
||||
server restarts do not require running `bundle install`, unless `Gemfile` has
|
||||
been updated in the interim.
|
||||
|
||||
Documentation can be re-generated whist jekyll is running, by executing:
|
||||
Documentation can be regenerated whist jekyll is running, by executing:
|
||||
|
||||
```sh
|
||||
../generate-docs.sh
|
||||
@@ -33,12 +33,12 @@ step-by-step tutorial.
|
||||
# Deployment
|
||||
|
||||
The website is regenerated and deployed using the
|
||||
[`deploy-website.yaml`][error-prone-support-website-deploy-workflow] Github
|
||||
[`deploy-website.yaml`][error-prone-support-website-deploy-workflow] GitHub
|
||||
Actions workflow any time a change is merged to `master`.
|
||||
|
||||
[error-prone-support-website-deploy-workflow]: https://github.com/PicnicSupermarket/error-prone-support/actions/workflows/deploy-website.yaml
|
||||
[error-prone-support-website]: https://error-prone.picnic.tech
|
||||
[error-prone-support-website-deploy-workflow]: https://github.com/PicnicSupermarket/error-prone-support/actions/workflows/deploy-website.yaml
|
||||
[jekyll]: https://jekyllrb.com
|
||||
[jekyll-docs]: https://jekyllrb.com/docs/
|
||||
[jekyll-docs-installation]: https://jekyllrb.com/docs/installation/
|
||||
[jekyll]: https://jekyllrb.com
|
||||
[localhost-port-4000]: http://127.0.0.1:4000
|
||||
|
||||
@@ -16,6 +16,7 @@ exclude:
|
||||
- Gemfile
|
||||
- Gemfile.lock
|
||||
- README.md
|
||||
- vendor
|
||||
|
||||
permalink: pretty # Use /doc/ vs. /doc.html
|
||||
|
||||
@@ -45,4 +46,4 @@ social:
|
||||
links:
|
||||
- https://github.com/PicnicSupermarket
|
||||
- https://twitter.com/picnic
|
||||
- https://www.linkedin.com/company/picnictechnologies/
|
||||
- https://www.linkedin.com/company/picnictechnologies
|
||||
|
||||
Reference in New Issue
Block a user