Skip to content

Commit

Permalink
Merge pull request #235 from equinix/help-docs-hacking
Browse files Browse the repository at this point in the history
Rework of short and long fields
  • Loading branch information
displague authored Dec 1, 2022
2 parents adfd52d + 1c42279 commit 5d35a69
Show file tree
Hide file tree
Showing 88 changed files with 138 additions and 138 deletions.
34 changes: 17 additions & 17 deletions docs/metal.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,26 @@ Command line interface for Equinix Metal

### SEE ALSO

* [metal 2fa](metal_2fa.md) - Two-factor Authentication operations. More information is available at https://metal.equinix.com/developers/docs/accounts/two-factor-authentication/.
* [metal capacity](metal_capacity.md) - Capacity operations. For more information on capacity in metros, visit https://metal.equinix.com/developers/docs/locations/metros/. For more information on capacity in facilities, visit https://metal.equinix.com/developers/docs/locations/facilities/.
* [metal 2fa](metal_2fa.md) - Two-factor Authentication operations: receive, enable, disable.
* [metal capacity](metal_capacity.md) - Capacity operations: get, check
* [metal completion](metal_completion.md) - Generates completion scripts.
* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.
* [metal docs](metal_docs.md) - Generate command markdown documentation.
* [metal emdocs](metal_emdocs.md) - Generates single-page reference documentation.
* [metal env](metal_env.md) - Prints or generates environment variables.
* [metal event](metal_event.md) - Events operations for organizations, projects, devices, and the current user.
* [metal facilities](metal_facilities.md) - Facility operations. For more information on Equinix Metal facilities, visit https://metal.equinix.com/developers/docs/locations/facilities/.
* [metal gateway](metal_gateway.md) - Metal Gateways. For more information on Metal Gateways, visit https://metal.equinix.com/developers/docs/networking/metal-gateway/.
* [metal hardware-reservation](metal_hardware-reservation.md) - Hardware reservation operations. Information on reserving hardware on Equinix Metal is available on https://metal.equinix.com/developers/docs/deploy/reserved/.
* [metal event](metal_event.md) - Events operations: get.
* [metal facilities](metal_facilities.md) - Facility operations: get.
* [metal gateway](metal_gateway.md) - Metal Gateway operations: create, delete, and retrieve.
* [metal hardware-reservation](metal_hardware-reservation.md) - Hardware reservation operations: get, move.
* [metal init](metal_init.md) - Create a configuration file.
* [metal ip](metal_ip.md) - IP address and subnet operations. For more information on IP addresses, subnets, and IP address reservations, visit https://metal.equinix.com/developers/docs/networking/ip-addresses/.
* [metal metros](metal_metros.md) - Metro operations. For more information on Equinix Metal metros and availability, visit https://metal.equinix.com/developers/docs/locations/metros/.
* [metal operating-systems](metal_operating-systems.md) - Operating system operations. For more information on which operating systems Equinix Metal offers, visit https://metal.equinix.com/developers/docs/operating-systems/supported/.
* [metal organization](metal_organization.md) - Organization operations. For more information on Equinix Metal organizations, visit https://metal.equinix.com/developers/docs/accounts/organizations/.
* [metal plan](metal_plan.md) - Plan operations. For more information on the different Equinix Metal plans, visit https://metal.equinix.com/developers/docs/servers/server-specs/.
* [metal port](metal_port.md) - Port operations. For more information on the different Equinix Metal ports and VLANs, visit https://metal.equinix.com/developers/docs/layer2-networking/overview/.
* [metal project](metal_project.md) - Project operations. For more information on Equinix Metal Projects, visit https://metal.equinix.com/developers/docs/accounts/projects/.
* [metal ssh-key](metal_ssh-key.md) - SSH key operations. For more information on SSH keys, visit https://metal.equinix.com/developers/docs/accounts/ssh-keys/ in the Equinix Metal documentation.
* [metal user](metal_user.md) - User operations. For more information on user and account management, visit https://metal.equinix.com/developers/docs/accounts/users/ in the Equinix Metal documentation.
* [metal virtual-network](metal_virtual-network.md) - Virtual network (VLAN) operations. For more information on how VLANs work in Equinix Metal, visit https://metal.equinix.com/developers/docs/layer2-networking/vlans/.
* [metal ip](metal_ip.md) - IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.
* [metal metros](metal_metros.md) - Metro operations: get.
* [metal operating-systems](metal_operating-systems.md) - Operating system operations: get.
* [metal organization](metal_organization.md) - Organization operations: create, get, update, payment-methods, and delete.
* [metal plan](metal_plan.md) - Plan operations: get.
* [metal port](metal_port.md) - Port operations: get, convert, vlans.
* [metal project](metal_project.md) - Project operations: create, get, update, delete, and bgpenable, bgpconfig, bgpsessions.
* [metal ssh-key](metal_ssh-key.md) - SSH key operations: create, get, update, and delete.
* [metal user](metal_user.md) - User operations: get and add.
* [metal virtual-network](metal_virtual-network.md) - Virtual network (VLAN) operations : create, get, delete.

