Commit Graph

29 Commits

Author SHA1 Message Date
Adrien Brault
12257ce53f docs: add getting started gitlab ci configuration
Signed-off-by: Adrien Brault <adrien.brault@gmail.com>
2022-03-30 23:46:12 +02:00
Gerhard Lazu
4d7026895d
Update dagger version in all docs to 0.2.4
Including the version that we install explicitly.

Fixes https://github.com/dagger/dagger/issues/1908

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-29 19:41:59 +01:00
Gerhard Lazu
9ba8b58dcd
Merge pull request #1884 from slumbering/issue#1761-docs-comments
[Docs] - content comments
2022-03-29 11:42:01 +01:00
jffarge
8af0bb7847 make sentence clearer
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 12:36:48 +02:00
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
jffarge
d7ddf315d9 remove unecessary comment. Instead use Github review
Signed-off-by: jffarge <jf@dagger.io>
2022-03-28 12:05:15 +02:00
jffarge
c4b16b91e1 apply more comments
Signed-off-by: jffarge <jf@dagger.io>
2022-03-28 12:03:31 +02:00
jffarge
162e70cfd3 apply comments from Emily ggdocs
https://docs.google.com/document/d/1XolFtIzUMQQNOE6NNNO7JDmxECbj1uwjCcXv1SWVfeo

Signed-off-by: jffarge <jf@dagger.io>
2022-03-28 11:56:07 +02:00
Gerhard Lazu
3a6d922a4e
Follow-through the other "." → "./" & build → "./_build" renames
Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-25 16:55:23 +00:00
Gerhard Lazu
6db19fcea2
Allow any published dagger version to be installed via install.sh
This also updates Getting Started - CI/CD in your local dev - Linux & Mac doc.
A few other related doc changes were pulled in by this.

I wanted to try different versions of dagger on Linux, and this was the
easiest way of doing that:

    curl -L https://dl.dagger.io/dagger/install.sh -O
    # make this change, and then:

    DAGGER_VERSION=0.2.0 sh install.sh
    # ...
    ./bin/dagger version
    dagger 0.2.0 (e499297e) linux/amd64

    DAGGER_VERSION=0.2.1 sh install.sh
    # ...
    ./bin/dagger version
    dagger 0.2.1 (69b4845d) linux/amd64

This change enables anyone to do the following instead:

    curl -L https://dl.dagger.io/dagger/install.sh \
    | DAGGER_VERSION=0.2.0 sh

Until this gets merged, you can test how this change works in practice
via this temporary file:

    curl -L https://dl.dagger.io/dagger/install-pr-1819.sh \
    | DAGGER_VERSION=0.2.0 sh

One thing which I was not sure about is how the file from this
repository ends up on https://dl.dagger.io/dagger/install.sh. I think
this is a manual process today, but I need to confirm this assumption.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-24 23:28:07 +00:00
Gerhard Lazu
c4104626c3
Merge pull request #1837 from marcosnils/feat/docs_os_select
Attempt to automatically select OS tab based on user user-agent
2022-03-24 23:10:32 +00:00
Marcos Lilljedahl
70c49495aa Add BrowserOnly component to avoid SSG errors
Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2022-03-24 16:02:27 -03:00
Marcos Lilljedahl
52e7145874 Update windows benchmarks
Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2022-03-24 12:52:17 -03:00
Marcos Lilljedahl
b401cdafd9 Add markdownlint to Makefile
We're currently running markdownlint in CI and we didn't have a target
for that in our makefile. Adding that to prevent rejected PR's due to
markdown linting errors

Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2022-03-23 15:35:49 -03:00
Marcos Lilljedahl
b47b51401f Attempt to automatically select OS tab based on user user-agent
This is a quick fix to attempt to automatically select the user's OS tab
on the pages that requires so which potentially avoids users following
incorrect docs

Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2022-03-23 14:05:08 -03:00
Marcos Lilljedahl
85b044ebf4 Update macOS benchmarks
Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2022-03-22 17:24:48 -03:00
Marcos Lilljedahl
a1aa420bd5 Update docs with new linux benchmarks
Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2022-03-22 16:47:01 -03:00
guillaume
fd473033af Complete Windows Getting-started doc
Doc tested and written with rc1 version, on Windows

Signed-off-by: guillaume <guillaume.derouville@gmail.com>
2022-03-11 18:16:30 +01:00
Gerhard Lazu
da8e8fbaac
Extract snippets from docs into separate files
So that we get auto-formatting and syntax checking in our code editor.
The only snippets which have not been extracted are either terminal
output, or file fragments (e.g. CUE) which are not valid standalone files.

Resolves https://github.com/dagger/dagger/issues/1715

While at it, do a few fly-by improvements:
- beta.1 -> beta.2
- add CUE & BuildKit links
- up -> do

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-10 16:35:50 +00:00
Andrea Luzzardi
1d6f0acdd2
Merge pull request #1742 from gerhard/europa-docs-default
Default docs to Europa
2022-03-09 14:38:41 -08:00
Gerhard Lazu
74c3465ca0
Fix dagger-for-github version
We assume that this will be out by the time this goes live.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-09 21:15:24 +00: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
1974dd1df7
Update Europa docs - CI/CD in your local dev to the new netlify.cue
Follow-up to https://github.com/dagger/dagger/pull/1693

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-09 17:01:39 +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
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
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
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