Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document upgrade backup files #2275

Merged
merged 6 commits into from
Aug 23, 2023
Merged

docs: document upgrade backup files #2275

merged 6 commits into from
Aug 23, 2023

Conversation

msanft
Copy link
Contributor

@msanft msanft commented Aug 23, 2023

Context

Upgrade backup files previously were undocumented, possibly leaving a user confused on what to do with these files.

Proposed change(s)

  • Document that backup files are created, and briefly state what they can be used for. (I'm unsure about the wording here; It's unlikely that an upgrade destroys CRs, but not impossible. How should we best state this in the docs?)

Checklist

  • Add labels (e.g., for changelog category)
  • Is PR title adequate for changelog?
  • Link to Milestone

Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com>
@msanft msanft added the documentation Improvements or additions to documentation label Aug 23, 2023
@msanft msanft added this to the v2.11.0 milestone Aug 23, 2023
@msanft msanft requested a review from thomasten as a code owner August 23, 2023 07:15
@netlify
Copy link

netlify bot commented Aug 23, 2023

Deploy Preview for constellation-docs ready!

Name Link
🔨 Latest commit 4ffb74e
🔍 Latest deploy log https://app.netlify.com/sites/constellation-docs/deploys/64e5bf3d47eb4200089e298f
😎 Deploy Preview https://deploy-preview-2275--constellation-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

msanft and others added 3 commits August 23, 2023 09:36
Co-authored-by: Otto Bittner <cobittner@posteo.net>
Co-authored-by: Otto Bittner <cobittner@posteo.net>
Co-authored-by: Otto Bittner <cobittner@posteo.net>
Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>
@msanft msanft merged commit 49e5a17 into main Aug 23, 2023
11 of 12 checks passed
@msanft msanft deleted the feat/docs/upgrade-backups branch August 23, 2023 19:22
msanft added a commit that referenced this pull request Sep 1, 2023
* document backup files on upgrade

Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com>

* reword TF backup

* Update docs/docs/workflows/upgrade.md

Co-authored-by: Otto Bittner <cobittner@posteo.net>

* Update docs/docs/workflows/upgrade.md

Co-authored-by: Otto Bittner <cobittner@posteo.net>

* Update docs/docs/workflows/upgrade.md

Co-authored-by: Otto Bittner <cobittner@posteo.net>

* Update upgrade.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

---------

Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com>
Co-authored-by: Otto Bittner <cobittner@posteo.net>
Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants