Commit Graph

235 Commits

Author SHA1 Message Date
Sam Alba
a27b7b265d docs: added page to sidebar
Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
2022-03-29 14:24:54 -07:00
jffarge
8a67e88708 init amplitude with appropriate ID
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 13:55:09 +02:00
Jffarge
2a1c4a6bf1
Merge pull request #1914 from slumbering/docs-remove-auth
remove github authentication. Documentation is now public
2022-03-29 13:43:18 +02:00
jffarge
fb10328a2b remove github authentication. Documentation is now public
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 13:28:45 +02:00
jffarge
e99afb9793 update categories descriptions
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 11:57:34 +02:00
jffarge
7abb7a8920 create generated index for core concepts and use cases
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:58:07 +02:00
jffarge
aa25e5e4fd Init auto generated category index with docusaurus
Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:20:36 +02:00
Gerhard Lazu
19d762c5dd
Simplify Europa Docs sidebar
- move Dagger 0.1 references to the top
- move Dagger CUE API under Core Concepts, after What is CUE?
- move Go on Docker Swarm under Use Cases

A few minor title changes:
- Dagger CUE API (0.2+) -> Dagger CUE API
- What is Cue? -> What is CUE?

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-29 00:14:34 +01:00
Gerhard Lazu
2a6b91cf72
Merge pull request #1805 from TomChv/doc/add-go-use-case
Docs: Add dagger golang use case
2022-03-28 23:52:59 +01:00
dependabot[bot]
35492b993b
build(deps): bump minimist from 1.2.5 to 1.2.6 in /website
Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-25 19:34:46 +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
dependabot[bot]
b09bea16ad
build(deps): bump node-forge from 1.2.1 to 1.3.0 in /website
Bumps [node-forge](https://github.com/digitalbazaar/forge) from 1.2.1 to 1.3.0.
- [Release notes](https://github.com/digitalbazaar/forge/releases)
- [Changelog](https://github.com/digitalbazaar/forge/blob/main/CHANGELOG.md)
- [Commits](https://github.com/digitalbazaar/forge/compare/v1.2.1...v1.3.0)

---
updated-dependencies:
- dependency-name: node-forge
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-24 10:50:12 +00:00
Gerhard Lazu
bd22221496
Rebuild Algolia search index for docs
Only include the Europa docs

    cd website
    ./rebuild_algolia_docs_search_index.sh
    jq is /Users/gerhard/.nix-profile/bin/jq
    docker is /Users/gerhard/.nix-profile/bin/docker
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/1202/plan/ 16 records)
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/1214/migrate-from-dagger-0.1/ 5 records)
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/index.html 40 records)
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/1213/api/ 47 records)
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/1201/ci-environment/ 15 records)
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/1203/client/ 21 records)
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/1211/go-docker-swarm/ 15 records)
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/1204/secrets/ 12 records)
    > DocSearch: https://deploy-preview-1833--devel-docs-dagger-io.netlify.app/1205/container-images/ 9 records)

    Nb hits: 180

