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.
a9fe5d8f16
dagger/docs
History
Gerhard Lazu c3f21958d2
Europa docs: From local dev to CI environment doc page 
The todoapp example contains a Netlify plan which uses the latest dagger
additions: do & Client API. We are thinking of merging the examples
repository into this one to make working with this easier. This is a
step in that direction.

We are not using the yarn package so that we can revert
https://github.com/dagger/dagger/pull/1673 without breaking this
implementation.

The GitHub Action is WIP, we will continue with that tomorrow:
https://github.com/dagger/dagger-for-github/issues/24

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-08 22:17:24 +00:00
..
administrator Use unique IDs for all existing doc pages 2022-02-10 07:38:11 +00:00
core-concepts Add new Client API 2022-03-07 17:13:16 -01:00
getting-started Europa docs: From local dev to CI environment doc page 2022-03-08 22:17:24 +00:00
introduction Fix a typo in the docs 2022-02-23 23:43:28 +02:00
learn Add link to Europa docs 2022-03-03 15:12:43 +00:00
reference Remove old docs 2022-02-23 12:20:01 -07:00
use-cases Temporarily remove Use Cases from the Europa docs sidebar 2022-03-04 18:58:17 +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?