provider/aws docs: Mark ForceNew fields, note about description #5375
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
The `description` field is easy to confuse for a nice field to add an arbitrary comment to - and it's surprising that changes to this field force a new resource, so we add a big note about it to point users at tags. Also marked all the other ForceNew attributes on this resource.
|
Nice addition! I think ForceNew should really be added to all docs over time - it's very useful to know what changes do! |
|
Totally agreed - I was actually surprised that we didn't have them in the docs - I'm so used to looking at the schema in code where it's right there. 🙈 I know @jen20 has some spikes at doc generation which would take care of this as a general problem. |
phinze
added a commit
that referenced
this pull request
Feb 29, 2016
provider/aws docs: Mark ForceNew fields, note about description
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The
descriptionfield is easy to confuse for a nice field toadd an arbitrary comment to - and it's surprising that changes to this
field force a new resource, so we add a big note about it to point users
at tags.
Also marked all the other ForceNew attributes on this resource.