kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity
This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
37db71104c
dagger/website/sidebars.js

155 lines
3.5 KiB
JavaScript
Raw Normal View History

docs: feat: :sparkles: init Docusaurus Signed-off-by: slumbering <slumbering.pierrot@gmail.com>
2021-06-02 16:53:39 +02:00
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
module.exports = {
website: hardcode version banner for 0.1 docs O.1 docs is deprecated. Let's inform user to switch the the latest version Signed-off-by: user.email <jf@dagger.io>
2022-04-13 15:58:51 +02:00
"0.2": [
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-07 23:16:01 +01:00
{
type: "category",
label: "Getting Started",
collapsible: false,
Init auto generated category index with docusaurus Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:20:36 +02:00
link: {
Display getting started as the index page Signed-off-by: jffarge <jf@dagger.io>
2022-03-31 15:53:25 +02:00
type: 'doc',
id: 'getting-started/index'
Init auto generated category index with docusaurus Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:20:36 +02:00
},
Copied Dagger vs documentation to Europa. Signed-off-by: kgb33 <keltonbassingthwaite@gmail.com>
2022-04-01 05:31:39 +02:00
items: ["getting-started/local-dev", "getting-started/ci-environment", "getting-started/vs"],
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-07 23:16:01 +01:00
},
{
type: "category",
label: "Core Concepts",
collapsible: false,
collapsed: false,
create generated index for core concepts and use cases Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:58:07 +02:00
link: {
type: 'generated-index',
title: 'Core Concepts',
},
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-07 23:16:01 +01:00
items: [
Docs: core concepts: actions Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-07 04:07:41 +02:00
"core-concepts/action",
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-07 23:16:01 +01:00
"core-concepts/plan",
Add new Client API Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-03-07 14:12:39 +01:00
"core-concepts/client",
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-07 23:16:01 +01:00
"core-concepts/secrets",
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 19:17:14 +01:00
"core-concepts/what-is-cue",
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-07 23:16:01 +01:00
],
},
Docs: new category "guides" Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-07 02:07:05 +02:00
{
type: "category",
label: "Guides",
collapsible: false,
collapsed: false,
Docs: Add docs to sidebar Add documentation to sidebar + fix missing previous ones Signed-off-by: guillaume <guillaume.derouville@gmail.com>
2022-04-08 11:31:01 +02:00
items: [
docs: Move contribution guide to docs website Also adding a CONTRIBUTING.md file for GitHub links and easier discovery for someone browsing the repository’s files. Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
2022-04-04 15:19:49 +02:00
"guides/contributing",
"guides/coding-style",
Docs: Add docs to sidebar Add documentation to sidebar + fix missing previous ones Signed-off-by: guillaume <guillaume.derouville@gmail.com>
2022-04-08 11:31:01 +02:00
"guides/container-images",
"guides/cli-telemetry",
"guides/docker-cli-load",
"guides/docker-cli-run",
"guides/custom-buildkit",
"guides/self-signed-certificates",
"guides/pushing-plan-dependencies",
docs: Add guide to showcase handling outputs Add a guide which highlights how to handle action's outputs by writing them to the client filesystem and using CUE's integrations to marshal them as JSON. Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2022-04-11 23:55:36 +02:00
"guides/coding-style",
"guides/handling-outputs",
Docs: Add docs to sidebar Add documentation to sidebar + fix missing previous ones Signed-off-by: guillaume <guillaume.derouville@gmail.com>
2022-04-08 11:31:01 +02:00
],
Docs: new category "guides" Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-07 02:07:05 +02:00
},
Docs: core actions reference Signed-off-by: Solomon Hykes <solomon@dagger.io>
2022-04-07 21:06:29 +02:00
{
type: "category",
label: "References",
collapsible: false,
collapsed: false,
items: [
"references/core-actions-reference",
],
},
Add dagger golang use case Signed-off-by: Vasek - Tom C <tom.chauveau@epitech.eu>
2022-03-15 14:32:26 +01:00
{
type: "category",
label: "Use Cases",
collapsible: false,
collapsed: false,
create generated index for core concepts and use cases Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:58:07 +02:00
link: {
type: 'generated-index',
title: 'Use Cases',
description:
update categories descriptions Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 11:57:34 +02:00
"See how others are using Dagger for their CI/CD pipelines. This includes integrating with CI environments.",
create generated index for core concepts and use cases Signed-off-by: jffarge <jf@dagger.io>
2022-03-29 10:58:07 +02:00
},
Add dagger golang use case Signed-off-by: Vasek - Tom C <tom.chauveau@epitech.eu>
2022-03-15 14:32:26 +01:00
items: [
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 01:14:34 +02:00
"use-cases/go-docker-swarm",
Add dagger golang use case Signed-off-by: Vasek - Tom C <tom.chauveau@epitech.eu>
2022-03-15 14:32:26 +01:00
],
},
website: hardcode version banner for 0.1 docs O.1 docs is deprecated. Let's inform user to switch the the latest version Signed-off-by: user.email <jf@dagger.io>
2022-04-13 15:58:51 +02:00
{
type: "doc",
id: "migrate-from-dagger-0.1",
},
Move Dagger 0.1 link back to the bottom As mentioned in https://github.com/dagger/dagger/pull/1904#issuecomment-1081292442 Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-30 01:47:40 +02:00
{
type: "link",
label: "⬅️ Dagger 0.1",
website: hardcode version banner for 0.1 docs O.1 docs is deprecated. Let's inform user to switch the the latest version Signed-off-by: user.email <jf@dagger.io>
2022-04-13 15:58:51 +02:00
href: "/0.1",
},
],
"0.1": [
{
type: "category",
label: "Introduction",
collapsible: true,
items: ["introduction/what_is", "introduction/vs"],
},
{
type: "doc",
id: "install",
},
{
type: "category",
label: "Learn Dagger",
collapsible: true,
collapsed: false,
items: [
"learn/what_is_cue",
"learn/get-started",
"learn/google-cloud-run",
"learn/kubernetes",
"learn/aws-cloudformation",
"learn/github-actions",
"learn/dev-cue-package",
"learn/package-manager",
],
},
{
type: "category",
label: "Use Cases",
collapsible: true,
collapsed: true,
items: ["use-cases/ci"],
},
{
type: "category",
label: "Universe - API Reference",
collapsible: true,
collapsed: true,
// generate the sidebar for reference doc automatically
items: [
{
type: "autogenerated",
dirName: "reference",
},
],
},
{
type: "category",
label: "Administrator Manual",
collapsible: true,
collapsed: true,
items: ["administrator/operator-manual"],
},
{
type: "link",
label: "Dagger 0.2 ➡️",
href: "/",
Move Dagger 0.1 link back to the bottom As mentioned in https://github.com/dagger/dagger/pull/1904#issuecomment-1081292442 Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-03-30 01:47:40 +02:00
},
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-07 23:16:01 +01:00
],
docs: feat: :sparkles: init Docusaurus Signed-off-by: slumbering <slumbering.pierrot@gmail.com>
2021-06-02 16:53:39 +02:00
};
Reference in New Issue Copy Permalink