Skip to content

Fix downgrade documentation #1048

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
May 27, 2025
Merged

Fix downgrade documentation #1048

merged 4 commits into from
May 27, 2025
+91 −18

Conversation

jovatn
Copy link
Contributor

@jovatn jovatn commented May 16, 2025

Description

Recent documentation additions on upgrade/downgrade (#1009) did not properly describe how to best perform a downgrade. In particular, it is best to store a startup config before upgrading, and use that when downgrading

No changelog updates needed

Checklist

Tick relevant boxes, this PR is-a or has-a:

  • Bugfix
    • Regression tests
    • ChangeLog updates (for next release)
  • Feature
    • YANG model change => revision updated?
    • Regression tests added?
    • ChangeLog updates (for next release)
    • Documentation added?
  • Test changes
    • Checked in changed Readme.adoc (make test-spec)
    • Added new test to group Readme.adoc and yaml file
  • Code style update (formatting, renaming)
  • Refactoring (please detail in commit messages)
  • Build related changes
  • Documentation content changes
    • ChangeLog updated (for major changes)
  • Other (please describe):

jovatn added 2 commits May 15, 2025 13:00
@jovatn
Add link to netbooting howto from boot doc
d5e96a8 
[skip ci]
@jovatn
Update downgrade doc to recommend explicitly store/use backup cfg
e5299ff 
- relying on config version and files backed up during
  configuration is not enough.
- storing a configuration file before upgrading, to be used
  when downgrading, is more reliable.

[skip ci]
@jovatn jovatn requested a review from troglobit May 16, 2025 10:57
@jovatn jovatn requested review from rical and removed request for troglobit May 26, 2025 07:13
axkar
axkar reviewed May 26, 2025
View reviewed changes
Copy link
Collaborator

@axkar axkar left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks nice and clear to me.
One thing to change in system.md:

[6]: boot.md#system-configuration.

Change to:
[6]: netbooting.md.

jovatn and others added 2 commits May 26, 2025 16:20
@jovatn
Merge branch 'main' into fix-downgrade-documentation
c7c01e3
@jovatn
Update downgrade doc to recommend explicitly store/use backup cfg
9c3e951 
- relying on config version and files backed up during
  configuration is not enough.
- storing a configuration file before upgrading, to be used
  when downgrading, is more reliable.

[skip ci]
@jovatn jovatn requested review from axkar and mattiaswal and removed request for rical May 27, 2025 06:10
axkar
axkar approved these changes May 27, 2025
View reviewed changes
Copy link
Collaborator

@axkar axkar left a comment

Choose a reason for hiding this comment

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

Great work!

@mattiaswal mattiaswal merged commit b888419 into main May 27, 2025
@mattiaswal mattiaswal deleted the fix-downgrade-documentation branch May 27, 2025 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattiaswal mattiaswal mattiaswal approved these changes

@axkar axkar axkar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jovatn @mattiaswal @axkar