X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-documentation%2Fstyle-guide-content.rst;fp=docs%2Fguides%2Fonap-developer%2Fhow-to-use-docs%2Fstyle-guide.rst;h=f8e9d2363753bb38fdbe821f70cb1a08cb2f91bb;hb=21d59414fca273aade30aa4209aca9bb35a5f78f;hp=17dee9fdaad7fa1cab8e78a367b4008ed7e7accf;hpb=830bc298c26764f3d98f3ca98adf7b3c1b3d0a3a;p=doc.git diff --git a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst b/docs/guides/onap-documentation/style-guide-content.rst similarity index 96% rename from docs/guides/onap-developer/how-to-use-docs/style-guide.rst rename to docs/guides/onap-documentation/style-guide-content.rst index 17dee9fda..f8e9d2363 100644 --- a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst +++ b/docs/guides/onap-documentation/style-guide-content.rst @@ -1,12 +1,13 @@ .. This work is licensed under a Creative Commons Attribution 4.0 .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. Copyright 2022 ONAP -Style guide -=========== +Style Guide (Content) +===================== This style guide is for ONAP documentation contributors, reviewers and -committers. +committers and covers content related topics. Writing guidelines ------------------ @@ -42,7 +43,6 @@ Abbreviations and acronyms + Examples: an MSO component, a LAN, an L3-VPN - ONAP terminology ^^^^^^^^^^^^^^^^ - AA&I vs AAI: AAI should be used. @@ -63,7 +63,7 @@ ONAP terminology - run time (noun). Example: "logging of events at run time". -GUI elements +GUI Elements ^^^^^^^^^^^^ - In general, write menu names as they appear in the UI. For example, if a menu or item name is all caps, then write