From 0bb33839f53afe034070ecf87b999bef6a86975a Mon Sep 17 00:00:00 2001 From: Marcus Andersson Date: Thu, 22 Oct 2020 09:57:56 +0200 Subject: [PATCH] Docs: updated cmd to build docs locally to generate docs prior to building site. (#28371) * added instructions so we generate docs prior to building them. * replaced ci script. * improved according to feedback. --- .gitignore | 3 +++ docs/Makefile | 21 +++++++++++++++------ docs/README.md | 1 + 3 files changed, 19 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index eddabf62495..3ed4beb90f3 100644 --- a/.gitignore +++ b/.gitignore @@ -118,3 +118,6 @@ compilation-stats.json # report dumping the whole system env /report.*.json + +# auto generated front end docs +/docs/sources/packages_api/* \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile index be80fd1f920..7fef8c68f2f 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,14 +1,23 @@ -.PHONY: docs docs-test +.PHONY: docs docs-test docs-no-pull docs-generate-frontend docs-no-generate-frontend IMAGE = grafana/docs-base:latest -docs: - docker pull ${IMAGE} +docs-generate-frontend: + yarn install --pure-lockfile + yarn run packages:build + yarn run packages:docsExtract + yarn run packages:docsToMarkdown + yarn run packages:clean + +docs-no-generate-frontend: docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest -p 3002:3002 --rm -it $(IMAGE) /bin/bash -c 'make server' -docs-no-pull: +docs: docs-generate-frontend + docker pull $(IMAGE) docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest -p 3002:3002 --rm -it $(IMAGE) /bin/bash -c 'make server' -docs-test: - docker pull ${IMAGE} +docs-no-pull: docs-generate-frontend docs-no-generate-frontend + +docs-test: docs-generate-frontend + docker pull $(IMAGE) docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest --rm -it $(IMAGE) /bin/bash -c 'make prod' diff --git a/docs/README.md b/docs/README.md index e7e855bfc1a..8ca41d57852 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,6 +5,7 @@ When you contribute to documentation, it is a good practice to build the docs on ## Requirements Docker >= 2.1.0.3 +Yarn >= 1.22.4 ## Build the doc site