#The documentation is lacking

1 messages · Page 1 of 1 (latest)

copper raven
#

The developer experience could be improved by adding semantic search, e.g., through https://www.algolia.com/products/ai-search/, because it is really hard to find answers. Partly because the organization makes no sense. What is logic behind organizing content under "User Manual" and "Developer Manual". I use Dagger and I am a developer. I don't work on dagger yet I have to look under both categories. The API docs are under Developer and things like file system access (https://docs.dagger.io/manuals/user/620164/host-fs) are under User. I only found that link because I searched Discord, which is the least searchable product in existence.

Finally, the examples are really lacking. I have to turn to Discord for examples, which as I already said sucks to search.

Host Filesystem Access | Dagger

Dagger Functions do not have access to the filesystem of the host you invoke the Dagger Function from (i.e. the host you execute a CLI command like dagger call from). Instead, host files and directories need to be explicitly passed when executing dagger call.

pine cargo
# copper raven The developer experience could be improved by adding semantic search, e.g., thro...

Thanks for the honest feedback @copper raven !

We are doing a major overhaul to the docs along with other DX improvements this quarter. We moved from our previous SDK approach to multi-language Dagger functions and modules, but still are working on the best way to present everything in the docs. We also have a lot of guides and cookbook examples to port over. All that is happening now.

cc @haughty garnet @summer trail @hollow coyote @jaunty tree

jaunty tree
#

What is logic behind organizing content under "User Manual" and "Developer Manual"

  • You can use Dagger without writing code, by calling functions developed by others. That's documented in the user manual.

  • You can develop Dagger Modules, which requires choosing an SDK and writing code. That's documented in the developer manual.

stark trellis
copper raven
#

I'm building a CI pipeline. I use others' modules but I would get nowhere without writing my own code too. If the distinction is purely about module usage vs module development mention "Modules" at the top level! It's not there.

As I see it, I'm not developing a module; I'm writing a script. Aren't modules the things you share on daggerverse? I'm not going to share my CI pipeline, obviously.

jaunty tree
#

In the current terminology of the docs (which I understand you find confusing), you're a module developer because you're developing your CI pipeline as code, in the form of Dagger Functions.

The rest of your team, if they call these functions from the command-line (a common use case since Dagger supports local execution), would be users.

It looks like the term "scripting" instead of "developing" would help address your concern.

#

Thanks for your feedback