[pve-devel] [PATCH docs 1/1] add docs for maintenance mode buttons in UI

[Thomas Skinner]

On Tue, Aug 26, 2025 at 4:44 AM Daniel Kral <d.kral at proxmox.com> wrote:
>
> On Mon Aug 25, 2025 at 6:11 AM CEST, Thomas Skinner wrote:
> > Signed-off-by: Thomas Skinner <thomas at atskinner.net>
> > ---
> >  ha-manager.adoc | 21 +++++++++++++++++++++
> >  1 file changed, 21 insertions(+)
> >
> > diff --git a/ha-manager.adoc b/ha-manager.adoc
> > index f16cfbb..b41a73b 100644
> > --- a/ha-manager.adoc
> > +++ b/ha-manager.adoc
> > @@ -1115,7 +1115,19 @@ maintenance mode is disabled and the node is back online.
> >  Currently you can enabled or disable the maintenance mode using the ha-manager
> >  CLI tool.
> >
> > +Maintenance mode can be enabled or disabled using the buttons on the HA pane in
> > +the {pve} web UI or by using the ha-manager CLI tool.
>
> s/pane/panel/?
>
> I understand that pane might be more correct here, but I'd guess that
> users are more familiar with 'panel' here.

Yep, that makes sense to me. Will fix up for a v2 patch.

> Also, I think it would be nicer to integrate that into the former
> sentence, for example:
>
> Currently you can enabled or disable the maintenance mode in the HA
> status panel in the web UI or using the ha-manager CLI tool.

I actually meant for that one to be gone and replaced with the added
sentence instead. I must've missed the removal on my local branch
patch application. Is the replacement sentence okay or should it be
removed and the existing sentence updated?

> > +
> >  .Enabling maintenance mode for a node
> > +
> > +_Using the web UI_
> > +
> > +Navigate to the Datacenter view, then select HA from the menu to show the HA
> > +Status pane. Select the lrm node that you want to enable maintenance mode for,
> > +then click the Enable Maintenance Mode button from the toolbar.
> > +
> > +_Using the CLI_
> > +
> >  ----
> >  # ha-manager crm-command node-maintenance enable NODENAME
> >  ----
> > @@ -1142,6 +1154,15 @@ but only if it is either manually deactivated using the `ha-manager` CLI or if
> >  the manager-status is manually cleared.
> >
> >  .Disabling maintenance mode for a node
> > +
> > +_Using the web UI_
> > +
> > +Navigate to the Datacenter view, then select HA from the menu to show the HA
> > +Status pane. Select the lrm node that you want to disable maintenance mode for,
> > +then click the Disable Maintenance Mode button from the toolbar.
> > +
> > +_Using the CLI_
> > +
> >  ----
> >  # ha-manager crm-command node-maintenance disable NODENAME
> >  ----
>
>