Commit Graph

382 Commits

Author SHA1 Message Date
Solomon Hykes
9f042800da
Merge pull request #1860 from gerhard/europa-docs-plan-tanguy-fresh-pair-of-eyes 2022-03-26 12:45:13 -07:00
Helder Correia
770acd3ce2
Expand user home dir in client filesystem
Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-25 20:25:36 -01:00
Helder Correia
05d79e8ba6
Add docker cli package
Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-25 18:24:33 -01:00
Andrea Luzzardi
4f440bc67a
Merge pull request #1842 from helderco/docker-load
Add export and load for dagger images
2022-03-25 12:22:40 -07: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
5fe04d22e9
Revise Europa Docs - Core Concepts - It all starts with a plan
Thank you Tanguy for the "fresh pair of eyes" perspective.

Thank you Tom for the link suggestions.

Supersedes https://github.com/dagger/dagger/pull/1847

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-25 16:25:24 +00:00
Helder Correia
7a8153910c
Add export and load for dagger images
Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-25 15:04:29 -01: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
Jffarge
93d5a37508
Merge pull request #1835 from slumbering/gh-action-property
Fix the missing property "on" for getting started github action
2022-03-24 20:34:57 +01: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
Solomon Hykes
c800cb5a3a
Merge pull request #1833 from marcosnils/fix/todoapp_cache
WIP: Add node_modules mount to improve caching times
2022-03-24 11:53:19 -07:00
Marcos Lilljedahl
52e7145874 Update windows benchmarks
Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2022-03-24 12:52:17 -03:00
Andrea Luzzardi
fd2ccc0048 ci: disable telemetry
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2022-03-23 19:01:09 -07: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
jffarge
1ae43daa1a Fix the missing property "on" for getting started github action
Signed-off-by: jffarge <jf@dagger.io>
2022-03-23 15:50:22 +01: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
Solomon Hykes
4e6d5d487f
Merge pull request #1800 from gerhard/add-missing-entries-to-dagger-cue-api
Add missing definitions to Dagger CUE API docs page
2022-03-16 10:28:05 -07:00
Jeremy Adams
cde9d54589 Fix typo
Signed-off-by: Jeremy Adams <jeremy.adams.pdx@gmail.com>
2022-03-15 16:52:28 -07: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
Ben Gesoff
e0d2b5cd3b docs: fix typo in snippet
The reference to `docker.Copy` does not exist and should be `docker.#Copy` instead. This also leads to a confusing error message (possibly related to #493) as it isn't found while CUE is compiled, and instead results in the following runtime error:

```
[✗] actions.deps                                                                                                                                  2.1s
9:16PM FTL failed to execute plan: task failed: actions.deps._dag."2"._exec: invalid FS at path "actions.deps._dag.\"2\"._exec.input": FS is not set
```

Signed-off-by: Ben Gesoff <ben@gesoff.uk>
2022-03-13 21:38:03 +00:00
Gerhard Lazu
d48d484faf
Merge pull request #1705 from helderco/new-doc
Add front matter to new docs
2022-03-11 18:21:52 +00:00
Gerhard Lazu
881f2ee8ee
Merge pull request #1780 from helderco/doc-typo
[Doc] Fix doc typo
2022-03-11 18:20:51 +00:00
Helder Correia
45a1fb19d2
Fix doc typo
Added a few files to test the affected test.

Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-11 16:56:22 -01: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
Jffarge
dcde3c929d
Merge pull request #1651 from senk/patch-1
Allow Fullscreen on Get Started Video
2022-03-11 14:25:31 +01: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
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
Helder Correia
6204970d53
Move snippets outside of markdown
Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-10 12:35:11 -01: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
4e869d1bcf
Merge pull request #1734 from gerhard/github-action-version-fix
Fix dagger-for-github version
2022-03-09 21:55:10 +00: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
2b67e97cec
Europa docs plan updates after Client API & dagger do
Follow-up to https://github.com/dagger/dagger/pull/1683

Part of https://github.com/dagger/dagger/issues/1327

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-09 18:17:02 +00:00
Gerhard Lazu
b78be739aa
Merge pull request #1708 from helderco/build-images-doc
[Doc] Building container images
2022-03-09 17:28:50 +00:00
Helder Correia
a48d093fb8
Add documentation for building container images
Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-09 16:10:17 -01: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
Helder Correia
83cd685cb3
Add front matter to new docs
Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-08 11:32:10 -01: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
9dece5ea77
Cover packages before caching
We are still figuring out caching, specifically Buildkit go client
caching, while packages is something that users can start creating right away.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-06 00:07:17 +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
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
bda88621b6
Add the dagger.#Plan core concept to Europa Docs
This is the entry point for all other core concepts.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-04 13:47:32 +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