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.
ee95b323ab
dagger/website/sidebars.js

112 lines
2.4 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 = {
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 16:05:07 +01:00
preEuropa: [
docs: feat: :sparkles: init Docusaurus Signed-off-by: slumbering <slumbering.pierrot@gmail.com>
2021-06-02 16:53:39 +02:00
{
docs: define sidebar manually Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-09 01:18:02 +02:00
type: "category",
label: "Introduction",
docs: :lipstick: Update UI Signed-off-by: jffarge <jf@dagger.io>
2021-12-23 12:07:18 +01:00
collapsible: true,
docs: define sidebar manually Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-09 01:18:02 +02:00
items: ["introduction/what_is", "introduction/vs"],
},
{
type: "doc",
id: "install",
},
{
type: "category",
label: "Learn Dagger",
docs: :lipstick: Update UI Signed-off-by: jffarge <jf@dagger.io>
2021-12-23 12:07:18 +01:00
collapsible: true,
collapsed: false,
docs: define sidebar manually Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-09 01:18:02 +02:00
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",
docs: :lipstick: Update UI Signed-off-by: jffarge <jf@dagger.io>
2021-12-23 12:07:18 +01:00
collapsible: true,
collapsed: true,
docs: define sidebar manually Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-09 01:18:02 +02:00
items: ["use-cases/ci"],
},
{
type: "category",
label: "Universe - API Reference",
collapsible: true,
docs: :lipstick: Update UI Signed-off-by: jffarge <jf@dagger.io>
2021-12-23 12:07:18 +01:00
collapsed: true,
docs: define sidebar manually Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-09 01:18:02 +02:00
// generate the sidebar for reference doc automatically
items: [
{
type: "autogenerated",
dirName: "reference",
},
],
},
{
type: "category",
label: "Administrator Manual",
docs: :lipstick: Update UI Signed-off-by: jffarge <jf@dagger.io>
2021-12-23 12:07:18 +01:00
collapsible: true,
collapsed: true,
docs: define sidebar manually Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-10-09 01:18:02 +02:00
items: ["administrator/operator-manual"],
docs: feat: :sparkles: init Docusaurus Signed-off-by: slumbering <slumbering.pierrot@gmail.com>
2021-06-02 16:53:39 +02:00
},
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 16:05:07 +01:00
{
type: "link",
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 21:12:50 +01:00
label: "Dagger 0.2 ➡️",
href: "/",
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 16:05:07 +01:00
},
docs: feat: :sparkles: init Docusaurus Signed-off-by: slumbering <slumbering.pierrot@gmail.com>
2021-06-02 16:53:39 +02:00
],
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 16:05:07 +01:00
europa: [
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,
collapsed: false,
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-11 01:47:32 +01:00
items: ["getting-started/local-dev", "getting-started/ci-environment"],
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,
items: [
"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",
"core-concepts/container-images",
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
],
},
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 16:25:33 +01:00
{
type: "category",
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-11 01:47:32 +01:00
label: "Knowledge Base",
collapsible: false,
collapsed: false,
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 16:25:33 +01:00
items: [
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-11 01:47:32 +01:00
"knowledge-base/migrate-from-dagger-0.1",
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 16:25:33 +01:00
"learn/api",
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 19:58:17 +01:00
"use-cases/go-docker-swarm",
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 16:25:33 +01:00
],
},
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 16:05:07 +01:00
{
type: "link",
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 21:12:50 +01:00
label: "⬅️ Dagger 0.1",
href: "/1200/what/",
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 16:05:07 +01: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