--- /dev/null
+== BGP Developer Guide
+
+=== Overview
+Provide an overview of the feature, what it logical functionality it
+provides and why you might use it as a developer. To be clear the target
+audience for this guide is a developer who will be _using_ the feature
+to build something separate, but _not_ somebody who will be developing
+code for this feature itself.
+
+NOTE: More so than with user guides, the guide may cover more than one
+feature. If that is the case, be sure to list all of the features this
+covers.
+
+=== BGP 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. This may be the same
+as the diagram used in the user guide, but it should likely be less
+abstract and provide more information that would be applicable to a
+developer.
+
+=== Key APIs and Interfaces
+Document the key things a user would want to use. For some features,
+there will only be one logical grouping of APIs. For others there may be
+more than one grouping.
+
+Assuming the API is MD-SAL- and YANG-based, the APIs will be available
+both via RESTCONF and via Java APIs. Giving a few examples using each is
+likely a good idea.
+
+==== API Group 1
+Provide a description of what the API does and some examples of how to
+use it.
+
+==== API Group 2
+Provide a description of what the API does and some examples of how to
+use it.
+
+=== API Reference Documentation
+Provide links to JavaDoc, REST API documentation, etc.
--- /dev/null
+== PCEP Developer Guide
+
+=== Overview
+Provide an overview of the feature, what it logical functionality it
+provides and why you might use it as a developer. To be clear the target
+audience for this guide is a developer who will be _using_ the feature
+to build something separate, but _not_ somebody who will be developing
+code for this feature itself.
+
+NOTE: More so than with user guides, the guide may cover more than one
+feature. If that is the case, be sure to list all of the features this
+covers.
+
+=== PCEP 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. This may be the same
+as the diagram used in the user guide, but it should likely be less
+abstract and provide more information that would be applicable to a
+developer.
+
+=== Key APIs and Interfaces
+Document the key things a user would want to use. For some features,
+there will only be one logical grouping of APIs. For others there may be
+more than one grouping.
+
+Assuming the API is MD-SAL- and YANG-based, the APIs will be available
+both via RESTCONF and via Java APIs. Giving a few examples using each is
+likely a good idea.
+
+==== API Group 1
+Provide a description of what the API does and some examples of how to
+use it.
+
+==== API Group 2
+Provide a description of what the API does and some examples of how to
+use it.
+
+=== API Reference Documentation
+Provide links to JavaDoc, REST API documentation, etc.
include::aaa.adoc[]
-include::bgpcep.adoc[]
+include::bgpcep/odl-bgpcep-bgp-all-dev.adoc[BGP]
+
+include::bgpcep/odl-bgpcep-pcep-all-dev.adoc[PCEP]
include::controller.adoc[]
--- /dev/null
+== BGP 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.
+
+=== 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.
+
+=== BGP 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 BGP
+
+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 BGP
+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
+<optional>
+If there is only one tutorial, you skip the "Tutorials" section and
+instead just lead with the single tutorial's name.
+
+==== Creating and using BGP speaker
+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
--- /dev/null
+== PCEP 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.
+
+=== 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.
+
+=== PCEP 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 PCEP
+
+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 PCEP
+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
+<optional>
+If there is only one tutorial, you skip the "Tutorials" section and
+instead just lead with the single tutorial's name.
+
+==== Managing PCEP tunnels
+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 second part of the user guide covers project specific usage instructions.
-include::addons/bgpcep.adoc[BGP LS PCEP]
+include::bgpcep/odl-bgpcep-bgp-all-user.adoc[BGP]
+
+include::bgpcep/odl-bgpcep-pcep-all-user.adoc[PCEP]
include::addons/defense4all.adoc[Defense4All]
Code Review / docs.git / commitdiff