[DOCS] 'preflight checks' incomplete info

Bug #1645297 reported by Alexandra Settle
This bug affects 1 person
Affects Status Importance Assigned to Milestone

Bug Description

This section assumes that users know what preflight checks are and how to run them.
Should we assume that? Probably not.
I recommend we provide more instructions or a reference to more information.

The language has had a minor update here: https://review.openstack.org/#/c/403646/1/doc/source/upgrade-guide/manual-upgrade.rst

But a few things still need to be addressed:
- “starting with the new version”: starting what with the new version? (I revised to say 'upgraded version to clarify, but this still applies... is this correct?)
- “everything is fine”: what do we mean by everything and fine? (I revised to say 'stable', but we should find a way to appropriately define this)
- “the upgrade should stop”: should makes this is ambiguous. Does the upgrade stop? Does the user
need to stop it?

Revision history for this message
Jean-Philippe Evrard (jean-philippe-evrard) wrote :

I see https://review.openstack.org/#/c/403646/ is still open, why won't we discuss this there?

Revision history for this message
Jean-Philippe Evrard (jean-philippe-evrard) wrote :

If this bug is about clarification, maybe we should have more reviewers on the commit mentioned above.

But yes, this can be unclear and needs to be clarified.

Could you, in your review, also mention this bug? Ty.

Revision history for this message
Alexandra Settle (alexandra-settle) wrote :

JP - I can mention the bug in my review, for sure.

But the editorial patch that is currently up is simply that, it is edits. This bug is in reference to a new section.

I would not like to merge the two if possible.

Changed in openstack-ansible:
status: New → Confirmed
importance: Undecided → Medium
Revision history for this message
Jean-Philippe Evrard (jean-philippe-evrard) wrote :
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers