busy-vase-39202
01/31/2022, 7:57 PMwitty-crayon-22786
01/31/2022, 7:58 PMWe’ve heard from many of you that part of your adoption process has been to produce simplified custom internal documentation for your end-users to refer to. We’d like to create some end-user oriented docs similar to that, to make that step easier for future adopters to accomplish.from a “don’t repeat yourself” perspective, i’d love to see it accomplished by tagging certain pages “administrator” vs “consumer”, rather than necessarily having separate content
curved-television-6568
01/31/2022, 8:08 PMbusy-vase-39202
01/31/2022, 8:22 PMtagging certain pages “administrator” vs “consumer”, rather than necessarily having separate contentDepends on how long the example end user docs turn out to be. I'd like to get a look first at some examples. e.g. If it's typically just a 1-page cheatsheet, it may make more sense to maintain a separate resource. Potentially even via GH, where it's quick for admins to fork, remix, and add whitelabel.
bitter-ability-32190
01/31/2022, 8:24 PM./pants
bitter-ability-32190
01/31/2022, 8:25 PMbusy-vase-39202
01/31/2022, 8:25 PMbusy-vase-39202
01/31/2022, 8:26 PME.g. Document how to go from a Bazel "address" (or whatever they are called) into a Pants oneThat sounds like a good blog post as well.
bitter-ability-32190
01/31/2022, 8:26 PM--changed
argswitty-crayon-22786
01/31/2022, 9:25 PMgdb
or lldb
, but https://lldb.llvm.org/use/map.html is my go to when trying to learn how to do something.wide-midnight-78598
01/31/2022, 9:27 PMgit clone myrepo
• ./pants version
• ./pants test ::
• ./pants package :myawesomething
After they add new code, I show them:
• ./pants fmt ::
• ./pants lint ::
(next comes deployment, but that's more complicated and repo-dependent)
The only "challenges" I run into are explaining what the ::
means, and a few comments about global vs local vs auto-discovered dependencies when they create a new project in the monorepos.
When they want to add a new project, they can look at the existing build files and almost copy/paste/rename.
Anything more than that, I point at the docs. I personally don't even bother using the changed-since filters or anything, since VSCode handles auto-format and handles real-time lint/mypy. and then pre-commit hook handles the rest.
I should also point out that I only use 1 BUILD file per subproject, rather than one per folder, so explaining that part is pretty easy.busy-vase-39202
02/01/2022, 1:45 AMbitter-ability-32190
02/01/2022, 2:51 PMpants
could use more tooling (like tailor
, although could be one-off or standalone).
Right now I need to find the easiest way to migrate to Pants for build+test, so I'd like to see a tree of my deps and work my way in.high-yak-85899
02/02/2022, 1:13 AMbusy-vase-39202
02/02/2022, 1:31 AMwide-midnight-78598
02/02/2022, 3:49 AMbusy-vase-39202
02/02/2022, 5:14 PMbitter-ability-32190
02/02/2022, 5:17 PMbusy-vase-39202
02/02/2022, 5:23 PMhigh-yak-85899
02/02/2022, 5:26 PMbusy-vase-39202
02/02/2022, 5:29 PM