docs

Author: reakaleek

docs/docset.yml

@@ -24,6 +24,7 @@ subs:
   a-global-variable: "This was defined in docset.yml"
 toc:
   - file: index.md
+  - file: quickstart/index.md
   - folder: contribute
     children:
       - file: index.md

docs/quickstart/index.md

@@ -0,0 +1,62 @@
+# Quickstart
+
+## Download the docs-builder binary
+
+TBD
+
+## Set up folder structure
+
+```
+root/
+├── docs/
+│   └── index.md
+│   └── docset.yml
+└── ...
+```
+
+
+
+
+## Set up preview environment
+
+:::{dropdown} .github/workflows/docs.yml
+:open:
+```markdown
+name: docs
+
+on:
+  pull_request_target:
+    types:
+      - closed
+
+jobs:
+  docs-preview:
+    uses: elastic/docs-builder/.github/workflows/preview-cleanup.yml@main
+    permissions: # this is needed
+      contents: read
+      id-token: write
+      deployments: write
+```
+
+:::
+
+:::{dropdown} .github/workflows/docs-cleanup.yml
+:open:
+```markdown
+name: docs
+
+on:
+  pull_request_target:
+    types:
+      - closed
+
+jobs:
+  docs-preview:
+    uses: elastic/docs-builder/.github/workflows/preview-cleanup.yml@feature/consumer-preview-action
+    permissions:
+      contents: read
+      id-token: write
+      deployments: write
+```
+
+:::