Merge pull request #400 from ovh/yomovh/sidebar_improvement

Add subcategory in documentation page
ovh · Mar 21, 2023 · 30af8c4 · 30af8c4
2 parents 8b55294 + 7bbd2b2
commit 30af8c4
Show file tree

Hide file tree

Showing 160 changed files with 162 additions and 1,132 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,6 +14,7 @@ This project accepts contributions. In order to contribute, you should pay atten
 - Code must be formatted with `make fmt` command
 - Name your resources and datasources according to the API endpoint
 - Check your documentation through [Terraform Doc Preview Tool](https://registry.terraform.io/tools/doc-preview)
+- When adding a documentation page, use the `subcategory:` tag in the [YAML Frontmatter](https://developer.hashicorp.com/terraform/registry/providers/docs#yaml-frontmatter) with a value equals to the product name defined in the OVHcloud [product map](https://www.product-map.ovh/)
 
 ## Acceptance tests:
 

diff --git a/website/docs/d/cloud_project_capabilities_containerregistry.html.markdown b/website/docs/d/cloud_project_capabilities_containerregistry.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_capabilities_containerregistry"
-sidebar_current: "docs-ovh-datasource-cloud-project-capabilities-containerregistry-x"
-description: |-
-  Get the list of container registry capabilities associated with a public cloud project.
+subcategory : "Managed Private Registry"
 ---
 
 # ovh_cloud_project_capabilities_containerregistry (Data Source)

diff --git a/website/docs/d/cloud_project_capabilities_containerregistry_filter.html.markdown b/website/docs/d/cloud_project_capabilities_containerregistry_filter.html.markdown
@@ -1,10 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_capabilities_containerregistry_filter"
-sidebar_current: "docs-ovh-datasource-cloud-project-capabilities-containerregistry-filter"
-description: |-
-  Filter the list of container registry capabilities associated with a public cloud project
-  to match one and only one capability.
+subcategory : "Managed Private Registry"
 ---
 
 # ovh_cloud_project_capabilities_containerregistry_filter (Data Source)

diff --git a/website/docs/d/cloud_project_containerregistries.html.markdown b/website/docs/d/cloud_project_containerregistries.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_containerregistries"
-sidebar_current: "docs-ovh-datasource-cloud-project-containerregistries"
-description: |-
-  Get the list of container registries associated with a public cloud project.
+subcategory : "Managed Private Registry"
 ---
 
 # ovh_cloud_project_containerregistries (Data Source)

diff --git a/website/docs/d/cloud_project_containerregistry.html.markdown b/website/docs/d/cloud_project_containerregistry.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_containerregistry"
-sidebar_current: "docs-ovh-datasource-cloud-project-containerregistry-x"
-description: |-
-  Get information about a container registry associated with a public cloud project.
+subcategory : "Managed Private Registry"
 ---
 
 # ovh_cloud_project_containerregistry (Data Source)

diff --git a/website/docs/d/cloud_project_containerregistry_users.html.markdown b/website/docs/d/cloud_project_containerregistry_users.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_containerregistry_users"
-sidebar_current: "docs-ovh-datasource-cloud-project-containerregistry-users"
-description: |-
-  Get the list of users of a container registry associated with a public cloud project.
+subcategory : "Managed Private Registry"
 ---
 
 # ovh_cloud_project_containerregistry_users (Data Source)

diff --git a/website/docs/d/cloud_project_database.html.markdown b/website/docs/d/cloud_project_database.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-x"
-description: |-
-  Get information about a managed database cluster in a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database (Data Source)

diff --git a/website/docs/d/cloud_project_database_capabilities.html.markdown b/website/docs/d/cloud_project_database_capabilities.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_capabilities"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-capabilities"
-description: |-
-  Get information about capabilities of a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_capabilities (Data Source)

diff --git a/website/docs/d/cloud_project_database_certificates.html.markdown b/website/docs/d/cloud_project_database_certificates.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_certificates"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-certificates"
-description: |-
-  Get information about certificates of a cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_certificates (Data Source)

diff --git a/website/docs/d/cloud_project_database_database.html.markdown b/website/docs/d/cloud_project_database_database.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_database"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-database"
-description: |-
-  Get information about a database of a database cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_database (Data Source)

diff --git a/website/docs/d/cloud_project_database_databases.html.markdown b/website/docs/d/cloud_project_database_databases.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_databases"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-databases"
-description: |-
-  Get the list of databases of a database cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_databases (Data Source)

diff --git a/website/docs/d/cloud_project_database_integration.html.markdown b/website/docs/d/cloud_project_database_integration.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_integration"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-integration"
-description: |-
-  Get information about an integration of a database cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_integration (Data Source)

diff --git a/website/docs/d/cloud_project_database_integrations.html.markdown b/website/docs/d/cloud_project_database_integrations.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_integrations"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-integrations"
-description: |-
-  Get the list of integrations of a database cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_integrations (Data Source)

diff --git a/website/docs/d/cloud_project_database_ip_restrictions.html.markdown b/website/docs/d/cloud_project_database_ip_restrictions.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_ip_restrictions"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-ip-restrictions"
-description: |-
-  Get the list of IP restrictions associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_ip_restrictions (Data Source)

diff --git a/website/docs/d/cloud_project_database_kafka_acl.html.markdown b/website/docs/d/cloud_project_database_kafka_acl.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_kafka_acl"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-kafka-acl"
-description: |-
-  Get information about an ACL of a kafka cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_kafka_acl (Data Source)

diff --git a/website/docs/d/cloud_project_database_kafka_acls.html.markdown b/website/docs/d/cloud_project_database_kafka_acls.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_kafka_acls"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-kafka-acls"
-description: |-
-  Get the list of ACLS of a kafka cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_kafka_acls (Data Source)

diff --git a/website/docs/d/cloud_project_database_kafka_topic.html.markdown b/website/docs/d/cloud_project_database_kafka_topic.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_kafka_topic"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-kafka-topic"
-description: |-
-  Get information about a topic of a kafka cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_kafka_topic (Data Source)

diff --git a/website/docs/d/cloud_project_database_kafka_topics.html.markdown b/website/docs/d/cloud_project_database_kafka_topics.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_kafka_topics"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-kafka-topics"
-description: |-
-  Get the list of topics of a kafka cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_kafka_topics (Data Source)

diff --git a/website/docs/d/cloud_project_database_kafka_user_access.html.markdown b/website/docs/d/cloud_project_database_kafka_user_access.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_kafka_user_acces"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-kafka-user-acces"
-description: |-
-  Get information about user acces of a kafka cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_kafka_user_access (Data Source)

diff --git a/website/docs/d/cloud_project_database_m3db_namespace.html.markdown b/website/docs/d/cloud_project_database_m3db_namespace.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_m3db_namespace"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-m3db-namespace"
-description: |-
-  Get information about a namespace of a M3DB cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_m3db_namespace (Data Source)

diff --git a/website/docs/d/cloud_project_database_m3db_namespaces.html.markdown b/website/docs/d/cloud_project_database_m3db_namespaces.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_m3db_namespaces"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-m3db-namespaces"
-description: |-
-  Get the list of namespaces of a M3DB cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_m3db_namespaces (Data Source)

diff --git a/website/docs/d/cloud_project_database_m3db_user.html.markdown b/website/docs/d/cloud_project_database_m3db_user.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_m3db_user"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-m3db-user"
-description: |-
-  Get information about a user of a M3DB cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_m3db_user (Data Source)

diff --git a/website/docs/d/cloud_project_database_mongodb_user.html.markdown b/website/docs/d/cloud_project_database_mongodb_user.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_mongodb_user"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-mongodb-user"
-description: |-
-  Get information about a user of a mongodb cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_mongodb_user (Data Source)

diff --git a/website/docs/d/cloud_project_database_opensearch_pattern.html.markdown b/website/docs/d/cloud_project_database_opensearch_pattern.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_opensearch_pattern"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-opensearch-pattern"
-description: |-
-  Get information about a pattern of a opensearch cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_opensearch_pattern (Data Source)

diff --git a/website/docs/d/cloud_project_database_opensearch_patterns.html.markdown b/website/docs/d/cloud_project_database_opensearch_patterns.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_opensearch_patterns"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-opensearch-patterns"
-description: |-
-  Get the list of patterns of a opensearch cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_opensearch_patterns (Data Source)

diff --git a/website/docs/d/cloud_project_database_opensearch_user.html.markdown b/website/docs/d/cloud_project_database_opensearch_user.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_opensearch_user"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-opensearch-user"
-description: |-
-  Get information about a user of a opensearch cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_opensearch_user (Data Source)

diff --git a/website/docs/d/cloud_project_database_postgresql_user.html.markdown b/website/docs/d/cloud_project_database_postgresql_user.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_postgresql_user"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-postgresql-user"
-description: |-
-  Get information about a user of a postgresql cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_postgresql_user (Data Source)

diff --git a/website/docs/d/cloud_project_database_redis_user.html.markdown b/website/docs/d/cloud_project_database_redis_user.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_redis_user"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-redis-user"
-description: |-
-  Get information about a user of a redis cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_redis_user (Data Source)

diff --git a/website/docs/d/cloud_project_database_user.html.markdown b/website/docs/d/cloud_project_database_user.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_user"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-user"
-description: |-
-  Get information about a user of a database cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_user (Data Source)

diff --git a/website/docs/d/cloud_project_database_users.html.markdown b/website/docs/d/cloud_project_database_users.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_database_users"
-sidebar_current: "docs-ovh-datasource-cloud-project-database-users"
-description: |-
-  Get the list of users of a database cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_database_users (Data Source)

diff --git a/website/docs/d/cloud_project_databases.html.markdown b/website/docs/d/cloud_project_databases.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_databases"
-sidebar_current: "docs-ovh-datasource-cloud-project-databases"
-description: |-
-  Get the list of managed database cluster associated with a public cloud project.
+subcategory : "Managed Databases"
 ---
 
 # ovh_cloud_project_databases (Data Source)

diff --git a/website/docs/d/cloud_project_failover_ip_attach.html.markdown b/website/docs/d/cloud_project_failover_ip_attach.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_failover_ip_attach"
-sidebar_current: "docs-ovh-datasource-cloud-project-failover-ip-attach-x"
-description: |-
-  Reads failover ip addresses for a service
+subcategory : "Additional IP"
 ---
 
 # ovh_cloud_project_failover_ip_attach (Data Source)

diff --git a/website/docs/d/cloud_project_kube.html.markdown b/website/docs/d/cloud_project_kube.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_kube"
-sidebar_current: "docs-ovh-datasource-cloud-project-kube-x"
-description: |-
-  Get information & status of a Kubernetes managed cluster in a public cloud project.
+subcategory : "Managed Kubernetes Service"
 ---
 
 # ovh_cloud_project_kube (Data Source)

diff --git a/website/docs/d/cloud_project_kube_iprestrictions.html.markdown b/website/docs/d/cloud_project_kube_iprestrictions.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_kube_iprestrictions"
-sidebar_current: "docs-ovh-datasource-cloud-project-kube-iprestrictions-x"
-description: |-
-Get information & status of a Kubernetes managed cluster IP restrictions in a public cloud project.
+subcategory : "Managed Kubernetes Service"
 ---
 
 # ovh_cloud_project_kube_iprestrictions (Data Source)

diff --git a/website/docs/d/cloud_project_kube_nodepool.html.markdown b/website/docs/d/cloud_project_kube_nodepool.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_kube_nodepool"
-sidebar_current: "docs-ovh-datasource-cloud-project-kube-nodepool-x"
-description: |-
-Get information & status of a Kubernetes managed node pool in a public cloud project.
+subcategory : "Managed Kubernetes Service"
 ---
 
 # ovh_cloud_project_kube_nodepool (Data Source)

diff --git a/website/docs/d/cloud_project_kube_nodepool_nodes.html.markdown b/website/docs/d/cloud_project_kube_nodepool_nodes.html.markdown
@@ -1,9 +1,5 @@
 ---
-layout: "ovh"
-page_title: "OVH: cloud_project_kube_nodepool_nodes"
-sidebar_current: "docs-ovh-datasource-cloud-project-kube-nodepool-nodes-x"
-description: |-
-Get information & status of a Kubernetes managed nodes of a specific node pool in a public cloud project.
+subcategory : "Managed Kubernetes Service"
 ---
 
 # ovh_cloud_project_kube_nodepool_nodes (Data Source)