Skip to content

Revert "logging-{winston,bunyan}: improve API docs" #2377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ofrobots merged 1 commit into from
Jun 12, 2017
Merged

Revert "logging-{winston,bunyan}: improve API docs" #2377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion packages/logging-bunyan/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion packages/logging-winston/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions packages/logging/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
*/
Expand Down
4 changes: 1 addition & 3 deletions scripts/docs/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down