documentation-folder-reorg

documentation/README.md

@@ -1,4 +1,3 @@
-[[ << Back to DASH top-level README ](../README.md)]
 # DASH Documentation 
 
 Documentation comprises system descriptions, High-level design (HLD) documents and detailed compliance requirements. These are contained in the [DASH/documentation](./) directory and subdirectories.
@@ -8,50 +7,33 @@ The testing framework, methodology, documentation and testing artifacts are stor
 See also DASH [FAQ](https://github.com/Azure/DASH/wiki/FAQ) and [Glossary](https://github.com/Azure/DASH/wiki/Glossary). 
 
 # Contents
+
 ## Baseline Specifications and Requirements
+
 All DASH devices shall conform to the following design specifications and compliance requirements:
 
-| Topic   | Links to Folders |
-| ------- | ---------|
-| General Architecture and Requirements| [Parent Folder](general/README.md) \| [ Design](general/design/README.md) \| [Compliance Requirements](general/requirements/README.md)|
-| Data plane                           | [Parent Folder](dataplane/README.md) \| [ Design](dataplane/design/README.md) \| [Compliance Requirements](dataplane/requirements/README.md)|
-| High-Availability (HA)                                                    | [Parent Folder](high-avail/README.md) \| [ Design](high-avail/design/README.md) \| [Compliance Requirements](high-avail/requirements/README.md)|
-| gNMI Northbound API                  | [Parent Folder](gnmi/README.md) \| [ Design](gnmi/design/README.md) \| [Compliance Requirements](gnmi/requirements/README.md)|
-| SAI Southbound API                   | [Parent Folder](sai/README.md) \| [ Design](sai/design/README.md) \| [Compliance Requirements](sai/requirements/README.md)|
+| Topic                                 | Documents                                   |
+| ------------------------------------- | --------------------------------------------|
+| General Architecture and Requirements | [DASH general](./general/README.md)|        |
+| Data plane                            | [Data plane](./dataplane/README.md)         |
+| High-Availability (HA)                | [High-Availability](./high-avail/README.md) |
+| gNMI Northbound API                   | [gNMI Northbound API](./gnmi/README.md)     |
+| SAI Southbound API                    | [SAI Southbound API](./sai/README.md)       |
 
 ## Service Specifications and Requirements
+
 DASH devices may implement one or more of the following services.
+
 They shall conform to each service's design specifications and compliance requirements.
-| Topic   | Links to Folders |
-| ------- | ---------|
-| Load Balancer Service                | [Parent Folder](load-bal-service/README.md) \| [ Design](load-bal-service/design/README.md) \| [Compliance Requirements](load-bal-service/requirements/README.md)|
-| VNET-to-VNET Service                         | [Parent Folder](vnet2vnet-service/README.md) \| [ Design](vnet2vnet-service/design/README.md) \| [Compliance Requirements](vnet2vnet-service/requirements/README.md)|
-| Service Tunnel & Private Link Service                          | [Parent Folder](stpl-service/README.md) \| [ Design](stpl-service/design/README.md) \| [Compliance Requirements](stpl-service/requirements/README.md)|
-| VNET Peering Service                          | [Parent Folder](vnet-peering-service/README.md) \| [ Design](vnet-peering-service/design/README.md) \| [Compliance Requirements](vnet-peering-service/requirements/README.md)|
-| Express Route (ER) Service                    |  [Parent Folder](express-route-service/README.md) \| [ Design](express-route-service/design/README.md) \| [Compliance Requirements](express-route-service/requirements/README.md)|
-| Encryption Gateway Service                    |  [Parent Folder](encrypt-gw-service/README.md) \| [ Design](encrypt-gw-service/design/README.md) \| [Compliance Requirements](encrypt-gw-service/requirements/README.md)|
-
-
-# Organization of Design & Requirements Documents
-Documentation consists of separate, but related *System Descriptions* (HLDs, architecture, theory of operations, etc.) and *Compliance Requirements* (hard specifications, typically numerical  but also behavioral). These two types of documents are deliberately kept separated, see [Relationships and Flow of Documents](#relationships-and-flow-of-documents).
-
-Documentation is organized into folders as follows. Each feature or topic has all the high-level specs  and the compliance requirements in the same parent folder, e.g. General, High-Availability, etc., making it easier to access related information about one topic. As the complexity grows, this helps keep things organized according to "functional topic." 
-```
-topic1
-    design
-        topic1 High-level Descriptions and architecture
-    requirements
-        topic1 compliance Requirements
-
-topic2
-    design
-        topic2 High-level Descriptions
-    requirements
-        topic2 compliance Requirements
-
-etc
-...
-```
+
+| Topic                                 | Documents                                                         |
+| --------------------------------------| ------------------------------------------------------------------|
+| Load Balancer Service                 | [Load Balancer Service](./load-bal-service/README.md)             |
+| VNET-to-VNET Service                  | [VNET-to-VNET Service](./vnet2vnet-service/README.md)             |
+| Service Tunnel & Private Link Service | [Service Tunnel & Private Link Service](./stpl-service/README.md) |
+| VNET Peering Service                  | [VNET Peering Service ](./vnet-peering-service/README.md)         |
+| Express Route (ER) Service            | [Express Route (ER) Service](./express-route-service/README.md)   |
+| Encryption Gateway Service            | [Encryption Gateway Service](./encrypt-gw-service/README.md)      |
 
 # Relationships and Flow of Documents
 The diagram below shows how High-Level Descriptions beget Compliance requirements, compliance requirements beget test cases, and test cases are executed by test scripts to produce Test Results.

documentation/dataplane/README.md

@@ -1,11 +1,17 @@
-[ [ << Back to DASH top-level Documents](../README.md#contents) ]
-
 # DASH Data plane Documents
+
 This folder contains DASH data plane design and requirements documents.
 
-# Contents
+## Design
+
+| Document                                               | Description                                |
+| ------------------------------------------------------ | ------------------------------------------ |
+|[dash-update-timing.md](dash-update-timing.md)          |Routing, ACL, Mapping Updates (WIP)         |
+|[dash-config-schema-json.md](dash-config-schema-json.md)   |Configuration schema example                |
+
+
+
+## Requirements
 
-| Folder                                                 | Description                                  |
-| ------------------------------------------------------ | -------------------------------------------- |
-| [design](design/README.md)                             | DASH Data plane design & architecture documents |
-| [requirements](requirements/README.md)                 | DASH Data plane requirements documents         |
+| Document                                               | Description                                |
+| ------------------------------------------------------ | ------------------------------------------ |

documentation/encrypt-gw-service/README.md

@@ -1,10 +1,14 @@
-[ [ << Back to DASH top-level Documents](../README.md#contents) ]
+# DASH Encryption Gateway Service Documents
 
 This folder contains DASH Encryption Gateway Service design and requirements documents.
 
-# Contents
+## Design
 
-| Folder                                                 | Description                                  |
-| ------------------------------------------------------ | -------------------------------------------- |
-| [design](design/README.md)                             | DASH Encryption Gateway Service design & architecture documents |
-| [requirements](requirements/README.md)                 | DASH Encryption Gateway Service requirements documents         |
+| Document                                               | Description                                |
+| ------------------------------------------------------ | ------------------------------------------ |
+
+
+## Requirements
+
+| Document                                               | Description                                |
+| ------------------------------------------------------ | ------------------------------------------ |

documentation/express-route-service/README.md

@@ -1,10 +1,14 @@
-[ [ << Back to DASH top-level Documents](../README.md#contents) ]
+# DASH Express Route Gateway Service Documents
 
 This folder contains DASH Express Route Gateway Service design and requirements documents.
 
-# Contents
+## Design
 
-| Folder                                                 | Description                                  |
-| ------------------------------------------------------ | -------------------------------------------- |
-| [design](design/README.md)                             | DASH Express Route Gateway Service design & architecture documents |
-| [requirements](requirements/README.md)                 | DASH Express Route Gateway Service requirements documents         |
+| Document                                               | Description                                |
+| ------------------------------------------------------ | ------------------------------------------ |
+
+
+## Requirements
+
+| Document                                               | Description                                |
+| ------------------------------------------------------ | ------------------------------------------ |

documentation/general/README.md

@@ -1,12 +1,23 @@
-[ [ << Back to DASH top-level Documents](../README.md#contents) ]
-
 # DASH General Documents
 
-This folder contains DASH "General" design and requirements documents.
+This folder contains DASH general design and requirements documents.
+
+## Design
+
+| Document                                                                  | Description                                      |
+| ------------------------------------------------------------------------- | -------------------------------------------------|
+| [dash-high-level-design.md](dash-high-level-design.md)                    | DASH High-Level Architecture and Design          |
+| [dash-sonic-hld.md](dash-sonic-hld.md)                                    | DASH APIs, orch agent, config and APP DB Schemas |
+| [sdn-features-packet-transforms.md](sdn-features-packet-transforms.md)    | DASH VNET-to-VNET HLD and Packet Transforms      |
+| [sdn-pipeline-basic-elements.md](sdn-pipeline-basic-elements.md)          | Pipeline basics such as path direction and flow  |
+| [dash-handling-fragmented-packets.md](dash-handling-fragmented-packets.md)| Handling of packet fragments                     |
+|||
+
+
 
-# Contents
+## Requirements
 
-| Folder                                                 | Description                                  |
-| ------------------------------------------------------ | -------------------------------------------- |
-| [design](design/README.md)                             | DASH General design & architecture documents |
-| [requirements](requirements/README.md)                 | DASH General requirements documents         |
+| Document                                               | Description                                |
+| ---------------------------------------------------------------------------------- | ------------------------------------------ |
+| [dash-general-compliance-requirements.md](dash-general-compliance-requirements.md) | DASH General Compliance Requirements    |
+| [program-scale-testing-requirements-draft.md](program-scale-testing-requirements-draft.md) | DASH scale and performance requirements   |

documentation/general/requirements/dash-general-compliance-requirements.md → documentation/general/dash-general-compliance-requirements.md

@@ -1,13 +1,10 @@
-[ [ << Back to parent directory](../README.md) ]
-
-[ [ << Back to DASH top-level Documents](../../README.md#contents) ]
-
 # DASH General Compliance Requirements
-# DASH Versioning and Configuration Management
+
+## DASH Versioning and Configuration Management
 
 >**TODO** Determine a versioning system for each category as well as the overall configuration of a "release."
 
-# Continuous Integration and Test
+## Continuous Integration and Test
 Continuous integration verifies the correctness of each committed configuration. Workflows can be triggered manually, or automatically (by commits). Success/failure can be  criteria for accepting pull requests.
 
 **TODO** Define objectives and implement automation (Git Actions). The follow non-exhaustive list is just an example of what can be done:
@@ -19,6 +16,6 @@ Continuous integration verifies the correctness of each committed configuration.
 * Execute DASH software data planes via P4 behavioral models: run test suites which configure the software Device under Test (DUT) and send traffic to/from the data plane with software traffic testers. See [DASH Testing Using P4 Simulators and SAI Thrift](../test/docs/dash-test-workflow-p4-saithrift.md) for an example workflow.
 
 
-# Reference Architectures
+## Reference Architectures
 Reference architectures for test scenarios are described in [test/docs/dash-test-ref-arch.md](../../../test/docs/dash-test-ref-arch.md)