Skip to content

Commit

Permalink
Improves documentation on how to contribute to the site by using Dock…
Browse files Browse the repository at this point in the history
…er. (#1175)
  • Loading branch information
iMacTia committed Sep 1, 2020
1 parent 6521a16 commit 9af091f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
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

0 comments on commit 9af091f

Please sign in to comment.