doc: cleanup the structure a bit

Signed-off-by: Christian Hopps <chopps@labn.net>
This commit is contained in:
Christian Hopps 2024-01-27 05:03:57 -05:00
parent e2a9eb908f
commit cdfff3e5b5
13 changed files with 63 additions and 56 deletions

View File

@ -1,3 +1,11 @@
Advanced Topics
===============
.. contents:: Table of contents
:local:
:backlinks: entry
:depth: 1
Auto-generated CLI commands Auto-generated CLI commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -1,3 +1,6 @@
Architecture
============
Introduction Introduction
------------ ------------

View File

@ -1,3 +1,6 @@
Demos
=====
Transactional CLI Transactional CLI
----------------- -----------------

View File

@ -1,3 +1,6 @@
Links
=====
RFCs RFCs
~~~~ ~~~~

View File

@ -11,11 +11,11 @@ Northbound API
transactional-cli transactional-cli
retrofitting-configuration-commands retrofitting-configuration-commands
operational-data-rpcs-and-notifications operational-data-rpcs-and-notifications
plugins-sysrepo
advanced-topics advanced-topics
yang-tools yang-tools
yang-module-translator yang-module-translator
demos demos
links links
plugins-sysrepo
ppr-basic-test-topology ppr-basic-test-topology
ppr-mpls-basic-test-topology ppr-mpls-basic-test-topology

View File

@ -1,3 +1,11 @@
Operational Data, RPCs and Notifications
========================================
.. contents:: Table of contents
:local:
:backlinks: entry
:depth: 1
Operational data Operational data
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~

View File

@ -1,3 +1,6 @@
Plugins Sysrepo (old)
=====================
Installation Installation
------------ ------------

View File

@ -1,15 +1,10 @@
Table of Contents IS-IS PPR Basic
~~~~~~~~~~~~~~~~~ ===============
- `Software <#software>`__ .. contents:: Table of contents
- `Topology <#topology>`__ :local:
- `Configuration <#configuration>`__ :backlinks: entry
:depth: 2
- `CLI <#configuration-cli>`__
- `YANG <#configuration-yang>`__
- `Verification - Control Plane <#verification-cplane>`__
- `Verification - Forwarding Plane <#verification-fplane>`__
Software Software
~~~~~~~~ ~~~~~~~~

View File

@ -1,15 +1,10 @@
Table of Contents IS-IS PPR Basic MPLS
~~~~~~~~~~~~~~~~~ ====================
- `Software <#software>`__ .. contents:: Table of contents
- `Topology <#topology>`__ :local:
- `Configuration <#configuration>`__ :backlinks: entry
:depth: 2
- `CLI <#configuration-cli>`__
- `YANG <#configuration-yang>`__
- `Verification - Control Plane <#verification-cplane>`__
- `Verification - Forwarding Plane <#verification-fplane>`__
Software Software
~~~~~~~~ ~~~~~~~~

View File

@ -2,7 +2,15 @@
.. _nb-retrofit: .. _nb-retrofit:
Retrofitting Configuration Commands Retrofitting Configuration Commands
----------------------------------- ===================================
.. contents:: Table of contents
:local:
:backlinks: entry
:depth: 2
Retrofitting process
--------------------
This page explains how to convert existing CLI configuration commands to This page explains how to convert existing CLI configuration commands to
the new northbound model. This documentation is meant to be the primary the new northbound model. This documentation is meant to be the primary
@ -10,9 +18,6 @@ reference for developers working on the northbound retrofitting process.
Well show several examples taken from the ripd northbound conversion to Well show several examples taken from the ripd northbound conversion to
illustrate some concepts described herein. illustrate some concepts described herein.
Retrofitting process
--------------------
Step 1: writing a YANG module Step 1: writing a YANG module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -1,25 +1,10 @@
Table of Contents Transactional CLI
----------------- =================
- `Introduction <#introduction>`__ .. contents:: Table of contents
- `Configuration modes <#config-modes>`__ :local:
- `New commands <#retrofitting-process>`__ :backlinks: entry
:depth: 1
- `commit check <#cmd1>`__
- `commit <#cmd2>`__
- `discard <#cmd3>`__
- `configuration database max-transactions <#cmd4>`__
- `configuration load <#cmd5>`__
- `rollback configuration <#cmd6>`__
- `show configuration candidate <#cmd7>`__
- `show configuration compare <#cmd8>`__
- `show configuration running <#cmd9>`__
- `show configuration transaction <#cmd10>`__
- `show yang module <#cmd11>`__
- `show yang module-translator <#cmd12>`__
- `update <#cmd13>`__
- `yang module-translator load <#cmd14>`__
- `yang module-translator unload <#cmd15>`__
Introduction Introduction
~~~~~~~~~~~~ ~~~~~~~~~~~~

View File

@ -1,11 +1,10 @@
Table of Contents YANG Module Translation
----------------- =======================
- `Introduction <#introduction>`__ .. contents:: Table of contents
- `Deviation Modules <#deviation-modules>`__ :local:
- `Translation Tables <#translation-tables>`__ :backlinks: entry
- `CLI Demonstration <#cli-demonstration>`__ :depth: 1
- `Implementation Details <#implementation-details>`__
Introduction Introduction
------------ ------------

View File

@ -1,5 +1,5 @@
Yang Tools Yang Tools
~~~~~~~~~~ ==========
Here's some information about various tools for working with yang Here's some information about various tools for working with yang
models. models.