Skip to content

Commit fafdb89

Browse files
author
Jeff Knight
authored
Update README.md
1 parent 635d227 commit fafdb89

File tree

1 file changed

+13
-21
lines changed

1 file changed

+13
-21
lines changed

README.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,34 @@
44

55
You can make a limited range of edits from the Github site, but this system works best if you clone it locally so you can run test builds.
66

7-
# Local development with ruby, without platform-api
8-
9-
* If using OSX, install command line tools, `xcode-select --install`
10-
* If using Linux, install Ruby https://www.ruby-lang.org/en/documentation/installation/
11-
* Setup local ruby env, `make env`
12-
* Install project deps, `make deps`
13-
* Run server, `make dev`
7+
# Quickstart (local development with docker)
8+
You will need to have Docker installed https://docs.docker.com/install/
9+
* If using Linux, run `make docker-dev`
1410
* Visit http://localhost:4000/docsv2/
1511

16-
# Local development with docker, without platform-api
12+
# Local development with `ruby` and `node`, without platform-api
1713

1814
* If using OSX, install command line tools, `xcode-select --install`
19-
* Install docker. For OSX: https://docs.docker.com/docker-for-mac/install/
20-
* Run `make docker-serve`
15+
* Install `Ruby` https://www.ruby-lang.org/en/documentation/installation/
16+
* Install `Node` https://nodejs.org/en/download/
17+
* Install `Yarn` https://yarnpkg.com/en/docs/install
18+
* Install `Bundler` `gem install bundler`
19+
* Run server, `make dev`
2120
* Visit http://localhost:4000/docsv2/
2221

23-
Use the local build process to preview local changes. If you're doing a release, you can use the `make docs` to see how this would work in the docker container environment that's more like production.
24-
2522
## Makefile commands
2623

27-
- `docs`: locally builds the docs and serves the static content via a Docker container running nginx
2824
- `build`: Builds the site docs. Used by CI to publish the docs to staging and production
29-
- `docker-serve`: Uses docker to build the docs locally, without needing to refresh the catalog from the platform-api
3025
- `nav`: Rebuilds the entire nav datafile based on the current doc structure. This is destructive and should not be used unless absolutely necessary.
3126
- `catalog`: Pulls in the latest catalog data from the Platform API and saves it in the respective data files. Requires an API key to be passed in env via PLATFORM_API_TOKEN
32-
- `env`: for when you're first getting set up: installs bundler, and installs the deps for the repo.
3327
- `seed`: copies all example data files out of the `_templates` directory and puts them in the `_data` directory. Useful if you don't have a way to setup an API key.
34-
- `clean`: runs `jekyll clean` locally
35-
- `deps`: re-runs `bundle install` locally.
28+
- `clean`: removes all build artifacts
29+
- `clean-deps`: removes all doownloaded `gems` and `node_modules`
30+
- `deps`: installs the required `gems` and `node_modules`
3631
- `dev`: runs `jekyll serve` locally with incremental builds. Useful when updating CSS, JS, or content and you don't want to rebuild everytime.
3732

38-
- docker-clean: runs a `jekyll clean` on a docker host.
39-
- docker-deps: runs `bundle install` on a docker host.
33+
- docker-build: runs `make build` on a docker host.
4034
- docker-dev: runs `make dev` on a docker host.
41-
- docker-nav: runs `make nav` on a docker host.
42-
- docker-catalog: runs `make catalog` on a docker host.
4335

4436
# Layouts
4537
`default.html` is the container through which all the individual other layouts (currently one, `page.html`) are built to have the right title, seo, etc.

0 commit comments

Comments
 (0)