From 07c7fc7fced9c99634716fd365b9566931540731 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 26 May 2022 15:41:24 -0700 Subject: [PATCH 1/3] New ref archi for describing doc hierarchies --- .../reference-architectures/README.md | 18 +++++- .../multi-system-project-markmap.html | 42 ++++++++++++++ .../multi-system-project-markmap.md | 58 +++++++++++++++++++ 3 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 documentation/reference-architectures/documentation-organization/multi-system-project-markmap.html create mode 100644 documentation/reference-architectures/documentation-organization/multi-system-project-markmap.md diff --git a/documentation/reference-architectures/README.md b/documentation/reference-architectures/README.md index 9bc74c218..59a487ae3 100644 --- a/documentation/reference-architectures/README.md +++ b/documentation/reference-architectures/README.md @@ -1,3 +1,19 @@ # Reference Architectures -Nothing here yet, come back soon... \ No newline at end of file +This page contains sample reference architectures for documentation best practices. Consult the architectures listed here for guidance on implementing specific documentation use cases with recommended tools. + +## Documentation Organization + +Tips for organizing and structuring your documentation artifacts in easy-to-access hierarchies. + +### Multi-System Project + +Use the following hierarchy for organizing your documentation within an organization with self-managed, sub-organizational software systems. This type of hierarchy is particularly common for projects involving logically separated sub-projects and teams that all fall under one overall project umbrella. + +**Preview of architecture** + +[!embed el="embed"](documentation-organization/multi-system-project-markmap.html) + +**Versions:** + +[!button Full Visualization](documentation-organization/multi-system-project.html) [!button Markdown](documentation-organization/multi-system-project-markmap.md) diff --git a/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.html b/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.html new file mode 100644 index 000000000..2e128314d --- /dev/null +++ b/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.html @@ -0,0 +1,42 @@ + + + + + + +Markmap + + + + + + + + diff --git a/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.md b/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.md new file mode 100644 index 000000000..f567e5d72 --- /dev/null +++ b/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.md @@ -0,0 +1,58 @@ +- Docs + - Intro + - User Docs + - Getting Started + - User Persona 1 + - User Persona 2 + - Components + - User Facing Component 1 + - User Facing Component 2 + - FAQ + - Getting Help + - Developer Docs + - Architecture + - Systems + - System 1 + - Features + - Quick Start + - Docs + - User Guide + - ex. Setup + - ex. Running + - ex. Usage Examples + - Developer Guide + - ex. Requirements + - ex. Setup + - ex. Building + - ex. Running + - ex. Testing + - Admin Guide + - ex. Requirements + - ex. Installing + - ex. Configuring + - ex. Troubleshooting + - FAQ + - System 2 + - Features + - Quick Start + - Docs + - User Guide + - ex. Setup + - ex. Running + - ex. Usage Examples + - Developer Guide + - ex. Requirements + - ex. Setup + - ex. Building + - ex. Running + - ex. Testing + - Admin Guide + - ex. Requirements + - ex. Installing + - ex. Configuring + - ex. Troubleshooting + - FAQ + - Getting Involved + - Prerequisites + - Development Process + - Ways to Contribute From 7924bf6592eb6357a8956c9f0b6084eccb2f3076 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 26 May 2022 22:42:01 +0000 Subject: [PATCH 2/3] Markmap HTML (re)generated from source --- .../multi-system-project-markmap.html | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.html b/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.html index 2e128314d..4b982da10 100644 --- a/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.html +++ b/documentation/reference-architectures/documentation-organization/multi-system-project-markmap.html @@ -16,11 +16,11 @@ height: 100vh; } - + - +}) From 98e04dce2fdbee6909583b9e39c9b2d4be2e5f51 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Thu, 26 May 2022 15:46:53 -0700 Subject: [PATCH 3/3] Make sure ref archi subdirectory is hidden from retype --- .../reference-architectures/documentation-organization/index.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 documentation/reference-architectures/documentation-organization/index.yml diff --git a/documentation/reference-architectures/documentation-organization/index.yml b/documentation/reference-architectures/documentation-organization/index.yml new file mode 100644 index 000000000..4708564f6 --- /dev/null +++ b/documentation/reference-architectures/documentation-organization/index.yml @@ -0,0 +1 @@ +visibility: hidden \ No newline at end of file