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

reconfigure docs for better ordering #417

Merged
merged 2 commits into from
Oct 25, 2023

Conversation

bwJuniper
Copy link
Collaborator

added constants to categorize resources and data sources by apstra UI category.
modified Markdown Descriptions for resource and data source to add subcategory information.
modified tfplugindocs.sh to make sure that there is a category check.

used this for template construction : hashicorp/terraform-plugin-docs#156

closes #415

@bwJuniper bwJuniper added the documentation Improvements or additions to documentation label Oct 25, 2023
@bwJuniper bwJuniper self-assigned this Oct 25, 2023
@bwJuniper bwJuniper linked an issue Oct 25, 2023 that may be closed by this pull request
Copy link
Collaborator

@chrismarget-j chrismarget-j left a comment

Choose a reason for hiding this comment

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

Found some things I think are miscategorized.

Some of those are a little ambiguous: Maybe they work equally well in freeform?

If that turns out to be true, we'll need to deprecate the whole resource and rename them from apstra_datacenter_whatever to apstra_blueprint_whatever, so I'm inclined to lean into the current maybe-error and categorize them consistent with their datacenter name.

apstra/data_source_blueprint_deployment.go Outdated Show resolved Hide resolved
apstra/data_source_blueprint_iba_dashboard.go Outdated Show resolved Hide resolved
apstra/data_source_datacenter_blueprint.go Outdated Show resolved Hide resolved
apstra/data_source_datacenter_property_sets.go Outdated Show resolved Hide resolved
apstra/data_source_interface_map.go Outdated Show resolved Hide resolved
apstra/data_source_property_sets.go Outdated Show resolved Hide resolved
apstra/resource_configlet.go Show resolved Hide resolved
apstra/resource_datacenter_device_allocation.go Outdated Show resolved Hide resolved
apstra/resource_datacenter_resource_pool_allocation.go Outdated Show resolved Hide resolved
apstra/resource_modular_device_profile.go Outdated Show resolved Hide resolved
@chrismarget-j
Copy link
Collaborator

I'm excited about this change!

@bwJuniper bwJuniper merged commit 74194d2 into main Oct 25, 2023
1 check failed
@bwJuniper bwJuniper deleted the 415-reconfigure-provider-documentation branch October 25, 2023 22:42
@chrismarget-j chrismarget-j restored the 415-reconfigure-provider-documentation branch October 25, 2023 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Reconfigure Provider Documentation
2 participants