Fix backend/swift docs #19007
Fix backend/swift docs #19007
Conversation
|
ping @tombuildsstuff since you marked up the issue I reported. This PR fixes that. |
|
Also ping @mildwonkey since I see you review docs PRs often. |
cardoe
force-pushed
the
fix-swift-backend-docs
branch
from
732b925
to
962d130
Compare
Update the examples and docs to not directly reference deprecated fields.
The links to the OpenStack Swift documentation were broken due to changes on the OpenStack website.
Provide a link to the OpenStack Swift docs for the object expiration feature that is used by the `expire_after` field.
The displayed link said `expire_after` but really is a link to `archive_container` so update the link to read the right data. fixes hashicorp#19005
Since object versioning is a best practice the docs should have all the examples containing it by default.
If the user uses the auto-expire value in the backend/swift settings then swift will automatically delete their Statefile which is likely something the user doesn't want given how Terraform works.
cardoe
force-pushed
the
fix-swift-backend-docs
branch
from
513f6db
to
49c42b9
Compare
|
I've rebased it to hopefully make merging this easier. @radeksimko I'd appreciate some comments. The documentation on the website will literally delete tfstate for OpenStack backend users. |
|
Any special trick that needs to get done to get the website to re-render the docs? |
|
I can make a PR against branch v0.11 |
Fix backend/swift docs (cherry picked from commit 1be0974)
Fix backend/swift docs (cherry picked from commit 1be0974)
|
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. |
The docs contained an error telling people to use
expire_afterwhen they really wanted object versioning. This error is actually quite damaging because instead of not even retaining versions of the state, it is outright deleted after a given amount of time. Fixed up the examples and other bits to not use deprecated items. Fixed bad links to the OpenStack Swift project. Added more links to the OpenStack Swift project. fixes #19005