Skip to content

Commit

Permalink
Add README note about local dev
Browse files Browse the repository at this point in the history
Signed-off-by: lucperkins <[email protected]>
  • Loading branch information
lucperkins authored and tsandall committed Apr 5, 2019
1 parent 121aecf commit 798d86c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
8 changes: 8 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@ make serve
Open your browser to http://localhost:1313 to see the site running locally. The docs
are available at http://localhost:1313/docs.

> The local version of the site is different from the production site at
> https://openpolicyagent.org in important ways. When running the site locally,
> the documentation you'll see is from the current branch, not from any past release.
> Thus, there is no version selector or concept of documentation versions in the
> "dev" site. The documentation that you see when running the site locally will be
> visible on the production site only when that documentation has been included as
> part of an OPA release.
## Site updates

The OPA site is automatically published using [Netlify](https://netlify.com). Whenever
Expand Down
6 changes: 3 additions & 3 deletions docs/layouts/partials/home/banner.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
{{ $tagline := site.Params.tagline }}
{{ $socialMenu := site.Menus.social }}
{{ $latest := index site.Data.releases 0 }}
{{ $docs := cond $localMode "foo" "bar" }}
{{ $getStarted := cond $localMode "/docs/get-started" (printf "/docs/%s/get-started" $latest) }}
{{ $docs := cond $localMode "/docs" (printf "/docs/v%s" $latest) }}
{{ $getStarted := cond $localMode "/docs/get-started" (printf "/docs/v%s/get-started" $latest) }}
<header role="banner">
<nav class="nav--banner" role="navigation">
<ul class="nav--menu">
Expand Down Expand Up @@ -72,4 +72,4 @@ <h1 class="headline--title">
<div class="headline--wave--bg" role="presentation"></div>
<div class="headline--wave--fg" role="presentation"></div>
</div>
</header>
</header>

0 comments on commit 798d86c

Please sign in to comment.