Skip to content

Commit 701a095

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Fixed several broken links and formatting issues in the reference documentation
PiperOrigin-RevId: 400904467
1 parent 1b18746 commit 701a095

6 files changed

Lines changed: 22 additions & 20 deletions

File tree

‎google/cloud/notebooks/v1/BUILD.bazel‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ ruby_grpc_library(
289289

290290
ruby_cloud_gapic_library(
291291
name = "notebooks_ruby_gapic",
292-
srcs = [":notebooks_proto_with_info"],
292+
srcs = [":notebooks_proto"],
293293
extra_protoc_parameters = [
294294
"ruby-cloud-gem-name=google-cloud-notebooks-v1",
295295
"ruby-cloud-env-prefix=NOTEBOOKS",

‎google/cloud/notebooks/v1/execution.proto‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ message ExecutionTemplate {
4242
// Parameters used in Dataproc JobType executions.
4343
message DataprocParameters {
4444
// URI for cluster used to run Dataproc execution.
45-
// Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
45+
// Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
4646
string cluster = 1;
4747
}
4848

@@ -204,8 +204,8 @@ message ExecutionTemplate {
204204

205205
// Path to the notebook file to execute.
206206
// Must be in a Google Cloud Storage bucket.
207-
// Format: gs://{project_id}/{folder}/{notebook_file_name}
208-
// Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
207+
// Format: `gs://{project_id}/{folder}/{notebook_file_name}`
208+
// Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
209209
string input_notebook_file = 5;
210210

211211
// Container Image URI to a DLVM
@@ -216,15 +216,15 @@ message ExecutionTemplate {
216216

217217
// Path to the notebook folder to write to.
218218
// Must be in a Google Cloud Storage bucket path.
219-
// Format: gs://{project_id}/{folder}
220-
// Ex: gs://notebook_user/scheduled_notebooks
219+
// Format: `gs://{project_id}/{folder}`
220+
// Ex: `gs://notebook_user/scheduled_notebooks`
221221
string output_notebook_folder = 7;
222222

223223
// Parameters to be overridden in the notebook during execution.
224224
// Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on
225225
// how to specifying parameters in the input notebook and pass them here
226226
// in an YAML file.
227-
// Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
227+
// Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
228228
string params_yaml_file = 8;
229229

230230
// Parameters used within the 'input_notebook_file' notebook.
@@ -294,7 +294,7 @@ message Execution {
294294
ExecutionTemplate execution_template = 1;
295295

296296
// Output only. The resource name of the execute. Format:
297-
// `projects/{project_id}/locations/{location}/execution/{execution_id}
297+
// `projects/{project_id}/locations/{location}/execution/{execution_id}`
298298
string name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
299299

300300
// Output only. Name used for UI purposes.

‎google/cloud/notebooks/v1/instance.proto‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ message Instance {
373373

374374
// Path to a Bash script that automatically runs after a notebook instance
375375
// fully boots up. The path must be a URL or
376-
// Cloud Storage path (gs://path-to-file/file-name).
376+
// Cloud Storage path (`gs://path-to-file/file-name`).
377377
string post_startup_script = 4;
378378

379379
// Output only. The proxy endpoint that is used to access the Jupyter notebook.
@@ -468,8 +468,8 @@ message Instance {
468468
repeated Disk disks = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
469469

470470
// Optional. Shielded VM configuration.
471-
// [Images using supported Shielded VM features]
472-
// (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
471+
// [Images using supported Shielded VM
472+
// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
473473
ShieldedInstanceConfig shielded_instance_config = 30 [(google.api.field_behavior) = OPTIONAL];
474474

475475
// If true, no public IP will be assigned to this instance.

‎google/cloud/notebooks/v1/instance_config.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ message InstanceConfig {
3030
// Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
3131
string notebook_upgrade_schedule = 1;
3232

33-
// Verifies core internal services are running. More info: go/notebooks-health
33+
// Verifies core internal services are running.
3434
bool enable_health_monitoring = 2;
3535
}

‎google/cloud/notebooks/v1/runtime.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ message RuntimeSoftwareConfig {
379379

380380
// Path to a Bash script that automatically runs after a notebook instance
381381
// fully boots up. The path must be a URL or
382-
// Cloud Storage path (gs://path-to-file/file-name).
382+
// Cloud Storage path (`gs://path-to-file/file-name`).
383383
string post_startup_script = 7;
384384
}
385385

‎google/cloud/notebooks/v1/service.proto‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -786,9 +786,10 @@ message ListSchedulesResponse {
786786
// next list call.
787787
string next_page_token = 2;
788788

789-
// Schedules that could not be reached. For example,
790-
// ['projects/{project_id}/location/{location}/schedules/monthly_digest',
791-
// 'projects/{project_id}/location/{location}/schedules/weekly_sentiment'].
789+
// Schedules that could not be reached. For example:
790+
//
791+
// ['projects/{project_id}/location/{location}/schedules/monthly_digest',
792+
// 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']
792793
repeated string unreachable = 3;
793794
}
794795

@@ -866,7 +867,7 @@ message ListExecutionsRequest {
866867

867868
// Filter applied to resulting executions. Currently only supports filtering
868869
// executions by a specified schedule_id.
869-
// Format: "schedule_id=<Schedule_ID>"
870+
// Format: `schedule_id=<Schedule_ID>`
870871
string filter = 4;
871872

872873
// Sort by field.
@@ -882,9 +883,10 @@ message ListExecutionsResponse {
882883
// next list call.
883884
string next_page_token = 2;
884885

885-
// Executions IDs that could not be reached. For example,
886-
// ['projects/{project_id}/location/{location}/executions/imagenet_test1',
887-
// 'projects/{project_id}/location/{location}/executions/classifier_train1'].
886+
// Executions IDs that could not be reached. For example:
887+
//
888+
// ['projects/{project_id}/location/{location}/executions/imagenet_test1',
889+
// 'projects/{project_id}/location/{location}/executions/classifier_train1']
888890
repeated string unreachable = 3;
889891
}
890892

0 commit comments

Comments
 (0)