Skip to content

Commit

Permalink
Merge pull request #571 from jgeewax/overview-docs
Browse files Browse the repository at this point in the history 
Factored out service overview docs into separate files.
  • Loading branch information
@ryanseys
ryanseys committed May 11, 2015
2 parents 244c0d5 + 9c90f19 commit a6b94f7
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 49 deletions.
7 changes: 7 additions & 0 deletions docs/site/components/docs/bigquery-overview.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<h3>BigQuery Overview</h3>
<p>
The object returned from <code>gcloud.bigquery</code> gives you complete access to and control of your BigQuery datasets. You can work with existing ones, by using the <code>dataset</code> method, or create new ones with <code>createDataset</code>.
</p>
<p>
To learn more about BigQuery, see <a href="https://cloud.google.com/bigquery/what-is-bigquery">What is BigQuery?</a>
</p>
8 changes: 8 additions & 0 deletions docs/site/components/docs/datastore-overview.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<h3>Datastore Overview</h3>
<p>
The <code>gcloud.datastore</code> object gives you some convenience methods, as well as exposes a <code>dataset</code> function. This will allow you to create a <code>dataset</code>, which is the object from which you will interact with the Google Cloud Datastore.
</p>
<p>
To learn more about Datastore, read the <a href="https://cloud.google.com/datastore/docs/concepts/overview">Google Cloud Datastore Concepts Overview</a>.
</p>

52 changes: 3 additions & 49 deletions docs/site/components/docs/docs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,55 +64,9 @@ <h3 class="sub-heading">
</article>
<hr>

<article ng-if="isActiveDoc('bigquery')">
<h3>BigQuery Overview</h3>
<p>
The object returned from <code>gcloud.bigquery</code> gives you complete access to and control of your BigQuery datasets. You can work with existing ones, by using the <code>dataset</code> method, or create new ones with <code>createDataset</code>.
</p>
<p>
To learn more about BigQuery, see <a href="https://cloud.google.com/bigquery/what-is-bigquery">What is BigQuery?</a>
</p>
</article>

<article ng-if="isActiveDoc('datastore')">
<h3>Datastore Overview</h3>
<p>
The <code>gcloud.datastore</code> object gives you some convenience methods, as well as exposes a <code>dataset</code> function. This will allow you to create a <code>dataset</code>, which is the object from which you will interact with the Google Cloud Datastore.
</p>
<p>
To learn more about Datastore, read the <a href="https://cloud.google.com/datastore/docs/concepts/overview">Google Cloud Datastore Concepts Overview</a>.
</p>
</article>

<article ng-if="isActiveDoc('pubsub')">
<h3>Pub/Sub Overview</h3>
<p class="notice">
Google Cloud Pub/Sub is in Alpha status. As a result, it might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
</p>
<p>
The <code>gcloud.pubsub</code> method will return a <code>pubsub</code> object, allowing you to create topics, publish messages, subscribe to topics, and more.
</p>
<p>
To learn more about Pub/Sub, see the <a href="https://developers.google.com/pubsub/overview">Google Cloud Pub/Sub overview</a>.
</p>
</article>

<article ng-if="isActiveDoc('storage')">
<h3>Storage Overview</h3>
<p>
The <code>gcloud.storage</code> object contains a <code>bucket</code> function, which is how you will interact with your Google Cloud Storage bucket.
</p>
<p>
To learn more about Cloud Storage, see the <a href="https://cloud.google.com/storage/docs/overview">Google Cloud Storage overview</a>.
</p>

<h4>ACLs</h4>
<p>
Google Cloud Storage uses access control lists (ACLs) to manage object and bucket access. ACLs are the mechanism you use to share files with other users and allow other users to access your buckets and files.
</p>
<p>
To learn more about ACLs, read this overview on <a href="https://cloud.google.com/storage/docs/access-control">Access Control</a>.
</p>
<article ng-repeat="service in ['bigquery', 'datastore', 'pubsub', 'storage']"
ng-if="isActiveDoc(service)"
ng-include="'/site/components/docs/' + service + '-overview.html'">
</article>

<article
Expand Down
11 changes: 11 additions & 0 deletions docs/site/components/docs/pubsub-overview.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<h3>Pub/Sub Overview</h3>
<p class="notice">
Google Cloud Pub/Sub is in Alpha status. As a result, it might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
</p>
<p>
The <code>gcloud.pubsub</code> method will return a <code>pubsub</code> object, allowing you to create topics, publish messages, subscribe to topics, and more.
</p>
<p>
To learn more about Pub/Sub, see the <a href="https://developers.google.com/pubsub/overview">Google Cloud Pub/Sub overview</a>.
</p>

16 changes: 16 additions & 0 deletions docs/site/components/docs/storage-overview.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<h3>Storage Overview</h3>
<p>
The <code>gcloud.storage</code> object contains a <code>bucket</code> function, which is how you will interact with your Google Cloud Storage bucket.
</p>
<p>
To learn more about Cloud Storage, see the <a href="https://cloud.google.com/storage/docs/overview">Google Cloud Storage overview</a>.
</p>

<h4>ACLs</h4>
<p>
Google Cloud Storage uses access control lists (ACLs) to manage object and bucket access. ACLs are the mechanism you use to share files with other users and allow other users to access your buckets and files.
</p>
<p>
To learn more about ACLs, read this overview on <a href="https://cloud.google.com/storage/docs/access-control">Access Control</a>.
</p>

0 comments on commit a6b94f7

Please sign in to comment.