Commit Graph

37 Commits

Author SHA1 Message Date
guillaume
7a51c51e84 Docs: Add docs to sidebar
Add documentation to sidebar + fix missing previous ones

Signed-off-by: guillaume <guillaume.derouville@gmail.com>
2022-04-08 11:47:38 +02:00
Solomon Hykes
bddb9b6543 Docs: move draft articles to "guides"
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-08 01:00:32 +00:00
Solomon Hykes
f33133ffd9 Docs: move CLI telemetry to guides section
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-08 01:00:32 +00:00
Solomon Hykes
938658eeff Docs: core actions reference
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-07 19:08:21 +00:00
Solomon Hykes
7f38a6c3e4 Docs: core concepts: actions
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-07 17:58:10 +00:00
Solomon Hykes
0962114557 Docs: new category "guides"
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-07 17:52:29 +00:00
kgb33
b68fc6f57b Copied Dagger vs documentation to Europa.
Signed-off-by: kgb33 <keltonbassingthwaite@gmail.com>
2022-03-31 20:31:39 -07:00
jffarge
095d4a327b Display getting started as the index page
Signed-off-by: jffarge <jf@dagger.io>
2022-03-31 15:53:25 +02:00
Gerhard Lazu
3ddf6c995c
Merge pull request #1934 from gerhard/move-dagger-0.1-link-back-to-the-bottom
Move Dagger 0.1 link back to the bottom
2022-03-30 01:05:49 +01:00
Gerhard Lazu
84744d3435
Move Dagger 0.1 link back to the bottom
As mentioned in https://github.com/dagger/dagger/pull/1904#issuecomment-1081292442

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-30 00:49:48 +01:00
Gerhard Lazu
994ee22a6e
Fix Go on DockerHub id & filename + remove from sidebar
ID 1216 was clashing with docker-cli-load doc.

The filename follows the convention of the other use cases.

Remove from docs sidebar until we do the quick fixes.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-30 00:45:09 +01:00
Sam Alba
a27b7b265d docs: added page to sidebar
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2022-03-29 14:24:54 -07:00
jffarge
e99afb9793 update categories descriptions
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 11:57:34 +02:00
jffarge
7abb7a8920 create generated index for core concepts and use cases
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:58:07 +02:00
jffarge
aa25e5e4fd Init auto generated category index with docusaurus
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:20:36 +02:00
Gerhard Lazu
19d762c5dd
Simplify Europa Docs sidebar
- move Dagger 0.1 references to the top
- move Dagger CUE API under Core Concepts, after What is CUE?
- move Go on Docker Swarm under Use Cases

A few minor title changes:
- Dagger CUE API (0.2+) -> Dagger CUE API
- What is Cue? -> What is CUE?

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-29 00:14:34 +01:00
Gerhard Lazu
2a6b91cf72
Merge pull request #1805 from TomChv/doc/add-go-use-case
Docs: Add dagger golang use case
2022-03-28 23:52:59 +01:00
Tom Chauveau
2d3acc61e0
Add dagger golang use case
Signed-off-by: Vasek - Tom C <tom.chauveau@epitech.eu>
2022-03-16 12:14:24 +01:00
Gerhard Lazu
dcf3b7ed21
Add missing definitions to Dagger CUE API
Link to the source of truth cue files.

While at it, move this page from Knowledge Base, which is a generic
category, to Core Concepts. The URL didn't change so that we don't break
existing links. FWIW /1213/dagger-cue would have been my choice.

Initially contributed as a change part of
https://github.com/dagger/dagger/pull/1758

Should be merged after https://github.com/dagger/dagger/pull/1799

Related to https://github.com/dagger/dagger/pull/1768

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-15 21:44:37 +00:00
Gerhard Lazu
ee95b323ab
Add What is Cue? page to Europa Docs sidebar
This duplicates the existing page and uses a new ID so that clicking on
it in one sidebar (pre-Europa) will not update the sidebar. We have
learned about this behaviour via
https://github.com/dagger/dagger/pull/1758

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-14 18:17:14 +00:00
Andrea Luzzardi
9358945526 docs: migrate from 0.1
- Temporary page that just points to the GitHub Discussion
- Goal: create a stable link we can share, update with proper content
  later
- Wasn't sure how to categorize this so I've renamed `DRAFTS` into
  `Knowledge Base`

Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2022-03-10 16:50:37 -08:00
Gerhard Lazu
9b22932cff
Default docs to Europa
There are a few outstanding tasks, but they can be finished tomorrow.
This is just the beginning of many refinements, so it's all good 🙌

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-09 20:12:50 +00:00
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
Helder Correia
da90baa087
Add new Client API
Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-07 17:13:16 -01:00
Gerhard Lazu
d693742477
Europa docs: get started with CI/CD in local dev
The idea is to start simple and get users a good feel for how this works
within 5 minutes or less. We should cover the three popular OSes, and
ensure that everything works as expected.

