kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity
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.
800f979ce6
dagger/docs
History
Robin Naundorf 800f979ce6 Update 1003-get-started.md 
Allow Fullscreen for Get Started Video

Signed-off-by: Robin Naundorf <r.naundorf@fh-muenster.de>
2022-02-23 10:58:19 +00:00
..
administrator Use unique IDs for all existing doc pages 2022-02-10 07:38:11 +00:00
core-concepts Add the must-have pages for the Europa release 2022-02-10 09:47:07 +00:00
getting-started Add the must-have pages for the Europa release 2022-02-10 09:47:07 +00:00
introduction Use unique IDs for all existing doc pages 2022-02-10 07:38:11 +00:00
learn Update 1003-get-started.md 2022-02-23 10:58:19 +00:00
reference Fix docs lint errors 2022-02-08 20:12:05 +00:00
use-cases Fix markdown lint errors 2022-02-12 18:37:03 +00:00
1001-install.md fix: Build from source instructions 2022-01-28 11:38:04 +01:00
new.sh Utility script to create a new docs page with the correct ID 2022-02-17 01:41:59 +00:00
README.md Answer a few contributor questions via a docs README 2022-02-18 15:58:23 +00:00

README.md

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?