2025-05-07 Meeting Notes for Documentation Working Group
Date
May 7, 2025, next meeting May 21, 2025
Recording (33 minutes)
Participants
@Joe Pearson
@Nathan Phelps
@EUGENE O'CONNOR
Previous Items
In progress: Adding instructions for local v remote registries in cluster install
In progress: Review AIO installation instructions
In progress: Review Agent installation instructions
In progress: remove duplicate hw reqs
In review: Document secrets usage.
Example: nothing exists showing how to use more than one secret in a service/deployment
Show how to populate an environment variable from a secret
See
service-postgresql
for a new example service doing thisDraft PR created, needs a lot of review
Dave Booz made a first pass at checking technical accuracy of instructions - complete
10 minutes to plan, generate, and commit updated docs, 1 hour to review, saved days of work
Complete: Updating copyright statement on page, and in front matter
PR for docs - complete
kubearmor-integration - complete
FDO-support - complete
devops - complete
exchange-api - complete
anax - complete
2 hours to plan, generate, debug, and commit changes.
15 minutes, mostly
over 1.5 hours debugging a silly issue
saved at least 5 hours
Discussion topics
Using code assistants to complete documentation PRs
To gather facts
To open issues, commit code, create PRs
To make wholesale changes to multiple repo contents
To synthesize information and re-organize it for a specific audience
Proper way to give attribution
LF, LF Edge have no guidance (yet)
Brought it up at the most recent TAC meeting
What downstream consumers have guidance that impacts us?
@EUGENE O'CONNOR provided guidance