Shape of the new Europa docs#1568
Merged
gerhard merged 1 commit intodagger:mainfrom Feb 10, 2022
gerhard:europa-docs
Merged
Conversation
|
✔️ Deploy Preview for devel-docs-dagger-io ready! 🔨 Explore the source changes: 78d5d49 🔍 Inspect the deploy log: https://app.netlify.com/sites/devel-docs-dagger-io/deploys/6204df22a49d670007c8faf0 😎 Browse the preview: https://deploy-preview-1568--devel-docs-dagger-io.netlify.app |
gerhard
changed the title
Contributor
Author
|
Two core concepts are must haves (via @samalba):
|
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 <[email protected]>
gerhard
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a starting point, the new pages are placeholders for now. As a first step, we care about "the shape" of the new docs:
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.
As a first step, we only want the bare minimum for new users that on-board with Dagger Europa. As soon as the new
europaSidebarreplaces 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 defaultslug: /to point to the Europa Docs entrypoint, which is doc 1200.| 💡 Helpful Docusaurus multiple sidebars reference: https://docusaurus.io/docs/sidebar/multiple-sidebars
The new pages are numbered from
1200onwards. This is meant to reflect the0.2.0Dagger 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 at2000, but that was my first instinct.I am keen on seeing this live on https://docs.dagger.io/1200/local-ci. If it's not in production, it is inventory, which is a form of waste. That is obviously bad, and this explains why: The Goal. Yes, I know, we are not a factory, but see the big picture.
The goal is to allow anyone that has a link to get a feel for the new docs 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 timelines and milestones, and do the minimum work possible. Thinking of it as a form of experimentation - a.k.a. "the journey towards better" - is a great way of framing it.
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), continuously refined by user feedback (including our own!). One day, we realise that we are ready to release, and then we just enable it by default. That is the principle behind these docs.