Merged "add / update resource" docs into a single guide (#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
GoogleCloudPlatform · Jun 30, 2023 · 8fbb9b5 · 8fbb9b5
1 parent 5aa501d
commit 8fbb9b5
Show file tree

Hide file tree

Showing 16 changed files with 570 additions and 1,147 deletions.
diff --git a/docs/content/develop/add-handwritten-datasource-documentation.md b/docs/content/develop/add-handwritten-datasource-documentation.md
@@ -1,13 +1,13 @@
 ---
-title: "Add documentation for a handwritten data source"
+title: "Add datasource documentation"
 summary: "New handwritten datasources require new handwritten documentation to be created."
-weight: 25
+weight: 61
 aliases:
   - /docs/how-to/add-handwritten-datasource-documentation
   - /how-to/add-handwritten-datasource-documentation
 ---
 
-# Add documentation for a handwritten data source
+# Add data source documentation
 
 {{< hint info >}}
 **Note:** If you want to find information about documentation for a generated resource, look at the [MMv1 resource documentation](/magic-modules/docs/how-to/mmv1-resource-documentation) page instead. The information on this page will not be relevant for resources that have generated documentation.

diff --git a/docs/content/develop/add-handwritten-datasource.md b/docs/content/develop/add-handwritten-datasource.md
@@ -1,13 +1,13 @@
 ---
-title: "Add a handwritten datasource"
+title: "Add a datasource"
 summary: "Datasources are like terraform resources except they don't *create* anything."
-weight: 22
+weight: 60
 aliases:
   - /docs/how-to/add-handwritten-datasource
   - /how-to/add-handwritten-datasource
 ---
 
-# Add a handwritten datasource
+# Add a datasource
 
 **Note:** only handwritten datasources are currently supported
 

diff --git a/docs/content/develop/add-handwritten-iam.md b/docs/content/develop/add-handwritten-iam.md
diff --git a/docs/content/develop/add-handwritten-test.md b/docs/content/develop/add-handwritten-test.md
@@ -2,7 +2,7 @@
 title: "Add a handwritten test"
 summary: "For handwritten resources and generated resources that need to test update,
 handwritten tests must be added."
-weight: 21
+weight: 41
 aliases:
   - /docs/how-to/add-handwritten-test
   - /how-to/add-handwritten-test

diff --git a/docs/content/develop/add-mmv1-iam.md b/docs/content/develop/add-mmv1-iam.md