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.

Headings

The highest level is Heading 1

...

• First word on each line of a bulleted list (except for definitions in the Glossary)
• The following are proper nouns that in many cases have a specific meaning in OpenECOMP ONAP and should be capitalized:
  • Application Controller
  • Infrastructure Controller
  • Network Controller
  • Offer
  • Product50201559
  • Resource50201559
  • Service 50201559 (note: use "service" in generic contexts; use "Service" for a Service Design & Creation tool object)
• Letters in words that are part of acronyms. See Acronyms treatment, below. Examples:
  • Business Support System (BSS)
  • REpresentational State Transfer (REST)
  • Open Platform for NFV (OPNFV)

Usage

ingredients: avoid

onboarding:

1. taking a Virtual Network Function (VNF) from a source or supplier and integrating it into the OpenECOMP platform
2. (avoid this usage) telling a potential developer/contributor what they need to know about tools, policies, processes, etc. to start using or contributing to Open ECOMP. Instead, use a title such as "Developer Starting Guide" rather than "Developer Onboarding Guide".

orchestration: The coordination of facilities and lower-level services in a software-defined networking context to define and provide higher-level services

recipe: try to avoid - use alternatives like "workflow and configuration information", when related to a Resource, Service, Product, or Offer

run-time vs. execution-time (adjective): prefer run-time. Example: "run-time logging of events"

run time:(noun) Example: "logging of events at run time"

"secret sauce": replace with a phrase like "value-added functionality" or "proprietary algorithms".

subsystem: a large component; avoid "module" when referring to OpenECOMP subsystems such as MSO

...

The following usages apply to specifications for third party software (such as Virtual Network Functions) designed to operate with OpenECOMP. (These definitions are taken from the "Common Requirements for Virtual Network Functions" document.)

must: This word, or the terms required or shall, mean that the definition is an absolute requirement of the specification.

must not: This phrase, or the phrase shall not, means that the definition is an absolute prohibition of the specification.

should: This word, or the adjective recommended, means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.

should not: This phrase, or the phrase not recommended, means that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.

may: This word, or the adjective optional, means that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item. An implementation which does not include a particular option must be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option must be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

Other

...

Acronyms

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.  (This is how it's done in OpenECOMP.pdf.) 

Use of "&" :  Do not use unless in in acronyms:  In general, avoid. Exceptions: "AT&T."  Some components of OpenECOMP have titles that in original source documents use the "&" in their acronymic abbreviation, but most do not.  (Example: " and for Release 1, "A&AI)".  For consistency, exclude from such an acronym, e.g. A&AI becomes AAI << this may be incorrect according to conference call with Greg Glover 1/12/17 >>Incomplete items: Going forward,  "AAI" is preferred. 

Currently unavailable sections and references

Incomplete items

Denote text that requires additional work using "<<<<TODO:" (easily searchable) and preferably italics:

<<Link to security-related APIs here>>

Replace "&" with "and"

<<TBD: fonts/indications of code,  user input, system output>>

Figure numbering and labeling - start with Figure 1 on each page

...

<<TODO: explain what needs to be done>>

References to documents not yet available

Use the word "DocRef:", followed by the document title, within << >>:

<<DocRef: OpenECOMP User Guide>>

Links to documents

Where linking to formal ONAP documentation, link to the specific document or section on the ONAP readthedocs.io site.

Special text formatting

contact": { “contactType”: “USER”,

             “source”: “app1”,

          }

Figure numbering and labeling

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.

Non-English phrases, abbreviations and symbols

Avoid non-English phrases, abbreviations and symbols and substitute as follows:

• e.g. → "for example", "such as"

...

• i.e.

...

• → "that is" (or rephrase)

...

• via

...

• → "through", or sometimes "by"
• & → "and"

if If you DO use "e.g." and "i.e.", use commas after these.

Keep it simple!

Try to keep sentences 25* words or less.  If very lengthy, consider rephrasing and breaking into a bulleted list.

...