93acffc3b8
The previous 'Help Most Needed' list was presenting information in a way that focused on the desires of the community rather than the value that sponsoring organisations can generate - for both themselves and the commons. Replace the list with a new list of 'Upstream Investment Opportunities', and a process to keep them current by removing them after they have been on the list for between 6 months and a year, so that the submitter is forced to reaffirm their interest and the TC is forced to re-evaluate the relevancy. Since the current 'Help Most Needed' entries are generally not written in a style emphasising the value to a business of investing, the initial list is empty and will be filled as the TC evaluates business cases according to its new criteria and understanding of the needs of potential contributing organisations. To preserve the existing information, the contents of the current 'Help Most Needed' list appear as the 2018 upstream investment opportunites. Links to the old list will temporarily redirect here until such time as the new entries are in place, at which point we can redirect to the main page with the latest index. Change-Id: I65fef701dc2e3d50aa84e7ee79b068c78346c846
2.8 KiB
Documentation owners
Description
The #1 pain point in OpenStack, for contributors and users alike, is complexity. While cutting down complexity everywhere we can is critical; proper documentation is essential in addressing that complexity. It directly benefits operators and users of OpenStack, but also facilitates ramping up new direct contributors to the project itself.
The documentation team has been struggling with limited resources since the dawn of OpenStack, despite the heroic efforts of previous team members. The community outlined an ambitious plan to decentralize the Documentation team, turning it into a guidance and mentoring support team. To be successful, project teams need to own their documentation, which means that the role of documentation owners will be critical.
Volunteers for this role will drive this ambitious transition, by being members of their project team and members of the new decentralized documentation team. On the long-term, they will become a reference go-to person in their project, and respected mentors in the OpenStack community.
Value
Increased Operational Efficiency
Documentation naturally disseminates knowledge, but it should also be easy for readers to find what they are looking for. This process reduces bottlenecks on human resources and support by allowing users, operators, and contributors to find answers to questions themselves. Less time spent answering common questions means more time focusing on more complicated requests, maintenance, and code.
Faster Onboarding
Contributors come from all different backgrounds and experiences. As a result, they often share similar questions about high-level concepts or processes used within the OpenStack community or components. Consistently documenting processes enables contributors without requiring them to pull tribal knowledge from an existing developer. This documentation fast-tracks contributors to making productive contributions.
Consistency
Users, customers, and operators are required to reference a vast pool of documentation spread across multiple repositories and sites. Implementing consistency in wording, format, content, and location provides readers with a first-class experience. Additionally, users build confidence and trust in software when it is well documented.
Contact
For questions about getting involved with this initiative, reach out to the OpenStack Discuss mailing list. You may also contact the Documentation PTL or the Technical Committee sponsor for this item (dhellmann).