Skip to content

docs: more specific backup target docs #816

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

m-ildefons
Copy link
Contributor

@m-ildefons m-ildefons commented Jul 7, 2025

Add more specific docs for configuring the backup target.

This commit includes screenshots as examples, parameter explanations for both S3 and NFS type backup targets and an explanation for the refresh interval parameter.

related-to: harvester/harvester#7976

Problem:

The refresh interval parameter for the backup target has some subtle and until now undocumented behaviors.
Additionally, the entire configuration dialogue for the backup target could be documented in greater detail.

Solution:

Add more detailed explanations for the backup target configuration, including screenshots showing examples and including all options.

Screenshot at 2025-07-07 12-04-54

Related Issue(s):

harvester/harvester#7976

@m-ildefons m-ildefons self-assigned this Jul 7, 2025
@m-ildefons m-ildefons added the documentation Improvements or additions to documentation label Jul 7, 2025
@github-actions github-actions bot requested a review from akashraj4261 July 7, 2025 10:03
Copy link

github-actions bot commented Jul 7, 2025

Name Link
🔨 Latest commit 5a3319d
😎 Deploy Preview https://6874a7a9d1c0f973284ae662--harvester-preview.netlify.app

Copy link
Contributor

@jillian-maroket jillian-maroket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review done.

I have major concerns about the text in the UI screenshots. It must be very clear that the backupstore stores backups, while the backup target is the endpoint used to access the backupstore. What exactly is the user configuring here?

Copy link
Contributor

@jillian-maroket jillian-maroket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions were missed. Also, can you confirm that these changes apply only to the v1.6 doc?

Add more specific docs for configuring the backup target.

This commit includes screenshots as examples, parameter explanations
for both S3 and NFS type backup targets and an explanation for the
refresh interval parameter.

related-to: harvester/harvester#7976

Signed-off-by: Moritz Röhrich <[email protected]>
Signed-off-by: Moritz Röhrich <[email protected]>
Signed-off-by: Moritz Röhrich <[email protected]>
@m-ildefons
Copy link
Contributor Author

These changes apply to the v1.6 docs only at the moment.
Each minor Harvester release gets its own docs version by copying the docs/ directory to versioned_docs/version-* and adjusting the docusaurus config.

Copy link
Contributor

@jillian-maroket jillian-maroket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I asked about versions because the v1.5 doc has the same table.

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.

2 participants