Fixes #1832

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-23 14:57:33 +00: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
Tom Chauveau
2d3acc61e0
Add dagger golang use case
Signed-off-by: Vasek - Tom C <tom.chauveau@epitech.eu>
2022-03-16 12:14:24 +01:00
Jffarge
cea76a8429
Merge pull request #1807 from dagger/dependabot/npm_and_yarn/website/cypress-9.5.2
build(deps-dev): bump cypress from 9.5.1 to 9.5.2 in /website
2022-03-16 09:15:04 +01: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
dependabot[bot]
4f1026e5b0
build(deps-dev): bump cypress from 9.5.1 to 9.5.2 in /website
Bumps [cypress](https://github.com/cypress-io/cypress) from 9.5.1 to 9.5.2.
- [Release notes](https://github.com/cypress-io/cypress/releases)
- [Changelog](https://github.com/cypress-io/cypress/blob/develop/.releaserc.base.js)
- [Commits](https://github.com/cypress-io/cypress/compare/v9.5.1...v9.5.2)

---
updated-dependencies:
- dependency-name: cypress
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-15 19:18:47 +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
jffarge
bb8a79844e fix query string checking to avoid wrong redirection
Signed-off-by: jffarge <jf@dagger.io>
2022-03-14 12:31:33 +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
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
jffarge
617efb0bb6 Bump up docusaurus to the latest version
Signed-off-by: jffarge <jf@dagger.io>
2022-03-09 09:07:55 +01: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
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
ba9fcf864d
Add a DRAFTS section to the Europa docs sidebar
This is meant to act as catch-all for pages that have been written
ad-hoc, but don't currently fit anywhere.

While it was initially mentioned that this should be called
Knowledgebase, it didn't seem to accurately describe the intent.
The email & message default DRAFTS seemed better, so I just went with it.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-03 15:31:37 +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
Andrea Luzzardi
45759dba37
Merge pull request #1672 from dagger/always-deploy-docs-to-netlify
Always deploy the docs
2022-03-01 12:58:40 -08:00
Jffarge
621edd6b2f
Merge pull request #1665 from dagger/dependabot/npm_and_yarn/website/sass-1.49.9
build(deps): bump sass from 1.49.8 to 1.49.9 in /website
2022-03-01 20:46:56 +01:00
Jffarge
f08fd16d1c
Merge pull request #1667 from dagger/dependabot/npm_and_yarn/website/prismjs-1.27.0
build(deps): bump prismjs from 1.25.0 to 1.27.0 in /website
2022-03-01 20:46:34 +01:00
Gerhard Lazu
6ea694aac0
Always deploy the docs
The default ignore gets applied and then we have a similar behaviour to
what https://github.com/dagger/dagger/pull/1591 was attempting to fix.

We hope that this will fix it for good.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
(cherry picked from commit 24333d1a5ae3f0366762c823f1039241b5a64106)
2022-03-01 19:22:10 +00:00
dependabot[bot]
7a380ed44d
build(deps-dev): bump cypress from 9.5.0 to 9.5.1 in /website
Bumps [cypress](https://github.com/cypress-io/cypress) from 9.5.0 to 9.5.1.
- [Release notes](https://github.com/cypress-io/cypress/releases)
- [Changelog](https://github.com/cypress-io/cypress/blob/develop/.releaserc.base.js)
- [Commits](https://github.com/cypress-io/cypress/compare/v9.5.0...v9.5.1)

---
updated-dependencies:
- dependency-name: cypress
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-01 19:19:23 +00:00
dependabot[bot]
28abf690a1
build(deps): bump prismjs from 1.25.0 to 1.27.0 in /website
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.25.0 to 1.27.0.
- [Release notes](https://github.com/PrismJS/prism/releases)
- [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PrismJS/prism/compare/v1.25.0...v1.27.0)

---
updated-dependencies:
- dependency-name: prismjs
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-26 02:12:40 +00:00
dependabot[bot]
b13d854f8f
build(deps): bump sass from 1.49.8 to 1.49.9 in /website
Bumps [sass](https://github.com/sass/dart-sass) from 1.49.8 to 1.49.9.
- [Release notes](https://github.com/sass/dart-sass/releases)
- [Changelog](https://github.com/sass/dart-sass/blob/main/CHANGELOG.md)
- [Commits](https://github.com/sass/dart-sass/compare/1.49.8...1.49.9)

---
updated-dependencies:
- dependency-name: sass
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-25 19:14:28 +00:00
dependabot[bot]
fc0ac471c9
build(deps-dev): bump cypress-localstorage-commands in /website
Bumps [cypress-localstorage-commands](https://github.com/javierbrea/cypress-localstorage-commands) from 1.6.1 to 1.7.0.
- [Release notes](https://github.com/javierbrea/cypress-localstorage-commands/releases)
- [Changelog](https://github.com/javierbrea/cypress-localstorage-commands/blob/master/CHANGELOG.md)
- [Commits](https://github.com/javierbrea/cypress-localstorage-commands/compare/v1.6.1...v1.7.0)

---
updated-dependencies:
- dependency-name: cypress-localstorage-commands
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-22 19:20:22 +00:00
Jffarge
0309c07779
Merge pull request #1619 from dagger/dependabot/npm_and_yarn/website/cypress-9.5.0
build(deps-dev): bump cypress from 9.4.1 to 9.5.0 in /website
2022-02-21 09:44:41 +01:00
dependabot[bot]
2cfa97384c
build(deps): bump sass from 1.49.7 to 1.49.8 in /website
Bumps [sass](https://github.com/sass/dart-sass) from 1.49.7 to 1.49.8.
- [Release notes](https://github.com/sass/dart-sass/releases)
- [Changelog](https://github.com/sass/dart-sass/blob/main/CHANGELOG.md)
- [Commits](https://github.com/sass/dart-sass/compare/1.49.7...1.49.8)

---
updated-dependencies:
- dependency-name: sass
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-18 19:22:11 +00:00
dependabot[bot]
78e7a0ee64
build(deps-dev): bump cypress from 9.4.1 to 9.5.0 in /website
Bumps [cypress](https://github.com/cypress-io/cypress) from 9.4.1 to 9.5.0.
- [Release notes](https://github.com/cypress-io/cypress/releases)
- [Changelog](https://github.com/cypress-io/cypress/blob/develop/.releaserc.base.js)
- [Commits](https://github.com/cypress-io/cypress/compare/v9.4.1...v9.5.0)

---
updated-dependencies:
- dependency-name: cypress
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-15 19:14:54 +00:00
Andrea Luzzardi
e3131671a7
Merge pull request #1616 from dagger/dependabot/npm_and_yarn/website/follow-redirects-1.14.8
build(deps): bump follow-redirects from 1.14.7 to 1.14.8 in /website
2022-02-14 15:39:11 -07:00
Andrea Luzzardi
9641b4254c
Merge pull request #1609 from dagger/dependabot/npm_and_yarn/website/amplitude-js-8.17.0
build(deps): bump amplitude-js from 8.16.1 to 8.17.0 in /website
2022-02-14 15:22:49 -07:00
dependabot[bot]
1cd6441f88
build(deps): bump follow-redirects from 1.14.7 to 1.14.8 in /website
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.7 to 1.14.8.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.14.7...v1.14.8)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-14 08:33:54 +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
dependabot[bot]
8556aa1f39
build(deps): bump amplitude-js from 8.16.1 to 8.17.0 in /website
Bumps [amplitude-js](https://github.com/amplitude/amplitude-javascript) from 8.16.1 to 8.17.0.
- [Release notes](https://github.com/amplitude/amplitude-javascript/releases)
- [Changelog](https://github.com/amplitude/Amplitude-JavaScript/blob/main/CHANGELOG.md)
- [Commits](https://github.com/amplitude/amplitude-javascript/compare/v8.16.1...v8.17.0)

---
updated-dependencies:
- dependency-name: amplitude-js
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-11 19:14:49 +00:00
Gerhard Lazu
5de4a7e75b
Always build the docs website
If we trigger a deploy, then we want the deploy to actually run.

I am assuming that this was in place when there was a single GitHub
Actions workflow that would trigger this all the time, even when nothing
changed in `docs/**`. Since https://github.com/dagger/dagger/pull/1498,
we no longer have this problem.

After merging https://github.com/dagger/dagger/pull/1591, I was caught
by this behaviour which to me seemed surprising. This change should make
docs deploy via Netlify behave in a more predictable way.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-10 11:07:46 +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