Skip to content

Commit

Permalink
docs: update reference URLs in jsdoc (#331)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored Apr 13, 2020
1 parent 07a6cfb commit e6630d9
Show file tree
Hide file tree
Showing 14 changed files with 200 additions and 237 deletions.
5 changes: 0 additions & 5 deletions packages/google-container/.mocharc.json

This file was deleted.

1 change: 0 additions & 1 deletion packages/google-container/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@
"mocha": "^7.0.0",
"null-loader": "^3.0.0",
"pack-n-play": "^1.0.0-2",
"prettier": "^1.17.1",
"sinon": "^9.0.1",
"ts-loader": "^6.2.1",
"typescript": "^3.8.3",
Expand Down

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion packages/google-container/protos/protos.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
"java_multiple_files": true,
"java_outer_classname": "ClusterServiceProto",
"java_package": "com.google.container.v1",
"php_namespace": "Google\\Cloud\\Container\\V1"
"php_namespace": "Google\\Cloud\\Container\\V1",
"ruby_package": "Google::Cloud::Container::V1"
},
"nested": {
"ClusterManager": {
Expand Down
1 change: 0 additions & 1 deletion packages/google-container/samples/.eslintrc.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
rules:
no-console: off
node/no-missing-require: off
4 changes: 0 additions & 4 deletions packages/google-container/smoke-test/.eslintrc.yml

This file was deleted.

47 changes: 0 additions & 47 deletions packages/google-container/smoke-test/cluster_manager_smoke_test.js

This file was deleted.

132 changes: 66 additions & 66 deletions packages/google-container/src/v1/cluster_manager_client.ts

Large diffs are not rendered by default.

19 changes: 16 additions & 3 deletions packages/google-container/synth.metadata
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
{
"updateTime": "2020-04-11T00:01:09.907067Z",
"sources": [
{
"git": {
"name": ".",
"remote": "git@github.com:googleapis/nodejs-cloud-container.git",
"sha": "16c326bfac5b980db1f4beb5e913e816a967d8cb"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "1bd77e8ce6f953ac641af7966d0c52646afc16a8",
"internalRef": "305974465"
}
},
{
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
"sha": "6f32150677c9784f3c3a7e1949472bd29c9d72c5",
"log": "6f32150677c9784f3c3a7e1949472bd29c9d72c5\nfix: installs test_utils from its common repo (#480)\n\n\n74ce986d3b5431eb66985e9a00c4eb45295a4020\nfix: stop recording update_time in synth.metadata (#478)\n\n\n7f8e62aa3edd225f76347a16f92e400661fdfb52\nchore(java): release-please only updates non maven versions in README (#476)\n\nPrevent release-please and synthtool from fighting over the released library version. Synthtool updates the install snippets from the samples pom.xml files so the bots fight if they are temporarily out of sync after a release.\nc7e0e517d7f46f77bebd27da2e5afcaa6eee7e25\nbuild(java): fix nightly integration test config to run integrations (#465)\n\nThis was only running the units.\nbd69a2aa7b70875f3c988e269706b22fefbef40e\nbuild(java): fix retry_with_backoff when -e option set (#475)\n\n\nd9b173c427bfa0c6cca818233562e7e8841a357c\nfix: record version of working repo in synth.metadata (#473)\n\nPartial revert of b37cf74d12e9a42b9de9e61a4f26133d7cd9c168.\nf73a541770d95a609e5be6bf6b3b220d17cefcbe\nfeat(discogapic): allow local discovery-artifact-manager (#474)\n\n\n8cf0f5d93a70c3dcb0b4999d3152c46d4d9264bf\ndoc: describe the Autosynth & Synthtool protocol (#472)\n\n* doc: describe the Autosynth & Synthtool protocol\n\n* Accommodate review comments.\n980baaa738a1ad8fa02b4fdbd56be075ee77ece5\nfix: pin sphinx to <3.0.0 as new version causes new error (#471)\n\nThe error `toctree contains reference to document changlelog that doesn't have a title: no link will be generated` occurs as of 3.0.0. Pinning to 2.x until we address the docs build issue.\n\nTowards #470\n\nI did this manually for python-datastore https://github.com/googleapis/python-datastore/pull/22\n928b2998ac5023e7c7e254ab935f9ef022455aad\nchore(deps): update dependency com.google.cloud.samples:shared-configuration to v1.0.15 (#466)\n\nCo-authored-by: Jeffrey Rennie <rennie@google.com>\n188f1b1d53181f739b98f8aa5d40cfe99eb90c47\nfix: allow local and external deps to be specified (#469)\n\nModify noxfile.py to allow local and external dependencies for\nsystem tests to be specified.\n"
"sha": "8eff3790f88b50706a0c4b6a20b385f24e9ac4e7"
}
}
],
Expand Down
19 changes: 0 additions & 19 deletions packages/google-container/synth.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

AUTOSYNTH_MULTIPLE_COMMITS = True


# Run the gapic generator
gapic = gcp.GAPICMicrogenerator()
version = 'v1'
Expand All @@ -29,24 +28,6 @@
templates = common_templates.node_library(source_location='build/src')
s.copy(templates)

# fix broken doc links

s.replace("src/v1/doc/google/container/v1/doc_cluster_service.js",
"https:\/\/cloud\.google\.com\/kubernetes-engine\/docs\/reference\/rest\/v1\/projects\.zones\.clusters\.nodePool",
"https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools#resource-nodepool")

s.replace('src/v1/*.ts',
'/compute/docs/zones',
'https://cloud.google.com/compute/docs/regions-zones/')

s.replace('src/v1/*.ts',
'/compute/docs/networks-and-firewalls',
'https://cloud.google.com/vpc/docs/firewalls')

s.replace('src/v1/*.ts',
"/container-engine/reference/rest/v1/projects.zones.clusters",
"https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters")

# Node.js specific cleanup
subprocess.run(['npm', 'install'])
subprocess.run(['npm', 'run', 'lint'])
Expand Down
4 changes: 2 additions & 2 deletions packages/google-container/system-test/install.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {readFileSync} from 'fs';
import {describe, it} from 'mocha';

describe('typescript consumer tests', () => {
it('should have correct type signature for typescript users', async function() {
it('should have correct type signature for typescript users', async function () {
this.timeout(300000);
const options = {
packageDir: process.cwd(), // path to your module.
Expand All @@ -35,7 +35,7 @@ describe('typescript consumer tests', () => {
await packNTest(options); // will throw upon error.
});

it('should have correct type signature for javascript users', async function() {
it('should have correct type signature for javascript users', async function () {
this.timeout(300000);
const options = {
packageDir: process.cwd(), // path to your module.
Expand Down
31 changes: 31 additions & 0 deletions packages/google-container/system-test/smoke.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import {describe, it} from 'mocha';
import {ClusterManagerClient} from '../src';
import * as assert from 'assert';

describe('ClusterManagerSmokeTest', () => {
it('successfully makes a call to the service', async () => {
const client = new ClusterManagerClient();
const projectId = await client.getProjectId();
const zone = 'us-central1-a';
const request = {
projectId,
zone,
};
const [result] = await client.listClusters(request);
assert.ok(result);
});
});
3 changes: 0 additions & 3 deletions packages/google-container/test/.eslintrc.yml

This file was deleted.

3 changes: 0 additions & 3 deletions packages/google-container/tslint.json

This file was deleted.

0 comments on commit e6630d9

Please sign in to comment.