#Coordinating CLI & docs changes
1 messages ยท Page 1 of 1 (latest)
FYI I gave Vikram a heads up on the following:
- Breaking CLI changes coming soon, for polish (eg.
dagger mod init->dagger init,dagger mod install->dagger installetc). If possible, keeping the old names still working but hidden might make things easier (more wiggle room for docs to lag slightly behind CLI, if it comes to that)
- New ability to
dagger installmodules without having to write code yourself. Combined with the ability todagger call -m SHORTNAME, which will become the new recommended best practice.
- Future (but hopefully coming soon ๐ค ) ability to wrap function calls in convenience "scripts" to match convenience of
npm run,makeetc. Just knowing that this is coming soon, even if not yet fully designed, is useful for Vikram to know
The general approach is to iterate early and often
Hi friends, tonight (if I have the energy) or tomorrow I will go over the CLI and submit nits, is that ok @misty violet ?
I'm bringing it up here because if we change anything last minute, we need to make sure it doesn't break the docs
@misty violet should I wait for specific PRs to drop before reviewing?
(I mean overall CLI UX review, proposing last minute cosmetic changes to command names or flags, that sort of thing)
Just let me know what's the least disruptive way to do this ๐
Oh I guess this might be the answer? https://github.com/dagger/dagger/pull/6533
Yes that ๐
@pliant lotus also has a bunch of improvements to the docstrings on commands in this one: https://github.com/dagger/dagger/pull/6509 was gonna rebase mine of top of his since I think it's good to go
And SGTM about reviewing, my plan was:
- review the quickstart in case there's anything significant that would be impacted
- once mine and helder's PR is merged, go do another pass on the quickstart to make relevant tweaks