docs: use consistent library id in flags and examples (#2770)

Use `secretmanager` as an example of library ID in flags and examples.

Fixes #2704

Author: JoeWang1127

cmd/librarian/doc.go

@@ -115,7 +115,7 @@ Flags:
 	  	Language specific image used to invoke code generation and releasing.
 	  	If not specified, the image configured in the state.yaml is used.
 	-library string
-	  	The library ID to generate or release (e.g. google-cloud-secretmanager-v1).
+	  	The library ID to generate or release (e.g. secretmanager).
 	  	This corresponds to a releasable language unit.
 	-output string
 	  	Working directory root. When this is not specified, a working directory
@@ -203,7 +203,7 @@ Flags:
 	  	Language specific image used to invoke code generation and releasing.
 	  	If not specified, the image configured in the state.yaml is used.
 	-library string
-	  	The library ID to generate or release (e.g. google-cloud-secretmanager-v1).
+	  	The library ID to generate or release (e.g. secretmanager).
 	  	This corresponds to a releasable language unit.
 	-library-version string
 	  	Overrides the automatic semantic version calculation and forces a specific

doc/config-schema.md

@@ -54,7 +54,7 @@ global_files_allowlist:
     permissions: "write-only"
 # A list of library overrides
 libraries:
-  - id: "example-library"
+  - id: "secretmanager"
     next_version: "2.3.4"
     generate_blocked: false
     release_blocked: false

doc/language-onboarding.md

@@ -59,7 +59,7 @@ need to be executable by any user ID within the container.
 
 ### Guidelines on Language Container Runtimes
 
-You should be able to run the `generate` or `release-stage` commands for an API such as Google Cloud Functions in less than a
+You should be able to run the `generate` or `release-stage` commands for an API such as Google Cloud Secret Manager in less than a
 minute. We understand that some libraries may take longer to process, however, long runtimes can adversely affect your
 ability to roll out emergency changes. While the CLI typically calls the container only for libraries with changes, a
 generator update could trigger a run for all your libraries.
@@ -100,25 +100,25 @@ The container is expected to produce up to two artifacts:
 {
   "libraries": [
     {
-      "id": "google-cloud-secretmanager",
+      "id": "pubsub",
       "apis": [
         {
-          "path": "google/cloud/secretmanager/v1",
-          "service_config": "secretmanager_v1.yaml",
-          "status": "new"
+          "path": "google/cloud/pubsub/v1",
+          "service_config": "pubsub_v1.yaml",
+          "status": "existing"
         }
       ],
+      "source_roots": [ "pubsub" ]
     },
     {
-      "id": "google-cloud-pubsub-v1",
+      "id": "secretmanager",
       "apis": [
         {
-          "path": "google/cloud/pubsub/v1",
-          "service_config": "pubsub_v1.yaml",
-          "status": "existing"
+          "path": "google/cloud/secretmanager/v1",
+          "service_config": "secretmanager_v1.yaml",
+          "status": "new"
         }
-      ],
-      "source_roots": [ "pubsub" ]
+      ]
     }
   ]
 }
@@ -130,10 +130,10 @@ The container is expected to produce up to two artifacts:
 
 ```json
 {
-  "id": "google-cloud-secretmanager",
+  "id": "secretmanager",
   "apis": [
     {
-      "path": "google/cloud/secretmanager/v1",
+      "path": "google/cloud/secretmanager/v1"
     }
   ],
   "source_roots": [ "secretmanager" ],
@@ -168,7 +168,7 @@ The `generate` command is where the core work of code generation happens. The co
 
 ```json
 {
-  "id": "google-cloud-secretmanager",
+  "id": "secretmanager",
   "apis": [
     {
       "path": "google/cloud/secretmanager/v1",
@@ -217,7 +217,7 @@ The `build` command is responsible for building and testing the newly generated
 
 ```json
 {
-  "id": "google-cloud-secretmanager",
+  "id": "secretmanager",
   "apis": [
     {
       "path": "google/cloud/secretmanager/v1",
@@ -276,7 +276,7 @@ global file edits. The libraries that are being released will be marked by the `
 {
   "libraries": [
     {
-      "id": "google-cloud-secretmanager-v1",
+      "id": "secretmanager",
       "version": "1.3.0",
       "changes": [
         {

doc/state-schema.md

@@ -41,17 +41,17 @@ Each object in the `apis` list represents a single API and has the following fie
 ```yaml
 image: "gcr.io/my-special-project/language-generator:v1.2.5"
 libraries:
-  - id: "google-cloud-storage-v1"
+  - id: "secretmanager"
     version: "1.15.0"
     last_generated_commit: "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"
     apis:
-      - path: "google/storage/v1"
-        service_config: "storage.yaml"
+      - path: "google/cloud/secretmanager/v1"
+        service_config: "secretmanager_v1.yaml"
     source_roots:
-      - "src/google/cloud/storage"
-      - "test/google/cloud/storage"
+      - "src/google/cloud/secretmanager"
+      - "test/google/cloud/secretmanager"
     preserve_regex:
-      - "src/google/cloud/storage/generated-dir/HandWrittenFile.java"
+      - "src/google/cloud/secretmanager/generated-dir/HandWrittenFile.java"
     remove_regex:
-      - "src/google/cloud/storage/generated-dir"
+      - "src/google/cloud/secretmanager/generated-dir"
 ```

internal/config/config.go

@@ -171,7 +171,7 @@ type Config struct {
 	// Image is specified with the -image flag.
 	Image string
 
-	// Library is the library ID to generate (e.g. google-cloud-secretmanager-v1 ).
+	// Library is the library ID to generate (e.g. secretmanager).
 	// This usually corresponds to a releasable language unit -- for Go this would
 	// be a Go module or for dotnet the name of a NuGet package. If neither this nor
 	// api is specified all currently managed libraries will be regenerated.

internal/librarian/flags.go

@@ -73,7 +73,7 @@ If not specified, the image configured in the state.yaml is used.`)
 
 func addFlagLibrary(fs *flag.FlagSet, cfg *config.Config) {
 	fs.StringVar(&cfg.Library, "library", "",
-		`The library ID to generate or release (e.g. google-cloud-secretmanager-v1).
+		`The library ID to generate or release (e.g. secretmanager).
 This corresponds to a releasable language unit.`)
 }