...
- 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
...
| title | YouTube |
|---|
Please indicate your session type in the blank space below and then remove this Info field.
...
- You may be asked to pre-record this session which will be made available on-demand.
...
Interactive
...
session
...
Interactive session
LFN DTF 2022.06 - Plenary - Challenges of LFN projects.pptx
| View file | ||||
|---|---|---|---|---|
|
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://wiki.lfnetworking.org/x/BKwZB)
- 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
...