manuals/user-guide/src/main/asciidoc/yangide/yangide-user.adoc

   1 == YangIDE User Guide
   2 Refer to this template to identify the required sections and information
   3 that you should  provide for a User Guide. The user guide should contain
   4 configuration, administration, management, using, and troubleshooting
   5 sections for the feature.
   6
   7 === Overview
   8 Provide an overview of the feature and the use case. Also include the
   9 audience who will use the feature. For example,  audience can be the
  10 network administrator, cloud administrator, network engineer, system
  11 administrators, and so on.
  12
  13 === YangIDE Architecture
  14 Provide information about feature components and how they work together.
  15 Also include information about how the feature integrates with
  16 OpenDaylight. An architecture diagram could help.
  17
  18 === Configuring YangIDE
  19
  20 Describe how to configure the feature or the project after installation.
  21 Configuration information could include day-one activities for a project
  22 such as configuring users, configuring clients/servers and so on.
  23
  24 === Administering or Managing YangIDE
  25 Include related command reference or  operations that you could perform
  26 using the feature. For example viewing network statistics, monitoring
  27 the network,  generating reports, and so on.
  28
  29 NOTE:  Ensure that you create a step procedure whenever required and
  30 avoid concepts.
  31
  32 For example:
  33
  34 .To configure L2switch components perform the following steps.
  35 . Step 1:
  36 . Step 2:
  37 . Step 3:
  38
  39 === Tutorials
  40 <optional>
  41 If there is only one tutorial, you skip the "Tutorials" section and
  42 instead just lead with the single tutorial's name.
  43
  44 ==== <Tutorial Name>
  45 Ensure that the title starts with a gerund. For example using,
  46 monitoring, creating, and so on.
  47
  48 ===== Overview
  49 An overview of the use case.
  50
  51 ===== Prerequisites
  52 Provide any prerequisite information, assumed knowledge, or environment
  53 required to execute the use case.
  54
  55 ===== Target Environment
  56 Include any topology requirement for the use case. Ideally, provide
  57 visual (abstract) layout of network diagrams and any other useful visual
  58 aides.
  59
  60 ===== Instructions
  61 Use case could be a set of configuration procedures. Including
  62 screenshots to help demonstrate what is happening is especially useful.
  63 Ensure that you specify them separately. For example:
  64
  65 . *Setting up the VM*
  66 To set up a VM perform the following steps.
  67 .. Step 1
  68 .. Step 2
  69 .. Step 3
  70
  71 . *Installing the feature*
  72 To install the feature perform the following steps.
  73 .. Step 1
  74 .. Step 2
  75 .. Step 3
  76
  77 . *Configuring the environment*
  78 To configure the system perform the following steps.
  79 .. Step 1
  80 .. Step 2
  81 .. Step 3