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.
ad53d41755
dagger/docs
History
Gerhard Lazu 9cda86f6f8
Update the version in docs to next release 
This also accounts for dagger.io/dagger/core split introduced in
https://github.com/dagger/dagger/pull/1866

We should hold this merge until we are ready to cut the release,
otherwise links & some instructions will be broken until we release
v0.2.3.

Even though I would have preferred to have docs/update-version.sh in
Dagger, this is the quickest thing for now.

Related to https://github.com/dagger/dagger/issues/1854

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-28 22:23:51 +01:00
..
administrator Use unique IDs for all existing doc pages 2022-02-10 07:38:11 +00:00
core-concepts Update the version in docs to next release 2022-03-28 22:23:51 +01:00
drafts Move connecting socket to client: network 2022-03-28 18:16:07 +00:00
getting-started Update the version in docs to next release 2022-03-28 22:23:51 +01:00
introduction Default docs to Europa 2022-03-09 20:12:50 +00:00
knowledge-base docs: migrate from 0.1 2022-03-10 16:50:37 -08:00
learn Merge pull request #1837 from marcosnils/feat/docs_os_select 2022-03-24 23:10:32 +00:00
reference Remove old docs 2022-02-23 12:20:01 -07:00
tests Move connecting socket to client: network 2022-03-28 18:16:07 +00:00
use-cases Move core actions to a subpackage 2022-03-27 17:33:47 +00:00
1001-install.md fix: Build from source instructions 2022-01-28 11:38:04 +01: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 the version in docs to next release 2022-03-28 22:23:51 +01: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?