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
Helder Correia 42fc1d14d2
docs: Package coding style
This is just to start. We’ll keep iterating on it.

Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-04-11 16:07:00 +00:00
..
administrator Use unique IDs for all existing doc pages 2022-02-10 07:38:11 +00:00
core-concepts Docs: move CLI telemetry to guides section 2022-04-08 01:00:32 +00:00
getting-started Merge pull request #2045 from jangraefen/patch-1 2022-04-05 11:31:59 -07:00
guides docs: Package coding style 2022-04-11 16:07:00 +00:00
introduction docs: Correctly capitalize GitLab 2022-04-03 23:56:54 +01:00
learn docs: Correctly capitalize GitHub 2022-04-03 23:56:53 +01:00
plans Docs: move draft articles to "guides" 2022-04-08 01:00:32 +00:00
reference Remove old docs 2022-02-23 12:20:01 -07:00
references Docs: core actions reference 2022-04-07 19:08:21 +00:00
tests Docs: add content to 1205: "building container images" 2022-04-06 22:49:03 +00:00
use-cases Merge pull request #2002 from jpluscplusm/patch-1 2022-04-04 14:35:44 +01:00
1001-install.md Update install procedure 2022-03-31 13:45:31 +02:00
1214-migrate-from-dagger-0.1.md docs: fix Europa wording on migration docs (#2032) 2022-04-04 16:40:54 -03:00
new.sh Add front matter to new docs 2022-03-08 11:32:10 -01: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?