75m, Beth Cohen Scot Steele
|
No slides
Please select a scribe from the community to take minutes for your topic. Please do not select your community TPM unless they explicitly volunteer.
Documentation is a necessary aspect of the technical project
Required for drive adoptability
No set standards on documentation within the community.
Different types dependent on project type
Doc types:
RST & Sphinx as tools, Some Docs are published by GSMA, Standard Repo OPNFV
What are current communities doing today:
Anuket: Reference materials are documentation, testing tools have some release notes and user stories, docs on how they are used. Minimal contributor guides , No ops or user guides yet.
Release announce
ONAP:
5G Super Blueprint
it's a much a historical doc
WaveLabs supported POC with Developer Interviews
Best Practice: Document as you code - ensures you have fresh info
How do we mimic what was done by previous people?
Suggestion - Templates that provide app
@Andrew Grimberg For those wondering what I mean by Semantic Commit messages from what I can find this seems to be the impetus behind it: https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716 It's been more formalized here: https://www.conventionalcommits.org/en/v1.0.0/ I'll note that per the LF Release Engineering best practices we hold to seven rules of a great git commit message as espoused here: https://cbea.ms/git-commit/ so that means we actually enforce a capitalization of the subject line in our Se mantic commit messages as per rule 3 which differs from the above links. I'll further note that all of this linked from the LFRE's best practices documentation available here: https://docs.releng.linuxfoundation.org/en/latest/best-practices.html
Evangelist Team:
Wiffm / intrinsic values to provide to documenters (fun) and Rewards (impact on career) Scot Steele