2022-06-13 - Plenary: Chalenges of LFN projects
- Gergely Csatari
- Casey Cain
- Scot Steele
About Plenary Sessions
A Plenary session implies that all attendees are expected to attend due to either their relevance or importance to LFN as a whole. This usually means that no other sessions will be running in parallel. Topics may be reclassified as "General Interest" by the Program Committee to run as a parallel session if deemed appropriate.
Topic Leader(s)
Topic Description
In this session we would like to discuss the most pressing challenges of LFN projects. Does your project have issues with documentation, tooling, amount of contributors or something else? Share with us in this session and lets try to figure out together how to address these problems.
Topic Overview
Running an open source project is difficult, every project has different problems and challenges. Good thing is that in LFN we are working in several open source projects and we can learn from each other. In this session we would like to learn what problems the different projects have and we will try to fabricate a plan to address these.
Some problem areas from my experiences from several open source projects:
- Tooling around documentation is difficult to manage
- Maintaining a consistent documentation is difficult
- There are not enough contributors
- Users do not understand the project
Slides & Recording
Interactive session
LFN DTF 2022.06 - Plenary - Challenges of LFN projects.pptx
Agenda
- Documentation
- How to write good documentation?
- it must speak to the users of the documentation
- What kind of documents to we need and with what structure?
- Document artifacts of the projects
- Users guides (installation, operations, admin)
- Contribution guide, contribution guide for the documentation itself
- Documentation of the contribution process
- Coding styleguides
- Branching policies
- Process of contribution including testing
- Make it easy to contribute
- Documentation of the Documentation process
- Guidelines for the types
- Review of the documentation in use cases
- Documentation of the contribution process
- We discussed this already a bit in the Documentation Evangelist Committee meetings
- Documents needed to run the projects
- Wikis. For more see Wiki Guidelines Strawman and discuss in the Doc Evangelists plenary session (https://lf-networking.atlassian.net/wiki/x/SlDv)
- Document artifacts of the projects
- Tooling for documentation
- WYSWG documentation would be nice. Markdown is difficult to learn.
- Maybe we could build an LFN knowledge base
- Should be easy to consume
- How to write good documentation?
- Tooling for CI/CD
- GitHub actions
- GitLab actions
- Jenkins jobs
- How to get more users
- Discuss more during the marketing session
- Answer the questions: "who are the users", "what do the users need?, ...
- What value do the users get from using the Specifications and code?
- How to get more contributors