First, we would like to encourage you to contribute to an open source Devtron docs repository with meaningful PR.
When you are contributing to the Devtron documentation, please read these contribution guidelines carefully.
- Please keep in mind that you are writing the product documentation.
- When you are working on an issue, please let everyone know by leaving a comment on the Github issue.
- Aim for a voice and tone that's conversational, friendly, and respectful which does not sound so pushy.
- Keep your writing style consistent throughout your documentation.
- Use the active voice more often than the passive voice to keep a sentence shorter and to the point.
- Address the audience of product documentation as “you” (2nd person singular) instead of “user” (3rd person singular).
- Write in the steps (1…2….3…) in imperative sentences if a user has to perform actions/tasks.
- Include the screenshots from the Devtron application.
- Do Not use unnecessary capitalization except titles (all-caps for first initial letters).
If you're interested in writing new content or in thoroughly revising existing content, open an issue describing what you want to do. Feel free to connect with the maintainers at Discord Channel for any queries or suggestions.
Get feedback on your proposal.