X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=manuals%2Fuser-guide%2Fsrc%2Fmain%2Fasciidoc%2Fyangide%2Fyangide-user.adoc;h=f1fd469179a8fafe7d3ef273da4f0dd4710ab431;hb=7990e9676c194d153cc68824724b268fabd74333;hp=05a58537ad6611320597f4243abd746131b7731d;hpb=252404d6b44b14021234e1b1dfbf55952e0bb6b1;p=docs.git diff --git a/manuals/user-guide/src/main/asciidoc/yangide/yangide-user.adoc b/manuals/user-guide/src/main/asciidoc/yangide/yangide-user.adoc index 05a58537a..f1fd46917 100644 --- a/manuals/user-guide/src/main/asciidoc/yangide/yangide-user.adoc +++ b/manuals/user-guide/src/main/asciidoc/yangide/yangide-user.adoc @@ -1,81 +1,3 @@ -== YangIDE User Guide -Refer to this template to identify the required sections and information -that you should provide for a User Guide. The user guide should contain -configuration, administration, management, using, and troubleshooting -sections for the feature. +== YANG IDE User Guide -=== Overview -Provide an overview of the feature and the use case. Also include the -audience who will use the feature. For example, audience can be the -network administrator, cloud administrator, network engineer, system -administrators, and so on. - -=== YangIDE Architecture -Provide information about feature components and how they work together. -Also include information about how the feature integrates with -OpenDaylight. An architecture diagram could help. - -=== Configuring YangIDE - -Describe how to configure the feature or the project after installation. -Configuration information could include day-one activities for a project -such as configuring users, configuring clients/servers and so on. - -=== Administering or Managing YangIDE -Include related command reference or operations that you could perform -using the feature. For example viewing network statistics, monitoring -the network, generating reports, and so on. - -NOTE: Ensure that you create a step procedure whenever required and -avoid concepts. - -For example: - -.To configure L2switch components perform the following steps. -. Step 1: -. Step 2: -. Step 3: - -=== Tutorials - -If there is only one tutorial, you skip the "Tutorials" section and -instead just lead with the single tutorial's name. - -==== -Ensure that the title starts with a gerund. For example using, -monitoring, creating, and so on. - -===== Overview -An overview of the use case. - -===== Prerequisites -Provide any prerequisite information, assumed knowledge, or environment -required to execute the use case. - -===== Target Environment -Include any topology requirement for the use case. Ideally, provide -visual (abstract) layout of network diagrams and any other useful visual -aides. - -===== Instructions -Use case could be a set of configuration procedures. Including -screenshots to help demonstrate what is happening is especially useful. -Ensure that you specify them separately. For example: - -. *Setting up the VM* -To set up a VM perform the following steps. -.. Step 1 -.. Step 2 -.. Step 3 - -. *Installing the feature* -To install the feature perform the following steps. -.. Step 1 -.. Step 2 -.. Step 3 - -. *Configuring the environment* -To configure the system perform the following steps. -.. Step 1 -.. Step 2 -.. Step 3 +This content has been migrated to: http://docs.opendaylight.org/en/stable-boron/user-guide/yang-ide-user-guide.html