Skip to content

docs: added a page about CLI telemetry#1929

Merged
samalba merged 2 commits into
dagger:mainfrom
samalba:docs-cli-telemetry
Mar 29, 2022
Merged

docs: added a page about CLI telemetry#1929
samalba merged 2 commits into
dagger:mainfrom
samalba:docs-cli-telemetry

Conversation

@samalba
Copy link
Copy Markdown
Contributor

@samalba samalba commented Mar 29, 2022

Fixes #832

Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
@samalba samalba requested a review from shykes March 29, 2022 21:16
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 29, 2022

Deploy Preview for devel-docs-dagger-io ready!

Name Link
🔨 Latest commit a27b7b2
🔍 Latest deploy log https://app.netlify.com/sites/devel-docs-dagger-io/deploys/6243792e96ef4e000827fe19
😎 Deploy Preview https://deploy-preview-1929--devel-docs-dagger-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Signed-off-by: Sam Alba <samalba@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@aluzzardi aluzzardi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

For future reference, commits should say "add" rather than "added":

Use the imperative mood in the subject line: "If applied, this commit will [your subject line here]"

https://github.com/dagger/.github/blob/main/CONTRIBUTING.md#commit-messages

Copy link
Copy Markdown
Contributor

@shykes shykes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Ideally we should move it outside of "core concepts", but there is no other good category at the moment, so we can worry about that later. Perhaps integrate it into a bigger FAQ?

@gerhard
Copy link
Copy Markdown
Contributor

gerhard commented Mar 29, 2022

Do you think that this would fit under Advanced Concepts?

This is what I was imagining: #1804 (comment)

@shykes
Copy link
Copy Markdown
Contributor

shykes commented Mar 29, 2022

Do you think that this would fit under Advanced Concepts?

This is what I was imagining: #1804 (comment)

"advanced concepts" does't feel right in this case, it's not really something to learn and master, more like an (important) detail of Dagger's behavior, that is important to know as an admin / operator.

--> Typing this, I think it would fit great in a "operator's manual" category. We already have the "custom buildkit" article waiting to be moved to 0.2, so we would have:

  • Operator's manual
    • Custom buildkit configuration
    • CLI telemetry

@samalba
Copy link
Copy Markdown
Contributor Author

samalba commented Mar 29, 2022

I agree it should move another category at some point. I just did not want to create a new one just for that.

@samalba samalba merged commit 9f196ca into dagger:main Mar 29, 2022
@samalba samalba deleted the docs-cli-telemetry branch March 29, 2022 23:22
@gerhard
Copy link
Copy Markdown
Contributor

gerhard commented Mar 29, 2022

--> Typing this, I think it would fit great in a "operator's manual" category. We already have the "custom buildkit" article waiting to be moved to 0.2, so we would have:

  • Operator's manual

    • Custom buildkit configuration
    • CLI telemetry

"Operator" introduces the dimension of personas and it doesn't fit with the existing categorisation.

The initial idea was:

  1. Get started
  2. Understand the core of Dagger
  3. Learn from real-world use-cases

The next iteration on that would be:

  1. Get started
  2. Understand the core of Dagger
  3. Dive into more advanced Dagger topics
  4. Learn from real-world use-cases

Introducing operators, app devs and package devs sounds like something that we may want to do after the second iteration as it's a bigger step. It is a good idea and I know that this will become necessary as we add more content, but I want to keep it consistent and simple for now.

The other option for now might be to not put this page into a category, just like we do with the Migrate from Dagger 0.1 page. This page could fit after Use Cases and before Dagger 0.1, which will be last.

@shykes
Copy link
Copy Markdown
Contributor

shykes commented Mar 29, 2022

It's not about persona, but about having a reference manual. You need a place to reference various things to know, that don't fit into a neat linear narrative. There used to be a "knowledge base" category but that got removed. Call it whatever you want but that place needs to exist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tracking in dagger tool, and how to opt out

4 participants