Contributing Guidelines

General

  1. Child pages of a section and their summary are automatically listed at the bottom of each section page.
  2. Pages can only be authored as .html or .md and you should use only one file extension or the other. Instead of creating my-team/about/index.html.md simply use my-team/about.md.

Section Pages

Section pages (_index.md) are a bit special. If you are creating a new section (a directory that will have child pages), you should always include a _index.md in the same directory. By default, the bottom of your “section” age will include a list of child pages within the section. See as an example.

Content Structure

Below is an example of the content structure used for this site:

content
├── docs
│   └── _index.md
├── handbook
│   ├── alliances
│   │   ├── _index.md
│   │   ├── aws.md
│   │   ├── ecosystempartners.md
│   │   ├── gcp.md
│   │   ├── ibm.md
│   │   └── redhat.md
│   ├── company
│   │   ├── _index.md
│   │   ├── communication
│   │   │   ├── _index.md
│   │   │   └── project-code-names.md
│   │   ├── crisis-process.md
│   │   └── performance-indicators
│   │       ├── _index.md
│   │       ├── product
│   │       │   ├── _index.md
│   │       │   ├── dev-section.md
│   │       │   ├── enablement-section.md
│   │       │   ├── modelops-section.md
│   │       │   ├── ops-section.md
│   │       │   ├── sec-section.md
│   │       │   └── stages-and-groups.md
│   │       └── sales.md
│   └── ...

Development

Continue reading in the development section


Handbook Development
Development environment and processes for maintaining the handbook
Handbook frontmatter
Information on what frontmatter entries are available and how to use them.
Handbook Markdown Guide
Read through our Markdown Style Guide!
Handbook Search
Information on how search works on the different handbook sites.
Partials
Hugo partials are bits of reusable content. They’re primarily used for parts of theme files, …
Shortcodes
Shortcodes are pre-defined ways to display content in Markdown files. If something looks somewhat …