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

Improves documentation on how to contribute to the site by using Docker. #1175

Merged
merged 1 commit into from Sep 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 14 additions & 1 deletion .github/CONTRIBUTING.md
Expand Up @@ -49,7 +49,20 @@ We encourage adapters that:
### Changes to Faraday Website

The [Faraday Website][website] is included in the Faraday repository, under the `/docs` folder.
If you want to apply changes to it, please test it locally using `Jekyll`.
If you want to apply changes to it, please test it locally before opening your PR.

#### Test website changes using Docker

Start cloning the repository and navigate to the newly cloned directory on your computer, then run the following:

```bash
docker container run -p 80:4000 -v $(pwd)/docs:/site bretfisher/jekyll-serve
```

And that's it! Open your browser and go to `http://localhost` to see the website running.
Any change done to files in the `/docs` folder will be automatically picked (except for config changes).

#### Test website changes using `Jekyll`

```bash
# Navigate into the /docs folder
Expand Down
1 change: 1 addition & 0 deletions docs/_config.yml
@@ -1,6 +1,7 @@
# SITE CONFIGURATION
url: 'https://lostisland.github.io'
baseurl: '/faraday'
repository: 'lostisland/faraday'

# THEME-SPECIFIC CONFIGURATION
theme_settings:
Expand Down