Commit Graph

135 Commits

Author SHA1 Message Date
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
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
Joel Longtine
56ecf7f8cd Clean up .gitignore files
Signed-off-by: Joel Longtine <joel@dagger.io>
2022-02-23 12:20:01 -07:00
Joel Longtine
0705b0eeae Skip non-europa tests
Signed-off-by: Joel Longtine <joel@dagger.io>
2022-02-23 12:20:01 -07:00
Solomon Hykes
c2766c265b Merge dagger.io/dagger/engine into dagger.io/dagger
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-02-16 19:40:28 +00:00
Guillaume Coguiec
bd0f276d30
typo: Fix some minor typos.
Signed-off-by: Guillaume Coguiec <guillaume@logical.work>
2022-02-07 21:10:25 -05:00
Gerhard Lazu
88d78a963d
Use CONTRIBUTING from our org
Rather than having multiple CONTRIBUTING files, one for each repository,
which we will need to keep in sync, we could use GitHub's special .github
repository for community files.

This idea was first reported by @bpo in the context of the examples
repository: https://github.com/dagger/examples/pull/47#issuecomment-1012517202

I have added it as https://github.com/dagger/.github and explained how
the contributing flow now changed for first-time contributors to *any*
repository in our org: https://github.com/dagger/examples/pull/47#issuecomment-1013450052

There is more info on this feature here:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

We could continue by adding CODE_OF_CONDUCT, SECURITY etc. files and all
our repositories will use them, without needing to add these files to
each repository.

Is this a GitHub feature something that fits us?

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-01-20 16:29:07 +00:00
jffarge
2d8c296f39 docs: 🐛 fix wrong gcpcloudrun package url
Issues closed by this change: https://github.com/dagger/dagger/issues/1218

Signed-off-by: jffarge <jf@dagger.io>
2022-01-14 09:16:40 +01:00
Sam Alba
1de440f83b tests: upgraded bats
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2021-12-17 13:25:04 -08:00
Sam Alba
40e1b28133 ci: reduced docs test suite timeout + disabled parallelization within a suite
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2021-12-16 17:10:49 -08:00
Jean-Yves Gastaud
7ad5f264e6 docs: make dev-cue-package example naming consitant
Signed-off-by: Jean-Yves Gastaud <jygastaud@gmail.com>
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2021-12-14 16:08:20 -08:00
Sam Alba
d03e345c52 ci: disabled several tests to debug CI issues in Docs tests
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2021-12-14 15:09:44 -08:00
jffarge
05c31df35d docs: 🐛 push the actual iframe fix + force netlify node version
Signed-off-by: jffarge <jeanfrancois.farge@gmail.com>
2021-12-09 17:57:48 +01:00
Sam Alba
a34cb55114 docs: fixed iframe markup
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2021-12-04 13:28:12 -08:00
Richard Jones
590a56c2ca
inline style, larger video
Signed-off-by: Richard Jones <richard@dagger.io>
2021-12-03 10:43:09 -07:00
Richard Jones
27b2275d3a
embedded video on getting started tutorial
Signed-off-by: Richard Jones <richard@dagger.io>
2021-12-02 12:37:24 -07:00
Sam Alba
bbbecf8830 test: fixed ci
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2021-11-30 18:26:57 -08:00
guillaume
475e47de09 Modify getting started doc to integrate http.#Wait, fix doc dependency issue
Signed-off-by: guillaume <guillaume.derouville@gmail.com>
2021-11-23 21:30:03 +01:00
Joel Clermont
30d9981ee3 typo fixes
Signed-off-by: Joel Clermont <jclermont@gmail.com>
2021-11-19 16:51:20 -06:00
guillaume
b38cb606f4 Fix infinite loop inside doc test + fix issue
Signed-off-by: guillaume <guillaume.derouville@gmail.com>
2021-11-16 15:50:46 +01:00
Richard Jones
ff78b51c83
clarified builtin vs third-party packages
Signed-off-by: Richard Jones <richard@dagger.io>
2021-11-12 14:42:15 -07:00
Benjamin Reigner
50496f9bf0
docs: fix cue file path for gcp doc part
In the documentation the specified path for the source.cue indicates
it under the cue.mod folder, meanwhile everything is set up outside of
it. Puting the source.cue file in its specified folder resulted in the
example not working, meanwhile puting it in the gcpcloudrun folder
directly resulted in the example perfectly working

