Handbook Development
Development environment and processes for maintaining the handbook
.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 (_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.
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
│ └── ...
Contributing guidelines are WIP. If you are feeling ambitious here are some useful links:
Continue reading in the development section