Merged "add / update resource" docs into a single guide#8193
Merged
Conversation
rileykarson
reviewed
Jun 23, 2023
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
Collaborator
Tests analyticsTotal tests: Action takenFound 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected testsTestAccComputeNetworkEndpoints_networkEndpointsBasic|TestAccComputeFirewallPolicyRule_multipleRules |
Collaborator
|
Tests passed during RECORDING mode: Tests failed during RECORDING mode: Please fix these to complete your PR |
rileykarson
approved these changes
Jun 26, 2023
Member
Author
|
I'm going ahead with merging this for now, since it sounds like the remaining thread is not a blocker (because it is approved) but definitely let me know if there are any additional changes that need to be made. |
5 tasks
ericayyliu
pushed a commit
to ericayyliu/magic-modules
that referenced
this pull request
Jul 26, 2023
…latform#8193) * Created add a resource page with template yaml and migrated some content to it * Temporary checkpoint for docs improvements * Added / renamed reference links * Finalized add-a-resource doc * Reverted test docs changes and cleaned up navigation * Removed change to how magic modules works * Renamed guide to include modifying * Reverted unrelated file deletion * Switched to multiline for docs warning & note * Clarified when field value replacement will happen * Standardized resource URL descriptions on language used in AIPs * Cleaned up boolean field descriptions * Clarified that field-level update_verb only has impact if update_url is set * Clarified the drawbacks of default_from_api. * Softened language around when new handwritten resources would be accepted * Added back required (but unused) async configuration * Switched to name rather than resource id * Clarified what triggers a handwritten resource being allowed * Added steps to clean up comments copied from templates in configuration files * Cleaned up descriptions related to default_from_api and usage of 'will' https://developers.google.com/style/tense
wj-chen
pushed a commit
to wj-chen/magic-modules
that referenced
this pull request
Aug 1, 2023
…latform#8193) * Created add a resource page with template yaml and migrated some content to it * Temporary checkpoint for docs improvements * Added / renamed reference links * Finalized add-a-resource doc * Reverted test docs changes and cleaned up navigation * Removed change to how magic modules works * Renamed guide to include modifying * Reverted unrelated file deletion * Switched to multiline for docs warning & note * Clarified when field value replacement will happen * Standardized resource URL descriptions on language used in AIPs * Cleaned up boolean field descriptions * Clarified that field-level update_verb only has impact if update_url is set * Clarified the drawbacks of default_from_api. * Softened language around when new handwritten resources would be accepted * Added back required (but unused) async configuration * Switched to name rather than resource id * Clarified what triggers a handwritten resource being allowed * Added steps to clean up comments copied from templates in configuration files * Cleaned up descriptions related to default_from_api and usage of 'will' https://developers.google.com/style/tense
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
See go/tpg-contribution-docplan for more details. These changes expect that #8188 is merged (which expands the "How Magic Modules works" page to include more information about directory structures.)
The main changes are:
There is some information related to tests which was "lost" in this rewrite which will be re-added in a separate PR that merges pages related to MMv1 and handwritten tests.
I also chose to exclude some information related to less commonly-used fields which I plan for us to re-add as part of an advanced guide, best practices guide, or comprehensive reference in the future.
Resolved hashicorp/terraform-provider-google#12657. Resolved hashicorp/terraform-provider-google#12648. Resolved hashicorp/terraform-provider-google#12408. Resolved hashicorp/terraform-provider-google#12396. b/284469519 b/261500389
Add or modify a resource
MMv1
Handwritten
Promote to GA
MMv1
Handwritten:
Release Note Template for Downstream PRs (will be copied)