documentation-folder-reorg

[mmiele]

Documentation folder reorg

[mmiele]

Ready for another review pass.

[chrispsommers]

I think you missed this one:

high-avail/xsight-labs-ha-proposal-v1.md:11:https://github.com/Azure/DASH/blob/main/documentation/high-avail/design/high-availability-and-scale.md
general/dash-sonic-hld.md:471:For testing purposes, it is convenient to express test configurations in a single canonical format, and use this to drive the different API layers to verify correct behavior. A tentative JSON format for representing DASH service configurations is described in https://github.com/Azure/DASH/blob/main/documentation/gnmi/design/dash-reference-config-example.md. Test drivers can accept this input, transform it into different schemas and drive the associated interfaces. For example, a JSON representation of an ACL rule can be transformed into gNMI API calls, SAI-redis calls, SAI-thrift calls, etc.
general/dash-high-level-design.md:282:Scale](../../high-avail/design/high-availability-and-scale.md) document.

[chrispsommers]

A lot of READMEs have this at top:

[<< Back to parent directory](../README.md) ]

[<< Back to DASH top-level Documents](../../README.md#contents) ]

Only one is needed now, this was there to let you go up one level or two, but you removed the intervening level.
You could also just delete all these, the back button is probably enough, or just click on the breadcrumb links in the browser.

[mmiele]

Fixed the links as follows:
high-avail/xsight-labs-ha-proposal-v1.md:11:https://github.com/Azure/DASH/blob/main/documentation/high-avail/design/high-availability-and-scale.md
High Availability and Scale document for the requirements.

general/dash-sonic-hld.md:471: https://github.com/Azure/DASH/blob/main/documentation/gnmi/design/dash-reference-config-example.md.
Reference configuration example (JSON).

general/dash-high-level-design.md:282:Scale](../../high-avail/design/high-availability-and-scale.md) document.
High Availability andScale document.

[mmiele]

@chrispsommers Let me clean the README files. I'll delete the links.

[mmiele]

@chrispsommers Removed obsolete links from the README files.

[mmiele]

@chrispsommers I think I made the required fixes.
To avoid annoying conflicts with changes made using the old organization. and if there are no showstoppers, can you please approve the PR?
@KrisNey-MSFT can merge it into the main branch and we'll make adjustments if needed using the new organization.
Thanks

[chrispsommers]

@chrispsommers I think I made the required fixes. To avoid annoying conflicts with changes made using the old organization. and if there are no showstoppers, can you please approve the PR? @KrisNey-MSFT can merge it into the main branch and we'll make adjustments if needed using the new organization. Thanks

Hi Michael, I still want to review it a bit more prior to approving. I understand the desire for speed, but the scope of this change is pretty large so we need to get it right. Thanks for your hard work and patience.

[mmiele]

@chrispsommers Take your time and let me know when you are done. Thanks

[chrispsommers]

Hi @mmiele did you intend to remove all those obsolete "Back to" links? I still see many:

chris@chris-z4:~/mmiele-DASH/DASH/documentation$ grep -rn --include=*.md '.md' |grep 'Back to'
high-avail/slides/README.md:1:[ [ << Back to parent directory](../README.md) ]
high-avail/slides/README.md:3:[ [ << Back to DASH top-level Documents](../../README.md#contents) ]
README.md:1:[[ << Back to DASH top-level README ](../README.md)]
general/dash-general-compliance-requirements.md:1:[ [ << Back to parent directory](../README.md) ]
general/dash-general-compliance-requirements.md:3:[ [ << Back to DASH top-level Documents](../../README.md#contents) ]
general/sdn-pipeline-basic-elements.md:1:[<< Back to parent directory](../README.md) ]
general/sdn-pipeline-basic-elements.md:3:[<< Back to DASH top-level Documents](../../README.md#contents) ]
general/dash-high-level-design.md:5:[<< Back to parent directory](../README.md) ]
general/dash-high-level-design.md:7:[<< Back to DASH top-level Documents](../../README.md#contents) ]
general/sdn-features-packet-transforms.md:1:[<< Back to parent directory](../README.md) ]
general/sdn-features-packet-transforms.md:3:[<< Back to DASH top-level Documents](../../README.md#contents) ]
general/program-scale-testing-requirements-draft.md:2:[ [ << Back to parent directory](../README.md) ]
general/program-scale-testing-requirements-draft.md:4:[ [ << Back to DASH top-level Documents](../../README.md#contents) ]
vnet2vnet-service/vnet-to-vnet-service.md:5:[[<< Back to parent directory](../README.md)]
vnet2vnet-service/vnet-to-vnet-service.md:7:[[<< Back to DASH top-level Documents](../../README.md#contents)]

[chrispsommers]

I stumbled on this, it is obsolete and should be deleted: https://github.com/mmiele/DASH/blob/documentation-folder-reorg/documentation/images/README.md

[mmiele]

@chrispsommers Let me look into the links issue.

[chrispsommers]

LGTM, nice work.

[mmiele]

@chrispsommers Thank you for your thorough review. ✔️ Until next time. 👍

[mmiele]

@KrisNey-MSFT The PR is ready to be merged into the main branch.

[chrispsommers]

@chrispsommers Thank you for your thorough review. ✔️ Until next time. 👍

My pleasure buddy, great to work together again. We make a good tag-team.