Skip to content

Commit

Permalink
docs: Fixed several broken links and formatting issues in the referen…
Browse files Browse the repository at this point in the history
…ce documentation

PiperOrigin-RevId: 400904467
  • Loading branch information
Google APIs authored and Copybara-Service committed Oct 5, 2021
1 parent 1b18746 commit 701a095
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 20 deletions.
2 changes: 1 addition & 1 deletion google/cloud/notebooks/v1/BUILD.bazel
Expand Up @@ -289,7 +289,7 @@ ruby_grpc_library(

ruby_cloud_gapic_library(
name = "notebooks_ruby_gapic",
srcs = [":notebooks_proto_with_info"],
srcs = [":notebooks_proto"],
extra_protoc_parameters = [
"ruby-cloud-gem-name=google-cloud-notebooks-v1",
"ruby-cloud-env-prefix=NOTEBOOKS",
Expand Down
14 changes: 7 additions & 7 deletions google/cloud/notebooks/v1/execution.proto
Expand Up @@ -42,7 +42,7 @@ message ExecutionTemplate {
// Parameters used in Dataproc JobType executions.
message DataprocParameters {
// URI for cluster used to run Dataproc execution.
// Format: 'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
// Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
string cluster = 1;
}

Expand Down Expand Up @@ -204,8 +204,8 @@ message ExecutionTemplate {

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

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

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

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

// Parameters used within the 'input_notebook_file' notebook.
Expand Down Expand Up @@ -294,7 +294,7 @@ message Execution {
ExecutionTemplate execution_template = 1;

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

// Output only. Name used for UI purposes.
Expand Down
6 changes: 3 additions & 3 deletions google/cloud/notebooks/v1/instance.proto
Expand Up @@ -373,7 +373,7 @@ message Instance {

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

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

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

// If true, no public IP will be assigned to this instance.
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/notebooks/v1/instance_config.proto
Expand Up @@ -30,6 +30,6 @@ message InstanceConfig {
// Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
string notebook_upgrade_schedule = 1;

// Verifies core internal services are running. More info: go/notebooks-health
// Verifies core internal services are running.
bool enable_health_monitoring = 2;
}
2 changes: 1 addition & 1 deletion google/cloud/notebooks/v1/runtime.proto
Expand Up @@ -379,7 +379,7 @@ message RuntimeSoftwareConfig {

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

Expand Down
16 changes: 9 additions & 7 deletions google/cloud/notebooks/v1/service.proto
Expand Up @@ -786,9 +786,10 @@ message ListSchedulesResponse {
// next list call.
string next_page_token = 2;

// Schedules that could not be reached. For example,
// ['projects/{project_id}/location/{location}/schedules/monthly_digest',
// 'projects/{project_id}/location/{location}/schedules/weekly_sentiment'].
// Schedules that could not be reached. For example:
//
// ['projects/{project_id}/location/{location}/schedules/monthly_digest',
// 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']
repeated string unreachable = 3;
}

Expand Down Expand Up @@ -866,7 +867,7 @@ message ListExecutionsRequest {

// Filter applied to resulting executions. Currently only supports filtering
// executions by a specified schedule_id.
// Format: "schedule_id=<Schedule_ID>"
// Format: `schedule_id=<Schedule_ID>`
string filter = 4;

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

// Executions IDs that could not be reached. For example,
// ['projects/{project_id}/location/{location}/executions/imagenet_test1',
// 'projects/{project_id}/location/{location}/executions/classifier_train1'].
// Executions IDs that could not be reached. For example:
//
// ['projects/{project_id}/location/{location}/executions/imagenet_test1',
// 'projects/{project_id}/location/{location}/executions/classifier_train1']
repeated string unreachable = 3;
}

Expand Down

0 comments on commit 701a095

Please sign in to comment.