How to Contribute

Thanks for your interest in improving GrokDevOps Wiki! Here are ways you can help.

Report Issues

Found a broken link, outdated info, or typo? Open an issue with:

• The page URL or title
• What's wrong (broken link, incorrect command, etc.)
• What you expected instead

Suggest Corrections

For small fixes (typos, broken commands, outdated versions):

1. Click the pencil icon ("Edit this page") at the top of any page
2. GitHub will fork the repo and open an editor
3. Make your change and submit a pull request

Submit a Pull Request

For larger contributions (new topics, runbooks, case studies):

1. Fork grokdatum/grokdevops
2. Clone your fork and create a branch
3. Add or edit content under training/
4. Follow existing naming conventions (dot-separated filenames, frontmatter tags)
5. Run make deploy-wiki-dry to verify the build (or: python3 tools/gen_mkdocs_nav.py && mkdocs build)
6. Open a PR against main with a description of your changes

Content Guidelines

• Be practical — focus on commands, configs, and real-world scenarios
• Include context — explain why, not just how
• Use admonitions — !!! tip, !!! warning, !!! note for callouts
• Add tags — include relevant tags in frontmatter for discoverability

Questions?

Open a discussion or reach out via an issue.