This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
dagger/docs
Kasper Juul Hermansen ec9a8240b6
All checks were successful
continuous-integration/drone/pr Build is passing
continuous-integration/drone/push Build is passing
fix(deps): update all dependencies
2022-10-26 17:27:34 +00:00
..
administrator docs: discard opentracing doc, using opentelemetry 2022-04-15 21:47:44 +08:00
core-concepts docs: avoid multiple packages in examples 2022-04-18 18:14:55 +02:00
faq docs: fixed misleading example code 2022-04-19 21:29:38 +10:00
getting-started Docs: fix index 2022-04-17 16:15:11 -05:00
guides docs: discard opentracing doc, using opentelemetry 2022-04-15 21:47:44 +08:00
introduction Docs: fix index 2022-04-17 16:15:11 -05:00
learn docs: remove dead links. References doesn't exist anymore 2022-04-12 14:12:14 +02:00
plans fix(deps): update all dependencies 2022-10-26 17:27:34 +00:00
reference Remove old docs 2022-02-23 12:20:01 -07:00
references docs: Add types reference 2022-04-15 11:56:43 +00:00
tests docs: update github actions workflow example 2022-04-14 17:54:31 +02:00
use-cases website: hardcode version banner for 0.1 docs 2022-04-13 15:58:51 +02:00
1001-install.md Update install procedure 2022-03-31 13:45:31 +02:00
0.1.md website: hardcode version banner for 0.1 docs 2022-04-13 15:58:51 +02:00
new.sh website: hardcode version banner for 0.1 docs 2022-04-13 15:58:51 +02:00
README.md Answer a few contributor questions via a docs README 2022-02-18 15:58:23 +00:00
update-version.sh Update dagger version in all docs to 0.2.4 2022-03-29 19:41:59 +01:00

FAQ

The intent behind this README is to answer contributor questions regarding docs.dagger.io.

What happens to a new doc page after the PR gets merged?

It gets automatically deployed to docs.dagger.io.

The doc URL will use the slug property from the doc markdown metadata.

Given slug: /1001/install/, the live URL will be docs.dagger.io/1001/install

How can I run docs locally?

You will need to have yarn and Node.js v16 installed.

From the top-level dir - cd ../ - run the following command: make web

This will install all dependencies, start the docs web server locally and open localhost:3000 in your browser.

How can I add a new doc page?

From the docs dir, run ./new.sh doc-title

This will create a new Markdown file for the new doc page, i.e. docs/1214-doc-title.md

This new doc will not be added to the navigation. We prefer to keep the organisation of doc pages, and writing them separate. For the time being - 2022 Q1 - the focus is on writing self-contained doc content. Don't worry about where to fit this content, it's enough to keep this in mind: Writing effective documentation.

What else should I keep in mind as I add new doc pages?