logging-{winston,bunyan}: improve API docs

* API overview already included auth info. * Fix links. * Add missing `title`.
googleapis · Jun 12, 2017 · 8b616ea · 8b616ea
1 parent f4c4a79
commit 8b616ea
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 19 deletions.
diff --git a/packages/logging-bunyan/src/index.js b/packages/logging-bunyan/src/index.js
@@ -42,15 +42,7 @@ var BUNYAN_TO_STACKDRIVER = {
 
 /**
  * This module provides support for streaming your Bunyan logs to
- * [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.
+ * [Stackdriver Logging](https://cloud.google.com/logging).
  *
  * @constructor
  * @alias module:logging-bunyan

diff --git a/packages/logging-winston/src/index.js b/packages/logging-winston/src/index.js
@@ -61,15 +61,7 @@ var STACKDRIVER_LOGGING_LEVEL_CODE_TO_NAME = {
 
 /**
  * This module provides support for streaming your winston logs to
- * [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.
+ * [Stackdriver Logging](https://cloud.google.com/logging).
  *
  * @constructor
  * @alias module:logging-winston

diff --git a/packages/logging/src/index.js b/packages/logging/src/index.js
@@ -60,6 +60,8 @@ 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
@@ -73,12 +73,14 @@ module.exports = {
       title: 'Cloud Natural Language'
     },
     logging: {
-      title: 'Cloud Logging'
+      title: 'Stackdriver Logging'
     },
     'logging-bunyan': {
+      title: 'Stackdriver Logging through Bunyan',
       skip: true
     },
     'logging-winston': {
+      title: 'Stackdriver Logging through Winston',
       skip: true
     },
     monitoring: {