mirror of
https://github.com/grafana/grafana.git
synced 2024-12-01 21:19:28 -06:00
045a12047f
* Add docs generator * Add json-to-md conversion * Fix lint issues * Remove check for kind type * Disable prettier for generated docs * Use schema ref names as identifiers for links & headers * Display the default value (if so) in the description * Undo 'draft:false' introduced by mistake * Update pkg/codegen/jenny_docs.go Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Undraft and unlist kinds documentation (#61476) * Support running containers without root daemon Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use section shortcode to automatically list child pages Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Undraft and unlist kinds documentation This page and child pages are directly accessible but are not listed in the table of contents. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add docs-preview to browse drafted pages Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Replace end of line and pipe characters in table codegen * Remove draft status from generated docs Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joan López de la Franca Beltran <joanjan14@gmail.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Robert Horvath <robert.horvath@grafana.com>
29 lines
1.2 KiB
Makefile
29 lines
1.2 KiB
Makefile
.PHONY: pull docs docs-quick docs-no-pull docs-test docs-local-static
|
|
|
|
PODMAN = $(shell if command -v podman &>/dev/null; then echo podman; else echo docker; fi)
|
|
IMAGE = grafana/docs-base:latest
|
|
CONTENT_PATH = /hugo/content/docs/grafana/next
|
|
LOCAL_STATIC_PATH = ../../website/static
|
|
PORT = 3002:3002
|
|
|
|
pull:
|
|
$(PODMAN) pull $(IMAGE)
|
|
|
|
docs: pull
|
|
$(PODMAN) run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) /bin/bash -c "make server"
|
|
|
|
docs-preview: pull
|
|
$(PODMAN) run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) /bin/bash -c "make server BUILD_DRAFTS=true"
|
|
|
|
docs-no-pull:
|
|
$(PODMAN) run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) /bin/bash -c "make server"
|
|
|
|
docs-test: pull
|
|
$(PODMAN) run -v $(shell pwd)/sources:$(CONTENT_PATH):Z --rm -it $(IMAGE) /bin/bash -c 'make prod'
|
|
|
|
# expects that you have grafana/website checked out in same path as the grafana repo.
|
|
docs-local-static: pull
|
|
if [ ! -d "$(LOCAL_STATIC_PATH)" ]; then echo "local path (website project) $(LOCAL_STATIC_PATH) not found"]; exit 1; fi
|
|
$(PODMAN) run -v $(shell pwd)/sources:$(CONTENT_PATH):Z \
|
|
-v $(shell pwd)/$(LOCAL_STATIC_PATH):/hugo/static:Z -p $(PORT) --rm -it $(IMAGE)
|