https://pantsbuild.org/ logo
#development
Title
# development
w

witty-family-13337

05/13/2022, 9:01 AM
hi, thinking on adding some initial documentation for the Helm backend, could someone give me some pointers to where the MD files should be placed so they can be picked up when generating the documentation?
c

curved-television-6568

05/13/2022, 10:47 AM
Only the online help (i.e. the help text from subsystems, targets and field types) for the reference section are generated from sources. All other chapters are managed via a web ui.
There’s been a discussion to move also those other parts to be generated from the source repo, but there’s not yet been any consensus that I’m aware of. https://pantsbuild.slack.com/archives/C0D7TNJHL/p1650468268297109
w

witty-family-13337

05/13/2022, 11:32 AM
ah ok, got it, that’s why I couldn’t find any
.md
files regarding current docs in pants’ main repo or any other in the same org
h

hundreds-father-404

05/13/2022, 1:07 PM
Yeah I continue to be more and more +1 for in-repo docs
👍 1
w

witty-crayon-22786

05/13/2022, 3:52 PM
in the meantime, we would need to create a skeleton, and then give Alonso a link to the unpublished page…?
👍 1
@witty-family-13337: are you thinking of a one page overview to start?
w

witty-family-13337

05/13/2022, 4:02 PM
yeah, something simple as a starting point, highlighting it's still experimental but introducing the different targets and running tests, packaging, etc
the reference docs are already being generated
w

witty-crayon-22786

05/13/2022, 4:07 PM
@witty-family-13337: are you able to Suggest Edits here? https://www.pantsbuild.org/v2.12/docs/helm-overview
if so, would recommend continuing to save your edits in markdown, and just pasting them wholesale… when someone accepts the edits they’ll become visible, but the page will still be hidden until you let us know
w

witty-family-13337

05/13/2022, 4:09 PM
sounds good
w

witty-crayon-22786

05/13/2022, 4:09 PM
thanks a lot!
w

witty-family-13337

05/13/2022, 4:09 PM
just tested it and yes, can get a login link
I’ll get something in there in the next days
b

busy-vase-39202

05/13/2022, 6:11 PM
Relatedly, Stripe just open sourced their Markdown-based CMS developed for authoring their own documentation website. Thoughts on suitability for Pants? https://twitter.com/StripeDev/status/1524407490519220230?s=20&t=wDD-kKzqsbqObQNefOpWYg https://pantsbuild.slack.com/archives/C0D7TNJHL/p1652447277520189?thread_ts=1652432488.642399&cid=C0D7TNJHL