4 changes: 2 additions & 2 deletions docs/metal_2fa.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## metal 2fa

Two-factor Authentication operations. More information is available at https://metal.equinix.com/developers/docs/accounts/two-factor-authentication/.
Two-factor Authentication operations: receive, enable, disable.

### Synopsis

Two-factor Authentication operations: receive, enable, disable.
Enable or disable two-factor authentication on your user account or receive an OTP token. More information is available at https://metal.equinix.com/developers/docs/accounts/users/#multi-factor-authentication.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/metal_2fa_disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ metal 2fa disable (-a | -s) --code <OTP_code> [flags]

### SEE ALSO

* [metal 2fa](metal_2fa.md) - Two-factor Authentication operations. More information is available at https://metal.equinix.com/developers/docs/accounts/two-factor-authentication/.
* [metal 2fa](metal_2fa.md) - Two-factor Authentication operations: receive, enable, disable.

2 changes: 1 addition & 1 deletion docs/metal_2fa_enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ metal 2fa enable (-s | -a) --code <OTP_code> [flags]

### SEE ALSO

* [metal 2fa](metal_2fa.md) - Two-factor Authentication operations. More information is available at https://metal.equinix.com/developers/docs/accounts/two-factor-authentication/.
* [metal 2fa](metal_2fa.md) - Two-factor Authentication operations: receive, enable, disable.

2 changes: 1 addition & 1 deletion docs/metal_2fa_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ metal 2fa receive (-s | -a) [flags]

### SEE ALSO

* [metal 2fa](metal_2fa.md) - Two-factor Authentication operations. More information is available at https://metal.equinix.com/developers/docs/accounts/two-factor-authentication/.
* [metal 2fa](metal_2fa.md) - Two-factor Authentication operations: receive, enable, disable.

4 changes: 2 additions & 2 deletions docs/metal_capacity.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## metal capacity

Capacity operations. For more information on capacity in metros, visit https://metal.equinix.com/developers/docs/locations/metros/. For more information on capacity in facilities, visit https://metal.equinix.com/developers/docs/locations/facilities/.
Capacity operations: get, check

### Synopsis

Capacity operations: get, check
Capacity operations. For more information on capacity in metros, visit https://metal.equinix.com/developers/docs/locations/metros/. For more information on capacity in facilities, visit https://metal.equinix.com/developers/docs/locations/facilities/.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/metal_capacity_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ metal capacity check (-m <metro> | -f <facility>) -P <plan> -q <quantity> [flags

### SEE ALSO

* [metal capacity](metal_capacity.md) - Capacity operations. For more information on capacity in metros, visit https://metal.equinix.com/developers/docs/locations/metros/. For more information on capacity in facilities, visit https://metal.equinix.com/developers/docs/locations/facilities/.
* [metal capacity](metal_capacity.md) - Capacity operations: get, check

