Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 2.25 KB
Raw

Contributing Guidelines

Thank you for helping make Qumulo documentation better! Your feedback means a lot to us. ❤️

Important: Currently, we don't publish Qumulo documentation directly to the public GitHub repo. After we complete the automated build process, we mirror the mainline branch of the repository from the internal repo to the public repo and then publish the content to GitHub Pages. For this reason, the changes that you submit don't appear immediately.

What Contributions We Look For

We always appreciate it when users submit issues for:

  • Inaccurate or incomplete information
  • Ideas for improving the usability (UX) of the Documentation Portal
  • Broken links
  • Typos, spelling, or grammar errors
  • Requests for translation
  • Compliments 😊

Note: Qumulo's technical writers use an in-house style guide designed to maximize the UX of technical documentation. We appreciate every comment, but if your issue is primarily about writing style, we might not accept it.

How to Contribute

To contribute, open an issue.

Tip: Before contributing an issue, check whether the issue already exists.

  1. Navigate to the Issues tab and then click New issue.

  2. In the New issue form, give your issue a meaningful title (for example, "IPMI authentication is unclear") and then enter a detailed description. Include the following information:

    • The URL of the affected page
    • What you would like us to correct, clarify, or revise
    • Any information about what you were trying to do with the help of our documentation

  3. Click Submit new issue.

Contributing Security Issues

Important: Do not create public security issues on GitHub.

If you discover a potential security issue, contact the Qumulo Care team.

Code of Conduct

This project has adopted the Contributor Covenant Code of Conduct. If you have any questions, email [email protected] with questions or comments.

Licenses

This project has adopted the Creative Commons Attribution 4.0 International license.

The Navgoco jQuery component uses the BSD License 2.0 license.