MMF-1420 Ease management of Embedded Docs navigation (#699)

4 files changed, 177 insertions, 0 deletions

diff --git a/server/sonar-docs/static/README.md b/server/sonar-docs/static/README.md
new file mode 100644
index 00000000000..4e3c36aa6a7
--- /dev/null
+++ b/server/sonar-docs/static/README.md
@@ -0,0 +1,24 @@
+These three `*.NavigationTree.json` files control the navigation trees of the three versions of the documentation.
+
+Each one contains a JSON array. Array elements may either be:
+
+* a path string
+* a node
+
+**Nodes contain two elements:**
+* title - string. This is the "parent" node name to be used in the navigation tree
+* children - array of path strings
+
+**Paths**
+* begin with '/'
+* end with '/'
+* match the `url:` value of a page. 
+* **do not** include the trailing `.md` in the file name
+
+**What is the URL value of a page?**  
+The url value can be implicitly defined by the document's path under the `pages` directory, or explicitly overridden by in the page metadata by setting `url: [path here]`.
+
+Paths must always start and end with '/'. That includes:
+* page metadata
+* navigation tree files
+* links between pages
diff --git a/server/sonar-docs/static/SonarCloudNavigationTree.json b/server/sonar-docs/static/SonarCloudNavigationTree.json
new file mode 100644
index 00000000000..77f9677e168
--- /dev/null
+++ b/server/sonar-docs/static/SonarCloudNavigationTree.json
@@ -0,0 +1,53 @@
+[
+  "/privacy/",
+  "/security/",
+  "/sonarcloud-pricing/",
+  "/analyze-a-project/",
+  {
+    "title": "Analyzing Source Code",
+    "children": [
+      "/analysis/overview/",
+      "/analysis/background-tasks/",
+      "/analysis/generic-issue/",
+      "/analysis/generic-test/",
+      "/analysis/pull-request/",
+      "/analysis/scm-integration/"
+    ]
+  },
+  {
+    "title": "Integrations",
+    "children": ["/integrations/bitbucketcloud/", "/integrations/github/", "/integrations/vsts/"]
+  },
+  {
+    "title": "Branches",
+    "children": [
+      "/branches/overview/",
+      "/branches/short-lived-branches/",
+      "/branches/long-lived-branches/",
+      "/branches/branches-faq/"
+    ]
+  },
+  {
+    "title": "User Guide",
+    "children": [
+      "/user-guide/fixing-the-water-leak/",
+      "/user-guide/keyboard-shortcuts/",
+      "/user-guide/quality-gates/",
+      "/user-guide/metric-definitions/",
+      "/user-guide/security-reports/",
+      "/user-guide/user-account/"
+    ]
+  },
+  {
+    "title": "Project Administration",
+    "children": ["/project-administration/webhooks/"]
+  },
+  {
+    "title": "Organizations",
+    "children": [
+      "/organizations/overview/",
+      "/organizations/manage-team/",
+      "/organizations/organization-visibility/"
+    ]
+  }
+]
diff --git a/server/sonar-docs/static/SonarQubeNavigationTree.json b/server/sonar-docs/static/SonarQubeNavigationTree.json
new file mode 100644
index 00000000000..1d047f5936c
--- /dev/null
+++ b/server/sonar-docs/static/SonarQubeNavigationTree.json
@@ -0,0 +1,46 @@
+[
+  {
+    "title": "Analyzing Source Code",
+    "children": [
+      "/analysis/overview/",
+      "/analysis/background-tasks/",
+      "/analysis/generic-issue/",
+      "/analysis/generic-test/",
+      "/analysis/pull-request/",
+      "/analysis/scm-integration/"
+    ]
+  },
+  {
+    "title": "Branches",
+    "children": [
+      "/branches/overview/",
+      "/branches/short-lived-branches/",
+      "/branches/long-lived-branches/",
+      "/branches/branches-faq/"
+    ]
+  },
+  {
+    "title": "User Guide",
+    "children": [
+      "/user-guide/fixing-the-water-leak/",
+      "/user-guide/keyboard-shortcuts/",
+      "/user-guide/quality-gates/",
+      "/user-guide/metric-definitions/",
+      "/user-guide/security-reports/",
+      "/user-guide/user-account/"
+    ]
+  },
+  {
+    "title": "Project Administration",
+    "children": ["/project-administration/webhooks/"]
+  },
+  {
+    "title": "Instance Administration",
+    "children": [
+      "/instance-administration/custom-measures/",
+      "/instance-administration/housekeeping/",
+      "/instance-administration/look-and-feel/",
+      "/instance-administration/quality-profiles/"
+    ]
+  }
+]
diff --git a/server/sonar-docs/static/StaticNavigationTree.json b/server/sonar-docs/static/StaticNavigationTree.json
new file mode 100644
index 00000000000..ffbac954d82
--- /dev/null
+++ b/server/sonar-docs/static/StaticNavigationTree.json
@@ -0,0 +1,54 @@
+[
+  {
+    "title": "Requirements",
+    "children": []
+  },
+  {
+    "title": "Setup and Upgrade",
+    "children": []
+  },
+  {
+    "title": "Analyzing Source Code",
+    "children": [
+      "/analysis/overview/",
+      "/analysis/background-tasks/",
+      "/analysis/generic-issue/",
+      "/analysis/generic-test/",
+      "/analysis/pull-request/",
+      "/analysis/scm-integration/"
+    ]
+  },
+  {
+    "title": "Branches",
+    "children": [
+      "/branches/overview/",
+      "/branches/short-lived-branches/",
+      "/branches/long-lived-branches/",
+      "/branches/branches-faq/"
+    ]
+  },
+  {
+    "title": "User Guide",
+    "children": [
+      "/user-guide/fixing-the-water-leak/",
+      "/user-guide/keyboard-shortcuts/",
+      "/user-guide/quality-gates/",
+      "/user-guide/metric-definitions/",
+      "/user-guide/security-reports/",
+      "/user-guide/user-account/"
+    ]
+  },
+  {
+    "title": "Project Administration",
+    "children": ["/project-administration/webhooks/"]
+  },
+  {
+    "title": "Instance Administration",
+    "children": [
+      "/instance-administration/custom-measures/",
+      "/instance-administration/housekeeping/",
+      "/instance-administration/look-and-feel/",
+      "/instance-administration/quality-profiles/"
+    ]
+  }
+]