From 2a2036813b6b5c0892fbed0ba0285fdbf8f87dab Mon Sep 17 00:00:00 2001 From: Ali Ijaz Sheikh Date: Mon, 12 Jun 2017 10:47:13 -0700 Subject: [PATCH] Revert "logging-{winston,bunyan}: improve API docs" (#2377) This reverts commit 8b616ea64542014090d4a68216917b2a63a3ac9d. I didn't intend to push this to master. Will open a PR instead. --- packages/logging-bunyan/src/index.js | 10 +++++++++- packages/logging-winston/src/index.js | 10 +++++++++- packages/logging/src/index.js | 2 -- scripts/docs/config.js | 4 +--- 4 files changed, 19 insertions(+), 7 deletions(-) diff --git a/packages/logging-bunyan/src/index.js b/packages/logging-bunyan/src/index.js index a0991baac2a..8723898a053 100644 --- a/packages/logging-bunyan/src/index.js +++ b/packages/logging-bunyan/src/index.js @@ -42,7 +42,15 @@ var BUNYAN_TO_STACKDRIVER = { /** * This module provides support for streaming your Bunyan logs to - * [Stackdriver Logging](https://cloud.google.com/logging). + * [Stackdriver Logging]{@link https://cloud.google.com/logging}. + * + * If your app is running on Google Cloud Platform, all configuration and + * authentication is handled for you. We also auto-detect the appropriate + * resource descriptor to report the log entries against. + * + * If you are running your application in anther environment, such as locally, + * on-premise, or on another cloud provider, you will need to provide additional + * configuration. * * @constructor * @alias module:logging-bunyan diff --git a/packages/logging-winston/src/index.js b/packages/logging-winston/src/index.js index 02ab3423c44..05a8d1fad5a 100644 --- a/packages/logging-winston/src/index.js +++ b/packages/logging-winston/src/index.js @@ -61,7 +61,15 @@ var STACKDRIVER_LOGGING_LEVEL_CODE_TO_NAME = { /** * This module provides support for streaming your winston logs to - * [Stackdriver Logging](https://cloud.google.com/logging). + * [Stackdriver Logging]{@link https://cloud.google.com/logging}. + * + * If your app is running on Google Cloud Platform, all configuration and + * authentication is handled for you. We also auto-detect the appropriate + * resource descriptor to report the log entries against. + * + * If you are running your application in another environment, such as locally, + * on-premise, or on another cloud provider, you will need to provide additional + * configuration. * * @constructor * @alias module:logging-winston diff --git a/packages/logging/src/index.js b/packages/logging/src/index.js index 3ccce7eb92b..0af7be6c009 100644 --- a/packages/logging/src/index.js +++ b/packages/logging/src/index.js @@ -60,8 +60,6 @@ var Sink = require('./sink.js'); * @resource [What is Stackdriver Logging?]{@link https://cloud.google.com/logging/docs} * @resource [Introduction to the Stackdriver Logging API]{@link https://cloud.google.com/logging/docs/api} - * @resource [Logging to Stackdriver from Bunyan]{@link https://www.npmjs.com/package/@google-cloud/logging-bunyan} - * @resource [Logging to Stackdriver from Winston]{@link https://www.npmjs.com/package/@google-cloud/logging-winston} * * @param {object} options - [Configuration object](#/docs). */ diff --git a/scripts/docs/config.js b/scripts/docs/config.js index 53a9753c821..0f70f676fe7 100644 --- a/scripts/docs/config.js +++ b/scripts/docs/config.js @@ -73,14 +73,12 @@ module.exports = { title: 'Cloud Natural Language' }, logging: { - title: 'Stackdriver Logging' + title: 'Cloud Logging' }, 'logging-bunyan': { - title: 'Stackdriver Logging through Bunyan', skip: true }, 'logging-winston': { - title: 'Stackdriver Logging through Winston', skip: true }, monitoring: {