docs(b‎aremetal): elastic metal servers (#3075)

Co-authored-by: Rémy Léone <rleone@scaleway.com>
scaleway · Apr 24, 2023 · b8ae72f · b8ae72f
1 parent 5eb0d7d
commit b8ae72f
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 23 deletions.
diff --git a/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Return specific OS for the ID.
+Return the specific OS for the ID.
 
 USAGE:
   scw baremetal os get <os-id ...> [arg=value ...]

diff --git a/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw baremetal os <command>
 
 AVAILABLE COMMANDS:
-  get         Get an OS with an ID
+  get         Get OS with an ID
   list        List available OSes
 
 FLAGS:

diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List Elastic Metal servers for a specific organization.
+List Elastic Metal servers for a specific Organization.
 
 USAGE:
   scw baremetal server list [arg=value ...]

diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden
@@ -11,7 +11,7 @@ AVAILABLE COMMANDS:
   get         Get a specific Elastic Metal server
   get-metrics Return server metrics
   install     Install an Elastic Metal server
-  list        List Elastic Metal servers for an organization
+  list        List Elastic Metal servers for an Organization
   list-events List server events
   reboot      Reboot an Elastic Metal server
   start       Start an Elastic Metal server

diff --git a/cmd/scw/testdata/test-all-usage-baremetal-settings-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-settings-list-usage.golden
@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Return all settings for a project ID.
+Return all settings for a Project ID.
 
 USAGE:
   scw baremetal settings list [arg=value ...]
 
 ARGS:
   [order-by]        Sort order for items in the response (created_at_asc | created_at_desc)
-  project-id        ID of the project
+  project-id        ID of the Project
   [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all)
 
 FLAGS:

diff --git a/cmd/scw/testdata/test-all-usage-baremetal-settings-update-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-settings-update-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update a setting for a project ID (enable or disable).
+Update a setting for a Project ID (enable or disable).
 
 USAGE:
   scw baremetal settings update [arg=value ...]

diff --git a/docs/commands/baremetal.md b/docs/commands/baremetal.md
@@ -15,7 +15,7 @@ Elastic Metal API.
   - [Get option](#get-option)
   - [List options](#list-options)
 - [Operating System (OS) management commands](#operating-system-(os)-management-commands)
-  - [Get an OS with an ID](#get-an-os-with-an-id)
+  - [Get OS with an ID](#get-os-with-an-id)
   - [List available OSes](#list-available-oses)
 - [Private Network management command](#private-network-management-command)
   - [Add a server to a Private Network](#add-a-server-to-a-private-network)
@@ -28,7 +28,7 @@ Elastic Metal API.
   - [Get a specific Elastic Metal server](#get-a-specific-elastic-metal-server)
   - [Return server metrics](#return-server-metrics)
   - [Install an Elastic Metal server](#install-an-elastic-metal-server)
-  - [List Elastic Metal servers for an organization](#list-elastic-metal-servers-for-an-organization)
+  - [List Elastic Metal servers for an Organization](#list-elastic-metal-servers-for-an-organization)
   - [List server events](#list-server-events)
   - [Reboot an Elastic Metal server](#reboot-an-elastic-metal-server)
   - [Start an Elastic Metal server](#start-an-elastic-metal-server)
@@ -327,9 +327,9 @@ scw baremetal options list zone=fr-par-1
 An Operating System (OS) is the underlying software installed on your server
 
 
-### Get an OS with an ID
+### Get OS with an ID
 
-Return specific OS for the ID.
+Return the specific OS for the ID.
 
 **Usage:**
 
@@ -643,9 +643,9 @@ scw baremetal server install 11111111-1111-1111-1111-111111111111 os-id=11111111
 
 
 
-### List Elastic Metal servers for an organization
+### List Elastic Metal servers for an Organization
 
-List Elastic Metal servers for a specific organization.
+List Elastic Metal servers for a specific Organization.
 
 **Usage:**
 
@@ -885,7 +885,7 @@ Allows to configure the general settings for your Elastic Metal server.
 
 ### List all settings
 
-Return all settings for a project ID.
+Return all settings for a Project ID.
 
 **Usage:**
 
@@ -899,14 +899,14 @@ scw baremetal settings list [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | order-by | One of: `created_at_asc`, `created_at_desc` | Sort order for items in the response |
-| project-id | Required | ID of the project |
+| project-id | Required | ID of the Project |
 | zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `all` | Zone to target. If none is passed will use default zone from the config |
 
 
 
 ### Update setting
 
-Update a setting for a project ID (enable or disable).
+Update a setting for a Project ID (enable or disable).
 
 **Usage:**
 

diff --git a/internal/namespaces/baremetal/v1/baremetal_cli.go b/internal/namespaces/baremetal/v1/baremetal_cli.go
@@ -148,8 +148,8 @@ Note that a resource can be a part of multiple Private Networks.
 
 func baremetalServerList() *core.Command {
 	return &core.Command{
-		Short:     `List Elastic Metal servers for an organization`,
-		Long:      `List Elastic Metal servers for a specific organization.`,
+		Short:     `List Elastic Metal servers for an Organization`,
+		Long:      `List Elastic Metal servers for a specific Organization.`,
 		Namespace: "baremetal",
 		Resource:  "server",
 		Verb:      "list",
@@ -1204,7 +1204,7 @@ func baremetalOptionsList() *core.Command {
 func baremetalSettingsList() *core.Command {
 	return &core.Command{
 		Short:     `List all settings`,
-		Long:      `Return all settings for a project ID.`,
+		Long:      `Return all settings for a Project ID.`,
 		Namespace: "baremetal",
 		Resource:  "settings",
 		Verb:      "list",
@@ -1221,7 +1221,7 @@ func baremetalSettingsList() *core.Command {
 			},
 			{
 				Name:       "project-id",
-				Short:      `ID of the project`,
+				Short:      `ID of the Project`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -1251,7 +1251,7 @@ func baremetalSettingsList() *core.Command {
 func baremetalSettingsUpdate() *core.Command {
 	return &core.Command{
 		Short:     `Update setting`,
-		Long:      `Update a setting for a project ID (enable or disable).`,
+		Long:      `Update a setting for a Project ID (enable or disable).`,
 		Namespace: "baremetal",
 		Resource:  "settings",
 		Verb:      "update",
@@ -1326,8 +1326,8 @@ func baremetalOsList() *core.Command {
 
 func baremetalOsGet() *core.Command {
 	return &core.Command{
-		Short:     `Get an OS with an ID`,
-		Long:      `Return specific OS for the ID.`,
+		Short:     `Get OS with an ID`,
+		Long:      `Return the specific OS for the ID.`,
 		Namespace: "baremetal",
 		Resource:  "os",
 		Verb:      "get",