Doc review request for this new section: <https://...
# developmentc
curved-television-6568
02/10/2022, 4:14 PMDoc review request for this new section: https://www.pantsbuild.org/v2.10/docs/tagging-docker-images#string-interpolation-using-placeholder-values
š 1
h
hundreds-father-404
02/10/2022, 5:00 PMLooks good! i think we should probably consolidate other sections into this tho, wdyt? Like the second half of https://www.pantsbuild.org/v2.10/docs/tagging-docker-images#tagging-images
ā 1
c
curved-television-6568
02/10/2022, 5:48 PMAh, there it was.. I knew there was more places that talked about interpolation, but I searched for placeholder .. š
š 1
curved-television-6568
02/10/2022, 5:49 PMYeah, Iām not even sure if the āTagging docker imagesā page is a good fit
curved-television-6568
02/10/2022, 5:49 PMThereās all kinds of stuff in there soon..:P
curved-television-6568
02/10/2022, 5:50 PMFeel free to move stuff around on those pages, if you have an idea you like
curved-television-6568
02/10/2022, 5:50 PMI can write, but Iām not very structured when it comes to docs.
h
hundreds-father-404
02/10/2022, 5:53 PMI can spend some time next week thinking about it š will add it to the docs audit https://docs.google.com/spreadsheets/d/1wcddB4wjmtR1yhQ0UI46O_HMDOhQdYpmdjhk7myJxw0/edit#gid=1972664370
trying to knock out some stuff for 2.10.0rc1 today and tomorrow
šÆ 1
h
happy-kitchen-89482
02/10/2022, 8:28 PMI'll take a stab at it , since I'm banging on docs today anyway
ā¤ļø 2
happy-kitchen-89482
02/14/2022, 6:20 AMRe this - it should probably list exactly which fields support interpolation and which values are available in each, in a table?
c
curved-television-6568
02/14/2022, 7:10 AMYeah, that makes sense.
curved-television-6568
02/14/2022, 7:12 AMI've setup the help for the fields such that all that support interpolation has a common wording for easy identification.
h
happy-kitchen-89482
02/14/2022, 3:56 PMGreat
happy-kitchen-89482
02/14/2022, 3:57 PMBut am I wrong that we already show examples of this interpolation before we get to that section of the docs?
c
curved-television-6568
02/14/2022, 4:36 PMIn the reference section, fields that support interpolation uses a wording such as āEach tag may use placeholders in curly braces to be interpolated. The placeholders are derived from various sources, such as the Dockerfile FROM instructions tags and build args.ā
Then in the docs thereās just the https://www.pantsbuild.org/docs/tagging-docker-images#setting-a-repository-name currently that refers to interpolation, I think (besides the new section in the 2.10 docs)
h
happy-kitchen-89482
02/14/2022, 4:51 PMDoesn't "Using env vars to include dynamic data in tags" in that same page give interpolation examples?
happy-kitchen-89482
02/14/2022, 4:52 PM"Setting a repository name" refers to interpolation in pants.toml, which is different
c
curved-television-6568
02/14/2022, 4:58 PMDoesnāt āUsing env vars to include dynamic data in tagsā in that same page give interpolation examples?Indeed it does. Bad search by me (was in a rush..)
h
happy-kitchen-89482
02/14/2022, 5:30 PMOK, so I might tweak this to add something like "see more below" or whatever
happy-kitchen-89482
02/14/2022, 6:15 PMI see that "Setting a repository name" links to the new section, but that refers to interpolation in pants.toml. Is that quite the same?
c
curved-television-6568
02/14/2022, 7:14 PMWhat part refers to interpolation in pants.toml?
The opening sentence in the new section āString interpolation using placeholder valuesā is
Some fields of theĀĀ supports replacing placeholder values [ā¦]docker_image
curved-television-6568
02/14/2022, 7:14 PMAh, gosh, my docs reading today is awfulā¦
curved-television-6568
02/14/2022, 7:15 PMAnd yes, itās the same. Thereās even a hint at that in thereā¦
In fact, you can use these placeholders in theĀĀ field as well, if you find that helpful.repository
h
happy-kitchen-89482
02/16/2022, 1:06 AMI think the new section looks good, I tweaked it only very slightly.
ā¤ļø 1