Commit Graph

23 Commits

Author SHA1 Message Date
Patrick East 04c711fc01 docs: Remove non-useful linkcheck target
The `linkcheck` target has been broken since we added in the "latest"
URL stuff and started using netlify redirects all over.

Add documentation for using a different tool that crawls the live
preview deployemnt.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-09-10 09:58:50 -07:00
Patrick East 2f37e38180 docs: Refactor production-build make target
This makes it easier to troubleshoot the live blocks injection step
by isolating the build step to make the hugo content.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-09-04 16:36:31 -06:00
Torin Sandall 64139d61f7 docs: Fix whitespace in Makefile
Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-08-23 16:50:32 -04:00
David Boles 91d98c7205 docs: Add live-editable code blocks to the docs.
This commit adds a postprocessor to the docs build that enables
examples to be edited and have the results show up live. See the
additions to `docs/README.md` for more about what writing these
blocks looks like or the netlify PR preview
(e.g. at `docs/edge/how-do-i-write-policies/`)
to see them in action (you'll need to disable CORS for live output).

Signed-off-by: David Boles <me@davidbol.es>
2019-08-21 10:12:49 -07:00
Patrick East 0da7f3122d docs: Correct Makefile clean step
There was a typo in one and we didn't remove the generated releases.yaml

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-06-13 13:27:06 -07:00
Patrick East 2fc2282c3b Update hugo version to 0.55 in netlify config
Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-05-16 13:21:10 -07:00
Patrick East 758bb95ca3 Update docs dev readme and netlify dev configuration
There are a few drawbacks to different dev approaches with modifying
and testing the website and docs content. This updates the makefile
to include a handful of options and info about when to use them.

This also changes to not use a “live” Hugo service behind netlify when
we run it locally in dev mode. This allows for the local netlify
preview to more accurately reflect the “real” build.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-05-03 13:27:17 -06:00
Patrick East 58d336aff9 Refactor doc directories
Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-04-26 17:12:15 -07:00
Patrick East 5b7fb411a3 Get local netlify dev environment working
We needed to change to build the docs from the root of the git repo
Where the netlify toml file was. To make this easier we just shim the
docs-* make targets to the ./docs/Makefile.

The nice part of this is we get a full deployment with the redirects
and other netlify config bits in place.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-04-26 17:12:15 -07:00
Patrick East 2483b6dd2e Remove “local” and “production” doc builds..
..There can be only one.

The groundwork was laid in previous patches but this finishes the
process of removing the local/dev/preview builds. We now only have
a single doc build that will show *all* content.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-04-26 17:12:15 -07:00
lucperkins f5835174b5 Add auto scrolling
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-04-19 12:18:12 -07:00
lucperkins 2e1a30613e Add version dropdown navigation
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-04-15 12:28:08 -07:00
Torin Sandall 4de44cc18b Update preview-build to create releases.yaml
This file is needed by the Netlify deploy triggers.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-04-08 17:12:45 -07:00
Torin Sandall bb5e30e934 Move the gh-pages target into separate Makefile
The VERSION ifdef guard was causing the Netlify build to fail. Split
the gh-pages build into a separate Makefile for now.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-04-08 17:12:45 -07:00
Torin Sandall e34c28bdba Skip npm install now that node_modules are vendored
Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-04-08 17:12:45 -07:00
Torin Sandall 187bf70d8b Add self-contained static site build target
This target is self-contained and produces a site.tar.gz output that
contains the entire static site. We can deploy the contents of
site.tar.gz to the gh-pages branch.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-04-08 17:12:45 -07:00
lucperkins da8e77b41f Display only current master in server mode and deploy preview
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-04-06 12:35:11 -07:00
lucperkins 87179879d7 Update preview build to show latest instead of all versions
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-04-06 12:35:11 -07:00
lucperkins 121aecf485 Create separate partials for local vs. prod
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-04-05 10:51:41 -07:00
lucperkins 75a3f79090 Fix links and add link checking instructions
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-04-04 09:53:38 -07:00
lucperkins c1f13c4f43 Rework versioning system
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-04-01 11:42:50 -07:00
lucperkins 3fbdd5a5ff Add documentation versioning logic
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-03-28 16:28:40 -07:00
lucperkins bb0d4e271b New OPA website (Hugo + Netlify)
Signed-off-by: lucperkins <lucperkins@gmail.com>
2019-03-26 13:45:50 -07:00