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

ug: offline-update: Adjustments in return codes documentation #711

Merged
merged 3 commits into from
Jun 7, 2024

Conversation

detsch
Copy link
Member

@detsch detsch commented Jun 3, 2024

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@doanac
Copy link
Member

doanac commented Jun 3, 2024

Copy link
Contributor

@mike-scott mike-scott left a comment

Choose a reason for hiding this comment

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

LGTM

@mike-sul mike-sul requested a review from kprosise June 4, 2024 08:31
@@ -161,6 +161,8 @@ The ``install`` command sets the following exit codes:
- Reboot is required to complete installation. After reboot ``aklite-offline run`` must be invoked.
- *101*: Installation succeeded.
- Restart of dockerd service is required to complete installation, e.g. ``systemctl restart docker``. After the restart ``aklite-offline run`` must be invoked.
- *102*: Downgrade attempt.
- The Target to be installed has a version lower than the one that is running. The ``--force`` option can be used to force its installation.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- The Target to be installed has a version lower than the one that is running. The ``--force`` option can be used to force its installation.
- The Target to be installed has a version lower than the one running. Use the ``--force`` option to force its installation.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks, I've applied the suggested change.

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

One optional suggestion, otherwise it LGTM.

This value is not returned anymore.

Signed-off-by: Andre Detsch <[email protected]>
Mention that a new `aklite-offline run` call is required after reboot.

Signed-off-by: Andre Detsch <[email protected]>
@doanac
Copy link
Member

doanac commented Jun 4, 2024

@detsch detsch changed the title ug: offline-update: Add return code for downgrade attempt ug: offline-update: Adjustments in return codes documentation Jun 4, 2024
@detsch detsch force-pushed the detsch-add-offline-downgrade-code branch from 9b4a87f to ec552b2 Compare June 4, 2024 12:56
@doanac
Copy link
Member

doanac commented Jun 4, 2024

@detsch
Copy link
Member Author

detsch commented Jun 4, 2024

@kprosise @mike-scott I've added two additional small changes to the PR

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@mike-scott mike-scott left a comment

Choose a reason for hiding this comment

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

LGTM

@kprosise kprosise merged commit 8439113 into foundriesio:main Jun 7, 2024
2 of 3 checks passed
@detsch detsch deleted the detsch-add-offline-downgrade-code branch June 25, 2024 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants