Commit Graph

24 Commits

Author SHA1 Message Date
Andrea Luzzardi
2139514760
Merge pull request #2045 from jangraefen/patch-1
Remove incorrect installer documentation
2022-04-05 11:31:59 -07:00
Jan Gräfen
f53660772f Remove incorrect installer documentation
In the installer instruction for Windows it is claimed that the dagger binary is placed inside the System32 folder if permissions allow it, which seems to be no longer part of the install.ps1 script (and seems like a bad idea anyways).

Signed-off-by: Jan Gräfen <223234+jangraefen@users.noreply.github.com>
2022-04-05 08:46:11 +02:00
Sam Alba
1cd8207b3d docs: add tip for support symlink with git on Windows
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2022-04-04 15:16:29 -07:00
Sam Alba
c09fe2520b docs: Remove curl dependency when installing on Windows
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2022-03-31 16:39: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
abserari
76a0e737a2 Docs Update:1200-local-dev.md build/index.html -> _buld/index/html
Signed-off-by: abserari <abserari@gmail.com>
2022-03-31 19:42:07 +08: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
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
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
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
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