Guidelines for Documentation Owners

As Documentation Owners, one of our key responsibilities is maintaining the quality and currency of our documentation. A crucial aspect of this is being vigilant about Open Pull Requests (PRs). These PRs represent ongoing efforts to improve, update, or correct the information that our users rely on.

We must prioritize the timely review and integration of these contributions. This not only keeps our documentation accurate and up-to-date but also fosters a collaborative and responsive community environment. Each PR is an opportunity to enhance the quality of our resources and to engage with contributors who are offering their insights and efforts.

To achieve this, we encourage all Documentation Owners to:

1. Regularly Check for Open PRs: Make it a part of your routine to check for new PRs. Prompt acknowledgement of a PR is the first step in a constructive review process.

2. Follow and help to enforce the Standards: This helps to ensure the our documentation is consistent throughout all contributions. Standards can be found here

3. Ensure quality checks are respected: Ensuring that the quality checks are passing and not being overridden without a good reason helps to encourage consistency and avoids introduction of problems that have to be fixed down the road.

4. Engage Actively and Constructively: Provide constructive, clear, and supportive feedback. This encourages not only the improvement of the current PR but also future contributions.

5. Streamline the Review Process: Continuously work towards streamlining the review process. This could involve automating certain checks, setting up templates for feedback, or regularly training reviewers.

6. Recognize Contributions: Acknowledge and appreciate the effort contributors make. Recognition fosters a positive community and encourages ongoing participation.

By effectively managing Open PRs, we not only improve our documentation but also uphold the collaborative spirit that is essential to the Cloud Platform's success.