Contributing Guidelines

In general, content management on the internal handbook is very similar to the public handbook. The key differences are described on this page.

Differences from Public handbook

  1. Content is maintained in the /content directory, not /source. See the directory structure below.
  2. Child pages of a section and their summary are automatically listed at the bottom of each section page.
  3. 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 (i.e. _index.md) are a bit special. If you are creating a new section (i.e. 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
│   └── ...

Handbook Markdown Guide
Read through our Markdown Style Guide!