[DOC] Move Reporting to high-level section in nav menu (#4654)

* Move Reporting to high-level section in nav menu --------- Signed-off-by: Melissa Vagi <[email protected]>
opensearch-project · Jul 31, 2023 · a79a8cb · a79a8cb
1 parent aa97f54
commit a79a8cb
Show file tree

Hide file tree

Showing 10 changed files with 66 additions and 28 deletions.
diff --git a/_config.yml b/_config.yml
@@ -67,6 +67,9 @@ collections:
   observing-your-data:
     permalink: /:collection/:path/
     output: true
+  reporting:
+    permalink: /:collection/:path/
+    output: true
   query-dsl:
     permalink: /:collection/:path/
     output: true 
@@ -145,6 +148,9 @@ just_the_docs:
     observing-your-data:
       name: Observability
       nav_fold: true
+    reporting:
+      name: Reporting
+      nav_fold: true
     clients:
       name: Clients
       nav_fold: true

diff --git a/_reporting/index.md b/_reporting/index.md
@@ -0,0 +1,14 @@
+---
+layout: default
+title: Reporting
+nav_order: 1
+has_children: false
+nav_exclude: true
+---
+
+# Reporting
+
+Learn more about the following reporting features in OpenSearch:
+
+- [Reporting using OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/reporting/report-dashboard-index/) 
+- [Reporting using the CLI]({{site.url}}{{site.baseurl}}/reporting/rep-cli-index/)
diff --git a/_dashboards/reporting-cli/rep-cli-create.md → _reporting/rep-cli-create.md b/_dashboards/reporting-cli/rep-cli-create.md → _reporting/rep-cli-create.md
@@ -1,12 +1,14 @@
 ---
 layout: default
-title: Creating and requesting a visualization report
+title: Create and request visualization reports
 nav_order: 15
-parent: Creating reports with the Reporting CLI
-
+parent: Reporting using the CLI
+grand_parent: Reporting
+redirect_from:
+  - /dashboards/reporting-cli/rep-cli-create/
 ---
 
-# Creating and requesting a visualization report
+# Create and request visualization reports
 
 First, you need to get the URL for the visualization that you want to download as an image file or PDF.
 

diff --git a/_dashboards/reporting-cli/rep-cli-cron.md → _reporting/rep-cli-cron.md b/_dashboards/reporting-cli/rep-cli-cron.md → _reporting/rep-cli-cron.md
@@ -1,12 +1,14 @@
 ---
 layout: default
-title: Scheduling reports with the cron utility
+title: Schedule reports with the cron utility
 nav_order: 20
-parent: Creating reports with the Reporting CLI
-
+parent: Reporting using the CLI
+grand_parent: Reporting
+redirect_from:
+  - /dashboards/reporting-cli/rep-cli-cron/
 ---
 
-# Scheduling reports with the cron utility
+# Schedule reports with the cron utility
 
 You can use the cron command-line utility to initiate a report request with the Reporting CLI that runs periodically at any date or time interval. Follow the cron expression syntax to specify the date and time that precedes the command that you want to initiate.
 

diff --git a/_dashboards/reporting-cli/rep-cli-env-var.md → _reporting/rep-cli-env-var.md b/_dashboards/reporting-cli/rep-cli-env-var.md → _reporting/rep-cli-env-var.md
@@ -1,12 +1,14 @@
 ---
 layout: default
-title: Using environment variables with the Reporting CLI
+title: Use environment variables with the Reporting CLI
 nav_order: 35
-parent: Creating reports with the Reporting CLI
-
+parent: Reporting using the CLI
+grand_parent: Reporting
+redirect_from:
+  - /dashboards/reporting-cli/rep-cli-env-var/
 ---
 
-# Using environment variables with the Reporting CLI
+# Use environment variables with the Reporting CLI
 
 Instead of explicitly providing values in the command line, you can save them as environment variables. The Reporting CLI reads environment variables from the current directory inside the project.
 

diff --git a/_dashboards/reporting-cli/rep-cli-index.md → _reporting/rep-cli-index.md b/_dashboards/reporting-cli/rep-cli-index.md → _reporting/rep-cli-index.md
@@ -1,11 +1,13 @@
 ---
 layout: default
-title: Creating reports with the Reporting CLI
-nav_order: 75
+title: Reporting using the CLI
+nav_order: 10
 has_children: true
+redirect_from:
+  - /dashboards/reporting-cli/rep-cli-index/
 ---
 
-# Creating reports with the Reporting CLI
+# Reporting using the CLI
 
 You can programmatically create dashboard reports in PDF or PNG format with the Reporting CLI without using OpenSearch Dashboards or the Reporting plugin. This allows you to create reports automatically within your email workflows.
 

diff --git a/_dashboards/reporting-cli/rep-cli-install.md → _reporting/rep-cli-install.md b/_dashboards/reporting-cli/rep-cli-install.md → _reporting/rep-cli-install.md
@@ -1,12 +1,14 @@
 ---
 layout: default
-title: Downloading and installing the Reporting CLI tool
+title: Download and install the Reporting CLI tool
 nav_order: 10
-parent: Creating reports with the Reporting CLI
-
+parent: Reporting using the CLI
+grand_parent: Reporting
+redirect_from:
+  - /dashboards/reporting-cli/rep-cli-install/
 ---
 
-# Downloading and installing the Reporting CLI tool
+# Download and install the Reporting CLI tool
 
 You can download and install the Reporting CLI tool from either the npm software registry or the OpenSearch.org [Artifacts](https://opensearch.org/artifacts) hub. Refer to the following sections for instructions.
 

diff --git a/_dashboards/reporting-cli/rep-cli-lambda.md → _reporting/rep-cli-lambda.md b/_dashboards/reporting-cli/rep-cli-lambda.md → _reporting/rep-cli-lambda.md
@@ -1,9 +1,11 @@
 ---
 layout: default
-title: Scheduling reports with AWS Lambda
+title: Schedule reports with AWS Lambda
 nav_order: 30
-parent: Creating reports with the Reporting CLI
-
+parent: Reporting using the CLI
+grand_parent: Reporting
+redirect_from:
+  - /dashboards/reporting-cli/rep-cli-lambda/
 ---
 
 # Scheduling reports with AWS Lambda

diff --git a/_dashboards/reporting-cli/rep-cli-options.md → _reporting/rep-cli-options.md b/_dashboards/reporting-cli/rep-cli-options.md → _reporting/rep-cli-options.md
@@ -2,8 +2,10 @@
 layout: default
 title: Reporting CLI options
 nav_order: 30
-parent: Creating reports with the Reporting CLI
-
+parent: Reporting using the CLI
+grand_parent: Reporting
+redirect_from:
+  - /dashboards/reporting-cli/rep-cli-options/
 ---
 
 # Reporting CLI options

diff --git a/_dashboards/reporting.md → _reporting/report-dashboard-index.md b/_dashboards/reporting.md → _reporting/report-dashboard-index.md
@@ -1,18 +1,20 @@
 ---
 layout: default
-title: Creating reports with the Dashboards interface
-nav_order: 70
+title: Reporting using OpenSearch Dashboards
+nav_order: 5
+redirect_from:
+  - /dashboards/reporting/
 ---
 
 
-# Creating reports with the Dashboards interface
+# Reporting using OpenSearch Dashboards
 
 You can use OpenSearch Dashboards to create PNG, PDF, and CSV reports. To create reports, you must have the correct permissions. For a summary of the predefined roles and the permissions they grant, see the [Security plugin]({{site.url}}{{site.baseurl}}/security/access-control/users-roles#predefined-roles).
 
 CSV reports have a non-configurable 10,000 row limit. They have no explicit size limit (for example, MB), but extremely large documents could cause report generation to fail with an out of memory error from the V8 JavaScript engine.
 {: .tip }
 
-## Generating reports with the interface
+## Generating reports
 
 To generate a report from the interface:
 
@@ -44,6 +46,8 @@ Definitions let you generate reports on a periodic schedule.
 
 ## Troubleshooting
 
+You can use the following topics to troubleshoot and resolve issues with reporting.
+
 ### Chromium fails to launch with OpenSearch Dashboards
 
 While creating a report for dashboards or visualizations, you might see a the following error: