Thank you for your interest in improving the Java Operator SDK documentation! We welcome contributions from the community and appreciate your help in making our documentation better.
- Fork the repository and clone your fork locally
- Create a new branch for your changes
- Make your improvements to the documentation
- Test your changes locally using
hugo server - Submit a pull request with a clear description of your changes
We welcome various types of contributions:
- Content improvements: Fix typos, clarify explanations, add examples
- New documentation: Add missing sections or entirely new guides
- Structural improvements: Better organization, navigation, or formatting
- Translation: Help translate documentation to other languages
- Use clear, concise language
- Write in active voice when possible
- Define technical terms when first used
- Include practical examples where helpful
- Keep sentences and paragraphs reasonably short
- Test all code examples to ensure they work
- Use proper markdown formatting
- Follow existing documentation structure and conventions
- Ensure links work and point to current resources
All contributions must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; the CLA simply gives us permission to use and redistribute your contributions as part of the project.
Visit https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one (even for a different project), you probably don't need to do it again.
All submissions, including those by project members, require review. We use GitHub pull requests for this purpose. Please consult GitHub Help for more information on using pull requests.
This project follows Google's Open Source Community Guidelines.