At the end of this, users will have Dagger set up for local CI/CD, and
know how to make a change to the example app and re-run the build, test
& deploy loop.

This is part of https://github.com/dagger/dagger/issues/1327

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-05 23:58:49 +00:00
Gerhard Lazu
1e0c5d5e7a
Temporarily remove Use Cases from the Europa docs sidebar
The current plan is to add them post 0.2.0 shipping, for now the focus
is on Getting Started & Core Concepts.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-04 18:58:17 +00:00
Gerhard Lazu
6e3c35e1ad
Rename CI/CD platform to CI environment
As discussed here:
https://github.com/dagger/dagger.io/issues/38#issuecomment-1057469048

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-04 18:26:12 +00:00
Gerhard Lazu
ba9fcf864d
Add a DRAFTS section to the Europa docs sidebar
This is meant to act as catch-all for pages that have been written
ad-hoc, but don't currently fit anywhere.

While it was initially mentioned that this should be called
Knowledgebase, it didn't seem to accurately describe the intent.
The email & message default DRAFTS seemed better, so I just went with it.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-03 15:31:37 +00:00
Gerhard Lazu
f2f2f7c38a
Add link to Europa docs
So that it's easy for anyone to jump to the new docs that we are
currently working on, and intend to replace the existing docs with.

While I would have preferred to link to the local dev page, it's still
stuck in the PR state, currently blocked on another PR:
https://github.com/dagger/dagger/pull/1586

Also added a link to the pre-Europa docs, so that it's easy to go back.

While at it, drop "Sidebar" from the name of sidebars, and replace
tutorial with a more descriptive name.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-03 15:12:43 +00:00
Gerhard Lazu
df6b29e8cb
Capture the first CI/CD platforms that we intend to document
We invite users to help us prioritise via https://github.com/dagger/dagger/discussions/1677

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-03 14:03:26 +00:00
Gerhard Lazu
78d5d49f2c
Add the must-have pages for the Europa release
The goal is to capture the shape of the new docs. It is not meant to be
final, but it should be as close as possible. We only want the bare
minimum for new users that on-board with Dagger Europa. As soon as the
new europaSidebar replaces replaces the existing one, the previous docs
will still remain available - doc IDs are unique and permanent. We will
do this by simply changing the default `slug: /` to point to the Europa
Docs entrypoint, which is doc 1200.

Helpful Docusaurus link re multiple sidebars:
https://docusaurus.io/docs/sidebar/multiple-sidebars

The new pages are numbered from `1200` onwards. This is meant to reflect
the `0.2.0` Dagger version. This numbering felt more meaningful than
just continuing to increment existing numbers.

I didn't want to be "wasteful" with the digits and start at `2000`, but
that was my first instinct.

I am keen on getting this live on https://docs.dagger.io/1200/local-ci.
Anything that is not in production, is inventory. Inventory is bad.

The goal is to allow anyone that has a link to get a feel for the new
docs as soon as possible, so that we can all see how they improve in
real-time, and steer them continuously towards the desired state. We
should be aware of the timeline, and not muck about, but instead
evaluate constantly how close are we to "flipping the switch".

Remember, the best releases are those where switches are flipped (e.g.
`--europa)`. The feature will have been out there for weeks (maybe even
months), improved by talking to users and then one day realising that we
are done, and just enabling it by default. It's the same principle
behind these docs.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-10 09:47:07 +00:00
jffarge
ac6d784714 docs: 💄 Update UI
Signed-off-by: jffarge <jf@dagger.io>
2022-01-12 16:10:25 +01:00
Andrea Luzzardi
acc602db69 docs: remove "Create your first Dagger Environment" from sidebar
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-08 16:45:50 -07:00
Andrea Luzzardi
7364951e95 docs: define sidebar manually
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-08 16:18:02 -07:00
jffarge
3ec7275ea6 docs: 💄 update docs ui
Signed-off-by: jffarge <jf@dagger.io>
2021-08-23 11:22:17 +02:00
jffarge
e4ff349875 docs: 🐛 discord invite link without expiration
Signed-off-by: jffarge <jf@dagger.io>
2021-06-28 14:06:10 +02:00
Andrea Luzzardi
e9b952a882 docs: rename tools/daggosaurus to website
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-06-04 13:49:20 -07:00