Documentation

This section provides guidance on the structure of Cilium documentation, describes its style, and explains how to test it. Before contributing, please review the structure recommendations and style guide.

See the clone and provision environment section to learn how to fork and clone the repository.

• Recommendations on documentation structure
  • Maintaining good information architecture
  • Adding a new page
  • Updating an existing page
  • Removing content and entire pages
• Documentation style
  • General considerations
  • Header
  • Headings
  • Body
  • Capitalization
  • Code blocks
  • Links
  • Lists
  • Callouts
  • Roles
  • Common pitfalls
  • Specific language
• Documentation testing
  • Set up your development environment
  • For Windows
  • Preview documentation locally
  • Submit local changes on GitHub (Pull Request)

The best way to get help if you get stuck is to ask a question on Cilium Slack. With Cilium contributors across the globe, there is almost always someone available to help.