Versions Compared

Version Old Version 7 New Version 8
Changes made by

Andrea Anderson

Matthew Harffy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

<<Matthew Harffy - 18/08/2017: I think this draft can now be deleted as I have copied the content in an edited form into the formal documentation. I have also updated the old Style Guide on the wiki.>>


This style guide is for ONAP documentation contributors and reviewers.There is another style guide on the wiki already. This page will replace the old Style Guide.

Table of Contents
Getting started

...

  • AA&I vs. AAI: Both are allowed in Release 1, but use AAI from now on.
  • APP-C vs APPC: Both are allowed in Release 1, but use APPC from now on. 
  • SDN-C vs SDNC: Both are allowed in Release 1, but use SDNC from now on.
  • Heat vs HEAT: Both are in use. The official website uses "Heat", but HEAT prevails in reference documents.
  • life cycle vs lifecycle or life-cycle: prefer two words "life cycle", as recommended here, and because OpenECOMP contains a Life Cycle Management (LCM) functionality. Note that Reference documents, such as <<DocRef: "Common Requirements for Virtual Network Functions">> show both forms. 
  • onboarding:
    • taking a Virtual Network Function (VNF) from a source or supplier and integrating it into the OpenECOMP platform
    • (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".
  • open source (adjective): capitalize only in titles; avoid "open-source". (Based on prevalence on the web.)
  • orchestration: The coordination of facilities and lower-level services in a software-defined networking context to define and provide higher-level services
  • recipe: use alternatives like "workflow and configuration information", when related to a Resource, Service, Product, or Offer. However, within the context of the server configuration system Chef, a recipe is the most fundamental configuration element.
  • 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.

...