Commit Graph

17 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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