Added "Documentation" feature #25
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -0,0 +1,24 @@ | |||
| terraform { | |||
There was a problem hiding this comment.
Why hw_documentation ? It's not specific to Hardware
Existing convention would make it examples/resources/documentation_resource/resource.tf
There was a problem hiding this comment.
This is addressed in the latest commit. Thanks
hughwphamill
requested changes
Sep 28, 2023
|
|
||
| resource "dcloud_topology" "test_topology" { | ||
| name = "My Terraformed Topology" | ||
| description = "A topology created from terraform" |
There was a problem hiding this comment.
Convention on the other resource .tf files is to use these sort of values for the test topology...
resource "dcloud_topology" "test_topology" {
name = "Documentation Resource Test"
description = "Testing Topology Documentation Resource Management"
notes = "Created via Terraform Test"
datacenter = "LON"
}There was a problem hiding this comment.
Hi Hugh,
Done.
Provided the changes in the commit.
Thanks.
…anged topology values in resource.tf, changed resoruce name from documentation to test_documentation
hughwphamill
approved these changes
Sep 28, 2023
philipowen
approved these changes
Sep 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The documentation feature helps us provide a URL for documentation of the specific topology deployed on TB.
This PR implements that feature. The following modifications have been made:
Modified "provider.go": Added a mapping to "resource_documentation.go"
Created "resource.documentation.go": Supports CRUD operations of the documentation resource.
Modified /examples/provider/provider.tf: Added a documentation resource that assigns the provided URL to the topology.
Created /examples/hw_documentation/resource.tf: resource.tf script that creates a topology and assigns the documentation URL.
Added docs/resources/documentation.md: Specifying the schema of the documentation resource.
Type of Change
Checklist