WIP - start Grafana Cloud docs (#1063)

Author: ppcano

.eslintignore

@@ -1,5 +1,6 @@
 .cache/
 public/
+grafana-cloud/
 node_modules/
 CONTRIBUTING_FILE_FORMAT.md
 src/data/markdown/docs/40 xk6-disruptor/04 Examples/01 Inject HTTP faults into Pod.md

grafana-cloud/README.md

@@ -0,0 +1,18 @@
+# Prototype of docs for k6 in Grafana
+
+This repo contains the work in progress to document the k6-in-Grafana app.
+These docs use the Hugo as a static site generator.
+
+To build locally, you need:
+- [ ] Docker
+
+To start the server, make sure the Docker daemon is running.
+Then follow these steps:
+1. Go to the docs repo `cd docs/` . 
+1. Run `make docs` (or `sudo make docs`, depending on the necessary Docker priviledges). 
+1. Enter to confirm.
+1. Preview docs at [http://localhost:3002/docs/k6-in-grafana/](http://localhost:3002/docs/k6-in-grafana/).
+
+The process builds the site using the [docs-base Docker image](https://hub.docker.com/r/grafana/docs-base).
+The presentation you see at `localhost` depends on what the latest version of that image is.
+

grafana-cloud/docs/Makefile

@@ -0,0 +1,9 @@
+.DEFAULT_GOAL: help
+
+# Adapted from https://www.thapaliya.com/en/writings/well-documented-makefiles/
+.PHONY: help
+help: ## Display this help.
+help:
+	@awk 'BEGIN {FS = ": ##"; printf "Usage:\n  make <target>\n\nTargets:\n"} /^[a-zA-Z0-9_\.\-\/%]+: ##/ { printf "  %-45s %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+include docs.mk

grafana-cloud/docs/docs.mk

@@ -0,0 +1,43 @@
+.ONESHELL:
+.DELETE_ON_ERROR:
+export SHELL     := bash
+export SHELLOPTS := pipefail:errexit
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rule
+
+DOCS_IMAGE   = grafana/docs-base:latest
+DOCS_PROJECT = k6-in-grafana
+DOCS_DIR     = sources
+
+# This allows ports and base URL to be overridden, so services like ngrok.io can
+# be used to share a local running docs instances.
+DOCS_HOST_PORT    = 3002
+DOCS_LISTEN_PORT  = 3002
+DOCS_BASE_URL    ?= "localhost:$(DOCS_HOST_PORT)"
+
+HUGO_REFLINKSERRORLEVEL ?= WARNING
+DOCS_DOCKER_CONTAINER = $(DOCS_PROJECT)-docs
+
+.PHONY: docs-docker-rm
+docs-docker-rm:
+	docker rm -f $(DOCS_DOCKER_CONTAINER)
+
+.PHONY: docs-pull
+docs-pull:
+	docker pull $(DOCS_IMAGE)
+
+.PHONY: docs
+docs: ## Serve documentation locally.
+docs: docs-pull
+	@echo "Documentation will be served at:"
+	@echo "http://$(DOCS_BASE_URL)/docs/$(DOCS_PROJECT)/"
+	@echo ""
+	@if [[ -z $${NON_INTERACTIVE} ]]; then \
+		read -p "Press a key to continue"; \
+	fi
+	docker run -it --name $(DOCS_DOCKER_CONTAINER) \
+		-v $(CURDIR)/$(DOCS_DIR):/hugo/content/docs/$(DOCS_PROJECT)/:rw,z \
+		-e HUGO_REFLINKSERRORLEVEL=$(HUGO_REFLINKSERRORLEVEL) \
+		-p $(DOCS_HOST_PORT):$(DOCS_LISTEN_PORT) \
+		--rm $(DOCS_IMAGE) \
+		make server

grafana-cloud/docs/sources/_index.md

@@ -0,0 +1,54 @@
+---
+cascade:
+  public_docs: true
+  search_section: Grafana Cloud k6
+  search_type: doc
+title: Grafana Cloud k6
+menuTitle: Grafana Cloud k6
+description: Run k6 in Cloud servers, visualize and scripts in your Grafana instance.
+description: 'Script performance tests locally, run tests from the CLI on servers all over the world, and visualize test results in Grafana Cloud.'
+weight: 100
+---
+
+# Grafana Cloud k6
+
+With the k6 app, you can  script performance tests locally,
+run tests from the CLI on servers all over the world,
+and visualize test results in Grafana Cloud.
+
+In these docs, learn how to:
+
+- Write and run Cloud tests.
+- Analyze results.
+- Incorporate k6 with other dashboards.
+- Manage performance-testing projects across your organization.
+
+For introductory videos, check out the [k6 Cloud Playlist](https://www.youtube.com/playlist?list=PLJdv3RhAQXNGkRCp7Q0k77n5jif4qjz2o)
+
+
+## k6 Cloud vs. OSS
+
+Grafana k6 cloud is designed to manage and enhance the [k6 OSS](https://k6.io/docs) API and testing application.
+It aims to keep your k6 tests as portable as possible, while saving your teams the effort of managing cloud infrastructure or maintaining a beautiful front end.
+
+### Infrastructure benefits
+
+When you run tests on Grafana Cloud k6 servers, Grafana handles the following infrastructure work for you:
+- Autoscaling huge tests
+- Distributing test across different geographic zones
+- Storing and aggregating massive amounts of test metrics
+
+For a glimpse of the infrastructure work that this requires, read [Peeking under the hood of k6 Cloud](https://k6.io/blog/the-glorious-backend/).
+
+### Extra features
+
+Grafana Cloud k6 is not only an engine for test execution and storage.
+It's also a software as a service, which provides a frontend to visually explore tests and to manage test suites and teams.
+
+Some of the key features include the following:
+- Live visualizations of test execution
+- A graphical test builder
+- Performance insights to alert you about test issues
+- Portable test-results panels to put in other dashboards
+- Detailed analysis of different test metrics
+- Cloud environment variables to share between teams

grafana-cloud/docs/sources/analyze-results/_index.md

@@ -0,0 +1,6 @@
+---
+title: Analyze tests
+menuTitle: Analyze tests
+weight: 300
+---
+