2 changes: 1 addition & 1 deletion docs/metal_capacity_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ metal capacity get [-m | -f] | [--metros <list> | --facilities <list>] [-P <list

### SEE ALSO

* [metal capacity](metal_capacity.md) - Capacity operations. For more information on capacity in metros, visit https://metal.equinix.com/developers/docs/locations/metros/. For more information on capacity in facilities, visit https://metal.equinix.com/developers/docs/locations/facilities/.
* [metal capacity](metal_capacity.md) - Capacity operations: get, check

4 changes: 2 additions & 2 deletions docs/metal_device.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## metal device

Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

### Synopsis

Device operations: create, get, update, delete, reinstall, start, stop, and reboot.
Device operations that control server provisioning, metadata, and basic operations.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ metal device create -p <project_id> (-m <metro> | -f <facility>) -P <plan> -H <h

### SEE ALSO

* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

2 changes: 1 addition & 1 deletion docs/metal_device_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ metal device delete -i <device_id> [-f] [flags]

### SEE ALSO

* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

2 changes: 1 addition & 1 deletion docs/metal_device_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ metal device get [-p <project_id>] | [-i <device_id>] [flags]

### SEE ALSO

* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

2 changes: 1 addition & 1 deletion docs/metal_device_reboot.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ metal device reboot -i <device_id> [flags]

### SEE ALSO

* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

2 changes: 1 addition & 1 deletion docs/metal_device_reinstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ metal device reinstall -d <device-id> [flags]

### SEE ALSO

* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

2 changes: 1 addition & 1 deletion docs/metal_device_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ metal device start -i <device_id> [flags]

### SEE ALSO

* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

2 changes: 1 addition & 1 deletion docs/metal_device_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ metal device stop -i <device_id> [flags]

### SEE ALSO

* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

2 changes: 1 addition & 1 deletion docs/metal_device_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ metal device update -i <device_id> [-H <hostname>] [-d <description>] [--locked

### SEE ALSO

* [metal device](metal_device.md) - Device operations. For more information on provisioning on Equinix Metal, visit https://metal.equinix.com/developers/docs/deploy/.
* [metal device](metal_device.md) - Device operations: create, get, update, delete, reinstall, start, stop, and reboot.

4 changes: 2 additions & 2 deletions docs/metal_event.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## metal event

Events operations for organizations, projects, devices, and the current user.
Events operations: get.

### Synopsis

Events operations: get.
Events information for organizations, projects, devices, and the current user.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/metal_event_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ metal event get [-p <project_id>] | [-d <device_id>] | [-i <event_id>] | [-O <or

### SEE ALSO

* [metal event](metal_event.md) - Events operations for organizations, projects, devices, and the current user.
* [metal event](metal_event.md) - Events operations: get.

4 changes: 2 additions & 2 deletions docs/metal_facilities.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## metal facilities

Facility operations. For more information on Equinix Metal facilities, visit https://metal.equinix.com/developers/docs/locations/facilities/.
Facility operations: get.

### Synopsis

Facility operations: get.
Information about specific facilities. Facility-level operations have mostly been replaced by Metros, but remains for backwards-compatibility. Documentation about facilities is available at https://metal.equinix.com/developers/docs/locations/facilities/.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/metal_facilities_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,5 @@ metal facilities get [flags]

### SEE ALSO

* [metal facilities](metal_facilities.md) - Facility operations. For more information on Equinix Metal facilities, visit https://metal.equinix.com/developers/docs/locations/facilities/.
* [metal facilities](metal_facilities.md) - Facility operations: get.

4 changes: 2 additions & 2 deletions docs/metal_gateway.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## metal gateway

Metal Gateways. For more information on Metal Gateways, visit https://metal.equinix.com/developers/docs/networking/metal-gateway/.
Metal Gateway operations: create, delete, and retrieve.

### Synopsis

Metal Gateway operations: create, delete, and retrieve.
A Metal Gateway provides a single IPv4 address as a gateway for a subnet. For more information, visit https://metal.equinix.com/developers/docs/networking/metal-gateway/.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/metal_gateway_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ metal gateway create -p <project_UUID> --virtual-network <virtual_network_UUID>

### SEE ALSO

* [metal gateway](metal_gateway.md) - Metal Gateways. For more information on Metal Gateways, visit https://metal.equinix.com/developers/docs/networking/metal-gateway/.
* [metal gateway](metal_gateway.md) - Metal Gateway operations: create, delete, and retrieve.

2 changes: 1 addition & 1 deletion docs/metal_gateway_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ metal gateway delete -i <metal_gateway_UUID> [-f] [flags]

### SEE ALSO

* [metal gateway](metal_gateway.md) - Metal Gateways. For more information on Metal Gateways, visit https://metal.equinix.com/developers/docs/networking/metal-gateway/.
* [metal gateway](metal_gateway.md) - Metal Gateway operations: create, delete, and retrieve.

2 changes: 1 addition & 1 deletion docs/metal_gateway_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ metal gateway get -p <project_UUID> [flags]

### SEE ALSO

* [metal gateway](metal_gateway.md) - Metal Gateways. For more information on Metal Gateways, visit https://metal.equinix.com/developers/docs/networking/metal-gateway/.
* [metal gateway](metal_gateway.md) - Metal Gateway operations: create, delete, and retrieve.

4 changes: 2 additions & 2 deletions docs/metal_hardware-reservation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## metal hardware-reservation

Hardware reservation operations. Information on reserving hardware on Equinix Metal is available on https://metal.equinix.com/developers/docs/deploy/reserved/.
Hardware reservation operations: get, move.

### Synopsis

Hardware reservation operations: get, move.
Information and operations on Hardware Reservations. Provisioning specific devices from a reservation can be performed with the `metal device` command. Documentation is available on https://metal.equinix.com/developers/docs/deploy/reserved/.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/metal_hardware-reservation_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ metal hardware-reservation get [-p <project_id>] | [-i <hardware_reservation_id>

### SEE ALSO

* [metal hardware-reservation](metal_hardware-reservation.md) - Hardware reservation operations. Information on reserving hardware on Equinix Metal is available on https://metal.equinix.com/developers/docs/deploy/reserved/.
* [metal hardware-reservation](metal_hardware-reservation.md) - Hardware reservation operations: get, move.

2 changes: 1 addition & 1 deletion docs/metal_hardware-reservation_move.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ metal hardware-reservation move -i <hardware_reservation_id> -p <project_id> [fl

### SEE ALSO

* [metal hardware-reservation](metal_hardware-reservation.md) - Hardware reservation operations. Information on reserving hardware on Equinix Metal is available on https://metal.equinix.com/developers/docs/deploy/reserved/.
* [metal hardware-reservation](metal_hardware-reservation.md) - Hardware reservation operations: get, move.

4 changes: 2 additions & 2 deletions docs/metal_ip.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## metal ip

IP address and subnet operations. For more information on IP addresses, subnets, and IP address reservations, visit https://metal.equinix.com/developers/docs/networking/ip-addresses/.
IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.

### Synopsis

IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.
IP address and subnet operations, including requesting IPv4 and IPv6 addresses, assigning and removing IPs to servers, and getting information about subnets and their usage. For more information is available on https://metal.equinix.com/developers/docs/networking/ip-addresses/.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/metal_ip_assign.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ metal ip assign -a <IP_address> -d <device_UUID> [flags]

### SEE ALSO

* [metal ip](metal_ip.md) - IP address and subnet operations. For more information on IP addresses, subnets, and IP address reservations, visit https://metal.equinix.com/developers/docs/networking/ip-addresses/.
* [metal ip](metal_ip.md) - IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.

2 changes: 1 addition & 1 deletion docs/metal_ip_available.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ metal ip available -r <reservation_UUID> -c <size_of_subnet> [flags]

### SEE ALSO

* [metal ip](metal_ip.md) - IP address and subnet operations. For more information on IP addresses, subnets, and IP address reservations, visit https://metal.equinix.com/developers/docs/networking/ip-addresses/.
* [metal ip](metal_ip.md) - IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.

2 changes: 1 addition & 1 deletion docs/metal_ip_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ metal ip get -p <project_UUID> | -a <assignment_UUID> | -r <reservation_UUID> [f

### SEE ALSO

* [metal ip](metal_ip.md) - IP address and subnet operations. For more information on IP addresses, subnets, and IP address reservations, visit https://metal.equinix.com/developers/docs/networking/ip-addresses/.
* [metal ip](metal_ip.md) - IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.

2 changes: 1 addition & 1 deletion docs/metal_ip_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ metal ip remove -i <reservation_UUID> [flags]

### SEE ALSO

* [metal ip](metal_ip.md) - IP address and subnet operations. For more information on IP addresses, subnets, and IP address reservations, visit https://metal.equinix.com/developers/docs/networking/ip-addresses/.
* [metal ip](metal_ip.md) - IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.

2 changes: 1 addition & 1 deletion docs/metal_ip_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ metal ip request -p <project_id> -t <ip_address_type> -q <quantity> (-m <metro>

### SEE ALSO

* [metal ip](metal_ip.md) - IP address and subnet operations. For more information on IP addresses, subnets, and IP address reservations, visit https://metal.equinix.com/developers/docs/networking/ip-addresses/.
* [metal ip](metal_ip.md) - IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.

2 changes: 1 addition & 1 deletion docs/metal_ip_unassign.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ metal ip unassign -i <assignment_UUID> [flags]

### SEE ALSO

* [metal ip](metal_ip.md) - IP address and subnet operations. For more information on IP addresses, subnets, and IP address reservations, visit https://metal.equinix.com/developers/docs/networking/ip-addresses/.
* [metal ip](metal_ip.md) - IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.

Loading

0 comments on commit 5d35a69

Please sign in to comment.