Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions content/en/docs/guides/contributor-guides/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,22 @@ Add the *area/docs* and the *documentation* labels to the issues created for the
* Do not add manually a table of contents to the documents. Hugo and Docsy takes care of this.
* Do not use H1 (#) headers in the documents. Docsy generates a H1 header to every document consistent with the title
of the document. Start the headings with H2 (##)
* Use the built in alerts for notes and alerts
* Alerts (note/warning/critical boxes)**: There are three alert types available based on the importance of the information:

```go-html-template
{{%/* alert title="Warning" color="primary" */%}}
This is a note.
{{%/* /alert */%}}
```
| Alert type | Code | Alert color |
|------------|-------------------|-------------|
| Note | `color="primary"` | Blue |
| Warning | `color="warning"` | Yellow |
| Critical | `color="danger"` | Red |

```go-html-template
{{%/* alert title="Warning" color="warning" */%}}
This is a warning.
Make sure not to change the title of the alert type. It should always be either Note, Warning or Critical.

```markdown
{{%/* alert title="Note" color="primary" */%}}
Important information here.
{{%/* /alert */%}}
```

* Colors to be used when creating figures are [here](https://color.adobe.com/Nephio-secondary-colors-color-theme-0bbcdea2-0533-4ab3-812f-f752f30b5b40/)
* If you add any commands to the content inline surround the comand with backticks (\` \`), like \`ls -la\`
* Do not surround IP addresses, domain names or any other identifyers with backticks. Use italics (\* \*) to mark any
Expand Down
Loading