doc: Improves Guides menu (#2408)

* add 0.8.2 metadata * update old category and remove unneeded headers * update page_title * fix titles * remove old guide
mongodb · Jul 15, 2024 · d0c7113 · d0c7113
1 parent 011e6a2
commit d0c7113
Show file tree

Hide file tree

Showing 27 changed files with 55 additions and 231 deletions.
diff --git a/RELEASING.md b/RELEASING.md
@@ -9,6 +9,12 @@
 - If some deprecated attributes need to be removed in the following release, create a Jira ticket and merge the corresponding PR before starting the release workflow.
 You can search in the code for the constansts in [deprecation.go](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/internal/common/constant/deprecation.go) to find them.
 
+### Move old guides
+
+**Note**: Only applies if the right most version digit is 0 (considered a major or minor version in [semantic versioning](https://semver.org/)).
+
+- Keep only [Guides](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/website/docs/guides) for 12 months. Previous versions must be added in the header `subcategory: "Older Guides"`.
+
 ### Revise jira release
 
 Before triggering a release, view the corresponding [unreleased jira page](https://jira.mongodb.org/projects/CLOUDP?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=unreleased&contains=terraform) to ensure there are no pending tickets. In case there are pending tickets, verify with the team if the expectation is to have them included within the current release. After release workflow is successful the version will be marked as released automatically.

diff --git a/website/docs/guides/0.6.0-upgrade-guide.html.markdown b/website/docs/guides/0.6.0-upgrade-guide.html.markdown
@@ -1,10 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 0.6.0: Upgrade Guide"
-sidebar_current: "docs-mongodbatlas-guides-060-upgrade-guide"
-description: |-
-    MongoDB Atlas Provider 0.6.0: Upgrade Guide
-    
+page_title: "Upgrade Guide 0.6.0"
+subcategory: "Older Guides"    
 ---
 
 # MongoDB Atlas Provider 0.6.0: Upgrade Guide

diff --git a/website/docs/guides/0.8.0-upgrade-guide.html.markdown b/website/docs/guides/0.8.0-upgrade-guide.html.markdown
@@ -1,10 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 0.8.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-080-upgrade-guide"
-description: |-
-    MongoDB Atlas Provider 0.8.0: Upgrade and Information Guide
-    
+page_title: "Upgrade Guide 0.8.0"
+subcategory: "Older Guides"    
 ---
 
 # MongoDB Atlas Provider v0.8.0: Upgrade and Information Guide

diff --git a/website/docs/guides/0.8.2-upgrade-guide.html.markdown b/website/docs/guides/0.8.2-upgrade-guide.html.markdown
@@ -1,4 +1,11 @@
-## 0.8.2 Upgrade Guide for Privatelink users
+---
+page_title: "Upgrade Guide 0.8.2"
+subcategory: "Older Guides"
+---
+
+# MongoDB Atlas Provider v0.8.2: Upgrade and Information Guide
+
+## Upgrade Guide for Privatelink users
 
 ### Resources are impacted that were created with versions ***v0.8.0/v0.8.1***
 ### Fixed in [#398](https://github.com/mongodb/terraform-provider-mongodbatlas/pull/398)

diff --git a/website/docs/guides/0.9.0-upgrade-guide.html.markdown b/website/docs/guides/0.9.0-upgrade-guide.html.markdown
@@ -1,10 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 0.9.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-090-upgrade-guide"
-description: |-
-    MongoDB Atlas Provider 0.9.0: Upgrade and Information Guide
-    
+page_title: "Upgrade Guide 0.9.0"
+subcategory: "Older Guides"    
 ---
 
 # MongoDB Atlas Provider v0.9.0: Upgrade and Information Guide

diff --git a/website/docs/guides/0.9.1-upgrade-guide.html.markdown b/website/docs/guides/0.9.1-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 0.9.1: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-091-upgrade-guide"
-description: |-
-    MongoDB Atlas Provider 0.9.1: Upgrade and Information Guide
+page_title: "Upgrade Guide 0.9.1"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider v0.9.1: Upgrade and Information Guide

diff --git a/website/docs/guides/1.0.0-upgrade-guide.html.markdown b/website/docs/guides/1.0.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.0.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-100-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 0.1.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.0.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.0.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.0.1-upgrade-guide.html.markdown b/website/docs/guides/1.0.1-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.0.1: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-101-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.0.1: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.0.1"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider v1.0.1: Upgrade and Information Guide

diff --git a/website/docs/guides/1.1.0-upgrade-guide.html.markdown b/website/docs/guides/1.1.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.1.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-110-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.1.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.1.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.1.0/1.1.1: Upgrade and Information Guide

diff --git a/website/docs/guides/1.10.0-upgrade-guide.html.markdown b/website/docs/guides/1.10.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.10.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-1100-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.10.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.10.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.10.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.11.0-upgrade-guide.html.markdown b/website/docs/guides/1.11.0-upgrade-guide.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.11.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-1110-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.11.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.11.0"
 ---
 
 # MongoDB Atlas Provider 1.11.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.12.0-upgrade-guide.html.markdown b/website/docs/guides/1.12.0-upgrade-guide.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.12.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-1120-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.12.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.12.0"
 ---
 
 # MongoDB Atlas Provider 1.12.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.13.0-upgrade-guide.html.markdown b/website/docs/guides/1.13.0-upgrade-guide.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.13.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-1130-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.13.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.13.0"
 ---
 
 # MongoDB Atlas Provider 1.13.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.14.0-upgrade-guide.html.markdown b/website/docs/guides/1.14.0-upgrade-guide.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.14.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-1140-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.14.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.14.0"
 ---
 
 # MongoDB Atlas Provider 1.14.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.15.0-upgrade-guide.html.markdown b/website/docs/guides/1.15.0-upgrade-guide.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.15.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-1150-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.15.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.15.0"
 ---
 
 # MongoDB Atlas Provider 1.15.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.16.0-upgrade-guide.html.markdown b/website/docs/guides/1.16.0-upgrade-guide.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.16.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-1160-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.16.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.16.0"
 ---
 
 # MongoDB Atlas Provider 1.16.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.17.0-upgrade-guide.html.markdown b/website/docs/guides/1.17.0-upgrade-guide.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.17.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-1170-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.17.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.17.0"
 ---
 
 # MongoDB Atlas Provider 1.17.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.2.0-upgrade-guide.html.markdown b/website/docs/guides/1.2.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.2.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-120-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.2.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.2.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.2.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.3.0-upgrade-guide.html.markdown b/website/docs/guides/1.3.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.3.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-130-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.3.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.3.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.3.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.4.0-upgrade-guide.html.markdown b/website/docs/guides/1.4.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.4.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-140-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.4.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.4.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.4.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.5.0-upgrade-guide.html.markdown b/website/docs/guides/1.5.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.5.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-150-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.5.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.5.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.5.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.6.0-upgrade-guide.html.markdown b/website/docs/guides/1.6.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.6.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-160-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.6.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.6.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.6.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.7.0-upgrade-guide.html.markdown b/website/docs/guides/1.7.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.7.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-170-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.7.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.7.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.7.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.8.0-upgrade-guide.html.markdown b/website/docs/guides/1.8.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.8.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-180-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.8.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.8.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.8.0: Upgrade and Information Guide

diff --git a/website/docs/guides/1.9.0-upgrade-guide.html.markdown b/website/docs/guides/1.9.0-upgrade-guide.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "MongoDB Atlas Provider 1.9.0: Upgrade and Information Guide"
-sidebar_current: "docs-mongodbatlas-guides-190-upgrade-guide"
-description: |-
-MongoDB Atlas Provider 1.9.0: Upgrade and Information Guide
+page_title: "Upgrade Guide 1.9.0"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider 1.9.0: Upgrade and Information Guide

diff --git a/website/docs/guides/Programmatic-API-Key-upgrade-guide-1.10.0.html.markdown b/website/docs/guides/Programmatic-API-Key-upgrade-guide-1.10.0.html.markdown
@@ -1,9 +1,6 @@
 ---
-layout: "mongodbatlas"
-page_title: "Upgrade Guide for Terraform MongoDB Atlas Provider Programmatic API Key Resource in v1.10.0"
-sidebar_current: "docs-mongodbatlas-guides-Programmatic-API-Key-upgrade-guide"
-description: |-
-MongoDB Atlas Provider : Upgrade and Information Guide
+page_title: "Upgrade Guide 1.10.0 for Programmatic API Key"
+subcategory: "Older Guides"
 ---
 
 # MongoDB Atlas Provider: Programmatic API Key Upgrade Guide in v1.10.0