Here are some basics for contributing on the ONAP Wiki.
Don't worry too much over style. It is better to have good information than none at all! It can always be fixed later if you make a mistake.
The highest level is Heading 1
It is OK to have a singleton Heading at any level
Do not use a Heading (n+1) unless it is under a Heading n
Write out in first instance on a page, immediately followed by the acronym in parenthesis. Then use the acronym on the rest of the page. In diagrams, if space allows, use full name. Example: Operational Support System (OSS). For plurals, add an "s" but do not use "es", such as OSSs.
Use of "&" in acronyms: In general, avoid. Exceptions: "AT&T" and for Release 1, "A&AI". Going forward, "AAI" is preferred.
Denote text that requires additional work using "<<TODO:" (easily searchable) and preferably italics:
<<TODO: explain what needs to be done>>
Use the word "DocRef:", followed by the document title, within << >>:
<<DocRef: OpenECOMP User Guide>>
Where linking to formal ONAP documentation, link to the specific document or section on the ONAP readthedocs.io site.
Object | Formatting | Example |
---|---|---|
source code, user input, program output | Confluence "preformatted" font, or Confluence "Code Block" macro (permits indentation) | contact": { “contactType”: “USER”, “source”: “app1”, } |
Start with Figure 1 on each page. In the Figure caption itself, use bold for the entire caption; only capitalize the first word:
Figure 1. OpenECOMP architecture
Don't use bold in the text's references to Figure n.
Avoid non-English phrases, abbreviations and symbols and substitute as follows:
If you DO use "e.g." and "i.e.", use commas after these.
Try to keep sentences 25* words or less. If very lengthy, consider rephrasing and breaking into a bulleted list.
* Sometimes impossible but worth shooting for.