Skip to content

Commit ce3495c

Browse files
docs: warn about google-cloud performance cost (#2140)
1 parent 6991616 commit ce3495c

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

scripts/docs/templates/overview.html

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22
This class allows you interact with <%= title %>.
33
</p>
44

5+
<% if (umbrellaView) { %>
6+
<div class="notice">
7+
<strong><code>google-cloud</code> is deprecated</strong>
8+
<p>
9+
Due to the scope of our API rapidly increasing, you may notice a decrease in performance if you continue to use the bundled module, `google-cloud`.
10+
</p>
11+
<p>
12+
Going forward, please install only the individual service modules that you need, such as <code><%= pkgJson.name %></code>.
13+
</p>
14+
<p>
15+
The instructions below are here for reference, however, we will soon stop releasing updates to the bundled package.
16+
</p>
17+
</div>
18+
<% } %>
19+
520
<p>
621
First, install <code><%= pkgJson.name %></code> with npm:
722
</p>
@@ -16,7 +31,7 @@
1631
However, if you're running your app elsewhere, you will need to provide project details to authenticate API requests.
1732
</p>
1833

19-
<h4>Compute Engine</h4>
34+
<h4>Google Cloud Platform</h4>
2035
<div hljs language="javascript"><% if (!umbrellaView) { %>
2136
var <%= instanceName || className %> = require('<%= pkgJson.name %>')();<% } else { %>
2237
var gcloud = require('google-cloud');
@@ -39,4 +54,3 @@ <h4>Elsewhere</h4>
3954
<p>
4055
The full set of options which can be passed to <code><%= pkgJson.name %></code> are outlined in our <a href="#/docs/<%= umbrellaView ? umbrellaPkg : className %>/<%= pkgJson.version %>/guides/authentication">Authentication guide</a>.
4156
</p>
42-

0 commit comments

Comments
 (0)