Skip to content

docs: add how to get help directive #583

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.

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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
<script src="site/components/docs/docs-values.js"></script>
<script src="site/components/authorization/authorization.js"></script>
<script src="site/components/faq/faq.js"></script>
<script src="site/components/how-to-get-help/how-to-get-help-directive.js"></script>
<script src="site/components/language-switcher/language-switcher-directive.js"></script>
<script src="site/components/subpage/subpage-directive.js"></script>
<script src="site/components/header/header-directive.js"></script>
Expand Down
2 changes: 2 additions & 0 deletions docs/site/components/faq/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@
header-templateUrl="faq-header.html"
title="FAQ">
<btf-markdown ng-include="'faq.md'"></btf-markdown>
<div how-to-get-help></div>
</div>

7 changes: 6 additions & 1 deletion docs/site/components/faq/faq.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
angular
.module('gcloud.faq', ['ngRoute', 'gcloud.subpage', 'btford.markdown'])
.module('gcloud.faq', [
'btford.markdown',
'ngRoute',
'gcloud.how-to-get-help',
'gcloud.subpage'
])
.config(function($routeProvider) {
'use strict';

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
angular
.module('gcloud.how-to-get-help', [])
.directive('howToGetHelp', function() {
'use strict';

return {
templateUrl: 'site/components/how-to-get-help/how-to-get-help.html',
};
});
27 changes: 27 additions & 0 deletions docs/site/components/how-to-get-help/how-to-get-help.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<div class="how-to-get-help--container subtle padding">
<h1 class="warning">I still need help!</h1>

<p>
Have a question you don't see? Hope is not lost! Follow these tips to find a quick resolution to your issue.
</p>

<h3>Ask the Community</h3>
<p>
If you have a question about how to use gcloud-node in your project or are stuck in the Developer's console and don't know where to turn, it's possible your questions have already been addressed by the community.
</p>

<p>
First, check out the <a href="http://stackoverflow.com/questions/tagged/gcloud-node"><code>gcloud-node</code> tag on StackOverflow</a>.
</p>
<p>
Next, try <a href="https://github.com/GoogleCloudPlatform/gcloud-node/issues?&q=">searching through our issues on GitHub</a>.
</p>
<p>
Still nothing?
</p>

<h3>Ask the Developers</h3>
<p>
If you're experiencing a bug with the code, or have an idea for how it can be improved, <em>please</em> <a href="https://github.com/GoogleCloudPlatform/gcloud-node/issues/new">create a new issue on GitHub</a> so we can talk about it.
</p>
</div>
1 change: 1 addition & 0 deletions docs/site/components/troubleshooting/troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@
header-templateUrl="troubleshooting-header.html"
title="Troubleshooting">
<btf-markdown ng-include="'troubleshooting.md'"></btf-markdown>
<div how-to-get-help></div>
</div>
7 changes: 6 additions & 1 deletion docs/site/components/troubleshooting/troubleshooting.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
angular
.module('gcloud.troubleshooting', ['ngRoute', 'gcloud.subpage', 'btford.markdown'])
.module('gcloud.troubleshooting', [
'btford.markdown',
'ngRoute',
'gcloud.how-to-get-help',
'gcloud.subpage'
])
.config(function($routeProvider) {
'use strict';

Expand Down
13 changes: 13 additions & 0 deletions docs/site/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,13 @@ ul {
margin: 10px 0;
}

.subtle {
background-color: #f8f8f8;
}

.warning {
color: #DB4437;
}


/* Header
Expand Down Expand Up @@ -688,6 +695,12 @@ ul {
display: block;
}

/*
How to Get Help Directive
*/
.how-to-get-help--container {
margin-top: 2em;
}

/* Docs Content
========================================================================== */
Expand Down