Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

Document the 'maintenance' sub command #24

Open
jessereynolds opened this issue Jul 13, 2015 · 0 comments
Open

Document the 'maintenance' sub command #24

jessereynolds opened this issue Jul 13, 2015 · 0 comments

Comments

@jessereynolds
Copy link
Member

As far as I can tell the only documentation of the maintenance subcommand is in the online help.

From 1.6.0:

$ flapjack maintenance --help
NAME
    maintenance - Show, create and delete maintenance windows

SYNOPSIS
    flapjack [global options] maintenance create [--check arg|-c arg] [--duration arg|-d arg] [--entity arg|-e arg] [--reason arg|-r arg] [--start arg|--started arg|--starting arg|-s arg] [--type arg|-t arg]
    flapjack [global options] maintenance delete [--apply arg|-a arg] [--check arg|-c arg] [--duration arg|-d arg] [--entity arg|-e arg] [--finish arg|--finished arg|--finishing arg|--remain arg|--remained arg|--remaining arg|--end arg|-f arg] [--reason arg|-r arg] [--start arg|--started arg|--starting arg|-s arg] [--state arg|--st arg] [--type arg|-t arg]
    flapjack [global options] maintenance show [--check arg|-c arg] [--duration arg|-d arg] [--entity arg|-e arg] [--finish arg|--finished arg|--finishing arg|--remain arg|--remained arg|--remaining arg|--end arg|-f arg] [--reason arg|-r arg] [--start arg|--started arg|--starting arg|-s arg] [--state arg|--st arg] [--type arg|-t arg]

COMMANDS
    show   - Show maintenance windows according to criteria (default: all ongoing maintenance)
    delete - Delete maintenance windows according to criteria (default: all ongoing maintenance)
    create - Create a maintenance window

We should add a page to the Using section on flapjack.io/docs about how to use this most useful command line function with some handy examples such as 'show all maintenances ending in the next 12 hours'

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant