`./pants --loop test check fmt lint` is amazing. t...
# general
a
./pants --loop test check fmt lint
is amazing. thank you.
👖 2
💯 3
❤️ 1
h
You can even add a CLI alias to shorten that invocation, say by setting
green = "test check fmt lint"
h
This reminds me, any suggestions for where we should document CLI aliases? cc @curved-television-6568
👀 1
c
Looking now, and the first thing that hits me is, that I think the topics under “Using Pants / Key concepts” are so essential, that it almost would be better to move them up one level (as now, you don’t see them unless you unfold the “Key concepts” section in the nav menu.
1
I for one, have overlooked that there is a page dedicated to list all available backends, which is great.
💯 1
But I think cli aliases fits under the “Using Pants” chapter.
h
Ohh maybe have a "Key Concepts" section! And then we can nest "Using Pants" like we did with "Getting Started". What do you think @happy-kitchen-89482?
1
c
I think I like that.
h
(The general tension we have is that the left nav bar is too crowded)
c
I see (also, the nav is almost useless on mobile..) As you can’t navigate to the “overview” pages, as they’re all the same on mobile…
h
yeah nav on mobile is so long also, it's horrible
c
Yeah, but if it worked, it would still at least be usable 😉
👍 1
With more languages, the nav is only going to get bigger… perhaps we need to find a way to partition it, so you don’t have to see the whole thing all the time..
h
That's what the folders/sections are supposed to be for. Like I really like how Python is only 3 top-level pages. (Even if I hate how it renders on mobile)
c
That’s a good example actually.. and if more sections where like that, it would be easier to spot which were available, and force you to unfold the ones you care about…
👍 1
In that sense, Key concepts are correct (or could be promoted entirely..?) but the other sub sections of “Using pants” should find a small set of categories to be grouped under..
1
h
I think my proposal is: • New "Key concepts" section (chapter), but still keep it nested into a folder. Like the Getting Started section • Nest "Using Pants" into a folder, like Getting Started • Maybe rename "Using Pants"?
but I'll leave @happy-kitchen-89482 to do what he sees fit. He's been doing structural reorganization of docs, I've been focused on refreshing the content
👍 2
c
There’s probably, something like: • Configuration • Execution • Troubleshooting To get started..
💯 1
Maybe rename “Using Pants”?
Yeah, as everything in the docs is about using pants, one way or another (except a few topics under “Introduction” perhaps..)
1
h
I wanted to call it "Advanced Usage", but it's really not! Things like resources are an important idea. Yet also not as "Key"/foundational as the "Key Concepts" section.. It's more like "Generic features you are likely to need regardless of which languages you use"
👍 1
c
or “The Basics” 😉
1
h
Something like that! I view it as: • Key concepts -> you really really will benefit from reading this, regardless of who you are • "the basics" -> you can probably get away with not reading this start-to-finish and it's fine to read ad-hoc. You will likely need to see these pages eventually tho
💯 1
a
One thing I will add. the output from
./pants test fmt lint check
is can be quite spammy and often I find it hard to work out what commands output starts where.
2
h
What would make it better? A separator of some kind between the tools?
a
yeah, maybe. or maybe just between the goals
also, another thing i've noticed today.
--loop
'consumes' the pantsd 'slot' or whatever you call it. (same with
pants run //dev/server/
) so everything else you run needs
PANTS_CONCURRENT=yes
which I can't tell if it shouldn't be the case, or I just need to configure it myself.
h
yeah, that's a highly requested feature: https://github.com/pantsbuild/pants/issues/7654. We've been chipping away at it! I agree it's important
a
👌 nice