Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VAULT-18334: Documentation Subcategories #585

Merged
merged 27 commits into from
Sep 26, 2023
Merged

Conversation

dhuckins
Copy link
Contributor

@dhuckins dhuckins commented Aug 30, 2023

🛠️ Description

Updating docs to use sub-categories

  • resources/data-sources that already had templates were updated
  • resources/data-sources that did not have a template, had a template created
Name Subcategory
hcp_aws_network_peering HashiCorp Virtual Networks
hcp_aws_transit_gateway_attachment HashiCorp Virtual Networks
hcp_azure_peering_connection HashiCorp Virtual Networks
hcp_boundary_cluster HCP Boundary
hcp_consul_agent_helm_config HCP Consul
hcp_consul_agent_kubernetes_secret HCP Consul
hcp_consul_cluster HCP Consul
hcp_consul_cluster_root_token HCP Consul
hcp_consul_snapshot HCP Consul
hcp_consul_versions HCP Consul
hcp_hvn HashiCorp Virtual Networks
hcp_hvn_peering_connection HashiCorp Virtual Networks
hcp_hvn_route HashiCorp Virtual Networks
hcp_packer_bucket_names HCP Packer
hcp_packer_channel HCP Packer
hcp_packer_channel_assignment HCP Packer
hcp_packer_image HCP Packer
hcp_packer_image_iteration HCP Packer
hcp_packer_iteration HCP Packer
hcp_packer_run_task HCP Packer
hcp_vault_cluster HCP Vault
hcp_vault_cluster_admin_token HCP Vault
hcp_vault_secrets_app HCP Vault Secrets

@lvedavyas lvedavyas requested a review from a team September 21, 2023 18:05
@dhuckins dhuckins marked this pull request as ready for review September 21, 2023 18:27
@dhuckins dhuckins requested review from a team as code owners September 21, 2023 18:27
@aidan-mundy aidan-mundy changed the title Vault 18334/docs subcategories VAULT-18334: Documentation Subcategories Sep 21, 2023
Copy link
Contributor

@aidan-mundy aidan-mundy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

I'd be interested to see if there is a way to automate this and reduce the number of template files, especially with the new folder structure for Framework-written resources/datasources that will mirror the categories used here. We could create our own custom root-level template that automatically handles the category for Framework resources.

@AnPucel
Copy link
Contributor

AnPucel commented Sep 21, 2023

Just a small thing. I'm seeing the data sources for Vault Secrets, but not the resources for Vault Secrets in here.

Copy link
Contributor

@riddhi89 riddhi89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dhuckins
Copy link
Contributor Author

Just a small thing. I'm seeing the data sources for Vault Secrets, but not the resources for Vault Secrets in here.

nice catch!

Copy link
Contributor

@jaireddjawed jaireddjawed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dhuckins dhuckins merged commit e39f470 into main Sep 26, 2023
6 checks passed
@dhuckins dhuckins deleted the VAULT-18334/docs-subcategories branch September 26, 2023 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants