pants icon indicating copy to clipboard operation
pants copied to clipboard

Add how to guides to Pants docs

Open Eric-Arellano opened this issue 3 years ago • 2 comments

https://www.youtube.com/watch?v=eWaWvUhpseM differentiates between how tos vs. guides vs. API references. Right now, Pants is missing dedicated how tos for things like:

  • adding a linter
  • publishing lots of wheels out of a monorepo
  • setting up a test to run with Pants
    • should probably include handling hermeticity and files
  • building a PEX
  • finding your most used code

Our current docs do have elements of how-tos, but they should be more dedicated and tutorial style, e.g. that you can follow along with.

A major part of this ticket is deciding how to organize the sidebar of our docs.

Eric-Arellano avatar Jun 22 '21 20:06 Eric-Arellano

A major part of this ticket is deciding how to organize the sidebar of our docs.

Another portion would be expanding and prioritizing a list of the potential howtos.

stuhood avatar Jun 22 '21 21:06 stuhood

Blocked: We need 3 levels of nesting in the docs.

cczona avatar Sep 07 '22 17:09 cczona

Was this completed?

Eric-Arellano avatar May 23 '23 18:05 Eric-Arellano

I closed a toolchain issue and somehow it closed an upstream issue. That was not my intention.

cczona avatar May 23 '23 18:05 cczona