Skip to content
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

Jump to bottom

docs: fix examples, style optionals #229

Merged
merged 1 commit into from
Sep 19, 2014
Merged

docs: fix examples, style optionals #229

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
64 changes: 28 additions & 36 deletions docs/components/docs/docs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,14 @@ <h1 class="page-title">{{pageTitle}}</h1>

<section class="content">
<article ng-show="showReference">
<h1>{{module[0].toUpperCase() + module.substr(1)}}</h1>
<h3 class="sub-heading">
<div class="toggler" ng-click="showGcloudDocs = !showGcloudDocs">
<span class="toggle" ng-hide="showGcloudDocs">▹</span>
<span class="toggle" ng-show="showGcloudDocs">▿</span>
</div>
Getting Started with <code>gcloud</code>
</h3>
<h3 class="sub-heading">
<div class="toggler" ng-click="showGcloudDocs = !showGcloudDocs">
<span class="toggle" ng-hide="showGcloudDocs">▹</span>
<span class="toggle" ng-show="showGcloudDocs">▿</span>
</div>
Getting Started with <code>gcloud</code>
</h3>
<article ng-if="showGcloudDocs">
<h1>{{module[0].toUpperCase() + module.substr(1)}}</h1>
<p>
First, install <code>gcloud</code> with npm and require it into your project:
</p>
Expand Down Expand Up @@ -59,40 +57,32 @@ <h1>{{module[0].toUpperCase() + module.substr(1)}}</h1>
</p>
</article>
<hr>

<article ng-if="isActiveDoc('datastore')">
<h2>Overview</h2>
<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>
<div hljs>
var datastore = gcloud.datastore;
var dataset = datastore.dataset({
projectId: 'myProject',
keyFilename: '/path/to/keyfile.json'
</div>
<p ng-if="!isActiveUrl('/docs/datastore/dataset')">
See <a href="#/docs/{{version}}/datastore/dataset">the Dataset documentation</a> for examples of how to query the datastore, save entities, run a transaction, and others.
</p>
</article>

<article ng-if="isActiveDoc('storage')">
<p>
The <code>gcloud.storage</code> object contains a <code>Bucket</code> object, which is how you will interact with your Google Cloud Storage bucket.
</p>
<div hljs>
var storage = gcloud.storage;
var bucket = new storage.Bucket({
bucketName: 'MyBucket'
});</div>
var datastore = gcloud.datastore;
var dataset = datastore.dataset({
projectId: 'myProject',
keyFilename: '/path/to/keyfile.json'
});</div>
<p ng-if="!isActiveUrl('/docs/datastore/dataset')">
See <a href="#/docs/datastore/dataset">the Dataset documentation</a> for examples of how to query the datastore, save entities, run a transaction, and others.
See <a href="#/docs/{{version}}/datastore/dataset">the Dataset documentation</a> for examples of how to query the datastore, save entities, run a transaction, and others.
</p>
</article>

<article ng-if="isActiveDoc('storage')">
<h2>Overview</h2>
<h3>Storage Overview</h3>
<p>
The <code>gcloud.storage</code> object contains a <code>bucket</code> object, which is how you will interact with your Google Cloud Storage bucket. See the guide on <a href="https://developers.google.com/storage">Google Cloud Storage</a> to create a bucket.
</p>
<div hljs>
var bucket = gcloud.storage.bucket({
bucketName: 'MyBucket'
});</div>
<p>
See examples below for more on how to access your bucket to upload a file, read its files, create signed URLs, and more.
</p>
Expand All @@ -117,10 +107,12 @@ <h2 ng-if="method.name[0].toUpperCase() === method.name[0]">
<h4 ng-show="method.params">Parameters</h4>
<table class="table" ng-show="method.params">
<tbody>
<tr ng-repeat="param in method.params">
<tr
ng-repeat="param in method.params"
ng-class="{ 'param-optional': param.optional }">
<th scope="row">{{param.name}}</th>
<td ng-bind-html="param.types"></td>
<td ng-bind-html="param.description"></td>
<td class="param-types" ng-bind-html="param.types"></td>
<td class="param-description" ng-bind-html="param.description"></td>
</tr>
</tbody>
</table>
Expand All @@ -146,14 +138,14 @@ <h4 ng-show="method.example">Example</h4>
<ul class="page-sections" ng-show="showReference">
<li ng-repeat="page in pages">
<a
ng-class="{ current: docs.isActiveUrl(page.url) }"
ng-class="{ current: isActiveUrl(page.url) }"
ng-href="{{page.url}}">
{{page.title}}
</a>
<ul class="sub-sections" ng-if="page.pages">
<li ng-repeat="innerPage in page.pages">
<a
ng-class="{ current: docs.isActiveUrl(page.url + innerPage.url) }"
ng-class="{ current: isActiveUrl(page.url + innerPage.url) }"
ng-href="{{page.url + innerPage.url}}">
{{innerPage.title}}
</a>
Expand Down
15 changes: 9 additions & 6 deletions docs/components/docs/docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ angular
formatHtml(tag.description.replace(/^- /, '')));
tag.types = $sce.trustAsHtml(tag.types.reduceRight(
reduceModules, []).join(', '));
tag.optional = tag.types.toString().substr(-1) === '=';
return tag;
}),
returns: obj.tags.filter(function(tag) {
Expand Down Expand Up @@ -197,15 +198,16 @@ angular
}
});
})

.controller('DocsCtrl', function($location, $scope, $routeParams, methods, $http, versions) {
'use strict';

$scope.isActiveUrl = function(url) {
var current = $location.path().replace('/' + methods.singleMethod, '');
var link = url
.replace(/^#/, '')
.replace('/' + methods.singleMethod, '');
return current === link;
var active = $location.path()
.replace('/' + methods.singleMethod, '')
.replace('/' + $scope.version, '');
url = url.replace('#', '').replace('/' + $scope.version, '');
return active === url;
};

$scope.isActiveDoc = function(doc) {
Expand Down Expand Up @@ -252,7 +254,8 @@ angular
}
];
})
.controller("HistoryCtrl", function($scope, versions) {

.controller('HistoryCtrl', function($scope, versions) {
$scope.pageTitle = 'Node.js Docs Versions';
$scope.showHistory = true;
$scope.versions = versions;
Expand Down
Empty file removed docs/components/docs/history.html
View file
Open in desktop
Empty file.
12 changes: 11 additions & 1 deletion docs/css/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,16 @@ h2, h3 {
border-bottom: 1px solid rgba(0,0,0,0.05);
}

.param-optional .param-types {
font-style: italic;
}

.param-optional .param-description:before {
content: "optional. ";
color: #aaa;
font-style: italic;
}

.method-heading {
position: relative;
}
Expand All @@ -627,7 +637,7 @@ h2, h3 {

.sub-heading {
color: #5d6061;
margin: 0;
margin: 0 !important;
}

.toggler {
Expand Down