Signed-off-by: Benjamin Reigner <benjamin.reigner@epitech.eu>
2021-11-07 19:50:32 +01:00
Jonathan Hult
d0e7d9b564
Link to new CUE GitHub repository
https://github.com/cue-lang/cue/issues/1078

Signed-off-by: Jonathan Hult <Jonathan@JonathanHult.com>
2021-10-20 14:49:26 -04:00
Sam Alba
e9ca8f38e6 Vendoring improved
* update dagger init with package manager downloading stdlib

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* split mod get and update functions

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* write to package checksum to dagger.sum when installing/updating

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* encure checksums are valid when compiling input

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* remove references to github.com/tjovicic in docs 1010 and 1011

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* refactor mod get command

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* update logic of moving dir when installing packages

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* fix linting errors

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* revert changes to 1010 docs

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* updating error log line in mod/get

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* fix ci tests when using vendoring

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* update alpha.dagger.io version to v0.1

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* fix mod repo test

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* return error if package already installed

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* remove already installed packages when installing

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* fix issue when vendoring stdlib

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* update mod command with filelock while installing

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* fix linting errors

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

* fix path of mod lock file

Signed-off-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

Co-authored-by: Tihomir Jovicic <tihomir.jovicic.develop@gmail.com>

Signed-off-by: Sam Alba <sam.alba@gmail.com>
2021-10-13 15:25:30 -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
Sam Alba
2da9d07302 docs: use different port for getting started registry
Signed-off-by: Sam Alba <sam.alba@gmail.com>
2021-10-05 19:12:16 -07:00
Sam Alba
91ad12bff1 docs: added missing dagger init
Signed-off-by: Sam Alba <sam.alba@gmail.com>
2021-10-05 18:59:34 -07:00
Sam Alba
d39cc200ca docs: added abililty to run a local registry for todoapp example
Signed-off-by: Sam Alba <sam.alba@gmail.com>
2021-10-05 18:47:33 -07:00
Andrea Luzzardi
dd1bf18ec2 logger: TTY logs support (live update)
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-05 15:38:34 -07:00
Richard Jones
33242a1a7d
cleanup unnecessary file
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 15:27:06 -06:00
Richard Jones
a1c2d14162
moved what is cue page to Learn section
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 15:26:49 -06:00
Richard Jones
7c55d38625 removed registry
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
f48d145f03 added registry to test, and fixed cp commands
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
79489ffe36 cue fmt the right way
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
4c7d90f9bc cue fmt
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
35a86441bf added test
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
46c02c7563 proofreading corrections
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
b78169ed3f typos, comments, and clarifications
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
ef66f0bc69 new getting started tutorial
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
00e10219ca additional progress
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
be2aeeccdf initial work on new getting started tutorial
Signed-off-by: Richard Jones <richard@dagger.io>
2021-10-05 13:33:05 -06:00
Richard Jones
11749cde01 replaced workspace with project
Signed-off-by: Richard Jones <richard@dagger.io>
2021-09-23 16:03:02 -07:00
Richard Jones
68f18887da
changed workspace to project for tests
Signed-off-by: Richard Jones <richard@dagger.io>
2021-09-23 12:07:09 -06:00
Richard Jones
0037fa1f2f additional information, new Packages section, and fix linting
Signed-off-by: Richard Jones <richard@dagger.io>
2021-09-21 11:41:13 -07:00
Richard Jones
8c46a1d2f1 initial work on what is cue
Signed-off-by: Richard Jones <richard@dagger.io>
2021-09-21 11:41:13 -07:00
Andrea Luzzardi
7073bc89c0
Merge pull request #979 from ming535/chore
Fix Typo
2021-09-15 15:27:22 -07:00
huming
2b22c4cf36 Fix Typo
Signed-off-by: huming <humings@gmail.com>
2021-09-15 15:52:58 +08:00
Solomon Hykes
1eec9ec8fe Docs: remove unfinished "custom script" tutorial
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2021-09-14 22:30:52 -07:00
Sam Alba
c7b9549afa
Merge pull request #953 from slumbering/docs-menu-refacto
docs: ♻️ merge API Reference and Universe menu entries
2021-09-10 08:58:22 -07:00
Guillaume de Rouville
6f23e9fe2a refacto/doc: remove 'cue init' step from doc
Signed-off-by: Guillaume de Rouville <guillaume.derouville@gmail.com>
2021-09-08 22:31:47 +02:00