Commit Graph

353 Commits

Author SHA1 Message Date
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
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
Almog Tavor
511584af62
Fix a typo in the docs
Fix a typo in the docs

Signed-off-by: Almog Tavor <almogtavor@gmail.com>
2022-02-23 23:43:28 +02:00
Joel Longtine
80a052afe0 Remove old docs
Signed-off-by: Joel Longtine <joel@dagger.io>
2022-02-23 12:20:01 -07: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
4cc93098a1 Remove old docs
Signed-off-by: Joel Longtine <joel@dagger.io>
2022-02-23 12:20:01 -07:00
Joel Longtine
eeb20a3999 Temporary fix for markdownlint
Signed-off-by: Joel Longtine <joel@dagger.io>
2022-02-23 12:20:01 -07:00
Joel Longtine
e8bd1acd85 make docs
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
Joel Longtine
b32e2da0a5 make docs
Signed-off-by: Joel Longtine <joel@dagger.io>
2022-02-23 12:20:01 -07:00
Robin Naundorf
800f979ce6 Update 1003-get-started.md
Allow Fullscreen for Get Started Video

Signed-off-by: Robin Naundorf <r.naundorf@fh-muenster.de>
2022-02-23 10:58:19 +00:00
Gerhard Lazu
1d67845bcf
Answer a few contributor questions via a docs README
Related to:
- https://github.com/dagger/dagger/issues/1327
- https://github.com/dagger/dagger/issues/1510
- https://github.com/dagger/dagger/pull/1579/files#diff-cc0394489dc78fcfe672bb9883b760be86a495bf553b5bc950e6203779f00ae1
- https://github.com/dagger/dagger/pull/1632/files

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-18 15:58:23 +00:00
Solomon Hykes
724be92bb4 Utility script to create a new docs page with the correct ID
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-02-17 01:41:59 +00: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
Gerhard Lazu
d838cd6047
Fix markdown lint errors
Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-12 18:37:03 +00:00
Gerhard Lazu
3a2f861dd9
Finish the first version of the Go on Docker Swarm use case
Left a few TODOs and ideas for next steps. The goal is to get this live,
and enable others to iterate on it via separate PRs.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-12 18:27:19 +00:00
Gerhard Lazu
3747c6e5c4
First pass at the Go on Docker Swarm doc page
There are a few more things to do before we can finish this, see the
comments in the doc. The most important item is to switch the Dagger
config to Europa. That is actually one of the next steps.

Sharing this early so that we start collaborating. Pushing to a branch
in the dagger org so that we can work on it together (personal
repositories make it more difficult).

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-11 15:35:24 +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
Gerhard Lazu
c8e42af05a
Use unique IDs for all existing doc pages
- what_is didn't have an id, started with 1000 (it's easier to find this file now)
- operator-manual doc id was clashing with ci use-case

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-10 07:38:11 +00:00
Solomon Hykes
fab39bf3f7 Fix docs lint errors
Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-02-08 20:12:05 +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
Benjamin Reigner
900f23215e
fix: Build from source instructions
The build from source instructions were deprecated since it prints the
available make targets when running `make` whereas, before it built
dagger in dev mode.
Now to build dagger in dev mode, you have to run `make dagger`.
The doc is now up to date with this.

Signed-off-by: Benjamin Reigner <benjamin.reigner@epitech.eu>
2022-01-28 11:38:04 +01:00
jffarge
472a86d4ef Display caution message about docker requirement
Signed-off-by: jffarge <jeanfrancois.farge@gmail.com>
2022-01-25 13:41:48 +01: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
Gerhard Lazu
e43f6db4b1
Merge pull request #1399 from grouville/improve-doc
Improve doc's main image loading time
2022-01-12 11:53:48 +00:00
Andrea Luzzardi
27059ff74d docs: update
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2022-01-11 16:51:54 -08:00
guillaume
aaa893c7a4 Improve doc's main image loading time
Doc's main image is currently heavy.
This PR makes it 5x smaller while keeping equivalent design

Pairs: @gerhard, @slumbering

Signed-off-by: guillaume <guillaume.derouville@gmail.com>
2022-01-12 01:01:51 +01:00
Andrea Luzzardi
f7de4500a4 docs: update auto-generated docs
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2022-01-11 11:38:22 -08:00
Andrea Luzzardi
5f840723e2 engine: LoadSecret->NewSecret
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2022-01-07 12:08:37 -08:00
Andrea Luzzardi
6a70271ff2 engine.#LoadSecret support
Fixes #1305

Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2022-01-07 12:08:37 -08:00