Skip to content
This repository has been archived by the owner on Mar 7, 2018. It is now read-only.

Improved the Dashing gh-page navigation #384

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open
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
6 changes: 3 additions & 3 deletions css/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ code {
}
a {
display: block;
padding: 12px 30px;
padding: 12px 24px;
text-decoration: none;
color: #222;
&:hover {
Expand All @@ -156,14 +156,14 @@ code {
float: right;
margin: 0 5px 0 0;
display: block;
width: 250px;
width: 180px;
height: 50px;
line-height: 50px;
text-align: center;
background-color: #1975bc;
border: 1px darken(#1975bc, 10%) solid;
text-shadow: 0 1px 0 darken(#1975bc, 12%);
font-size: 18px;
font-size: 16px;
font-family: 'Quando', serif;
font-weight: 300;
color: #fff;
Expand Down
31 changes: 24 additions & 7 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,9 @@
<nav id="main-navigation">
<ul class="clearfix">
<li><a href="#overview">Introduction</a></li>
<li><a href="http://dashingdemo.herokuapp.com/sample" target="_blank">Demo</a></li>
<li><a href="#setup">Getting Started</a></li>
<li><a href="#widgets">Example Setup</a></li>
<li><a href="#data">API</a></li>
<li><a href="#usage">Usage: Dashboard</a></li>
<li><a href="#data">Usage: Jobs and Widgets</a></li>
<li><a href="#license">License</a></li>
<li><a href="https://github.com/Shopify/dashing/issues" target="_blank">Issues</a></li>
</ul>
Expand All @@ -52,6 +51,7 @@ <h2>The exceptionally handsome dashboard framework.</h2>
<div id="actions">
<a class="button" href="https://github.com/Shopify/dashing" target="_blank"><i class="icon-github"></i> View on Github</a>
<a class="button" href="https://github.com/Shopify/dashing/zipball/master"><i class="icon-download"></i> Download ZIP</a>
<a class="button" href="http://dashingdemo.herokuapp.com/sample" target="_blank"><i class="icon-dashboard"></i> Try demo</a>
</div>
<div id="actions-github">
<iframe src="http://ghbtns.com/github-btn.html?user=shopify&repo=dashing&type=fork&count=false"
Expand All @@ -70,7 +70,7 @@ <h3 class="section-title">Introduction</h3>

<p><strong>Key features:</strong>
<ul>
<li>Use premade widgets, or fully create your own with scss, html, and coffeescript.</li>
<li>Use <a href="#widgets">premade widgets</a>, or fully create your own with scss, html, and coffeescript.</li>
<li>Widgets harness the power of data bindings to keep things DRY and simple. Powered by <a href="http://batmanjs.org/" target="_blank">batman.js</a>.</li>
<li>Use the API to push data to your dashboards, or make use of a simple ruby DSL for fetching data.</li>
<li>Drag & Drop interface for re-arranging your widgets.</li>
Expand Down Expand Up @@ -120,8 +120,8 @@ <h3 class="section-title">Getting Started</h3>
</div>
</section>

<section class="section-box" id="widgets">
<h3 class="section-title">Example Dashboard</h3>
<section class="section-box" id="usage">
<h3 class="section-title">Usage: Dashboard</h3>
<div class="section-content">
Here's a sample dashboard with 2 widgets. With a name of <code>sample.erb</code>, it becomes accessible at <code>/sample</code>.
<br/>
Expand Down Expand Up @@ -170,7 +170,7 @@ <h4 id="positioning">Laying out the widgets</h4>
</section>

<section class="section-box" id="data">
<h3 class="section-title">Getting Data Into Your Widgets</h3>
<h3 class="section-title">Usage: Jobs and Widgets</h3>
<div class="section-content">

<p>Providing data to widgets is easy. You specify which widget you want using a widget id, and then pass in the JSON data. There are two ways to do this:</p>
Expand Down Expand Up @@ -214,6 +214,23 @@ <h6>Example</h6>

<script src="https://gist.github.com/davefp/6112780.js?file=curl2.sh"></script>

<h4>Widgets</h4>

<p>Dashing comes with few re-usable widgets (reminder: <i>data-view="WidgetName"</i> in dashboard defines the used widget):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO, this should read:
Dashing comes with a few re-usable widgets, which can be used as indicated above

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback. I surely can update the PR - assumed no one was interested merging it (as this is almost year old)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I am going through all the old PRs and trying to triage it a bit for the maintainer(s).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I wasn't implying you had to be the one to make the updates -- just that these are the updates I recommend. Thanks!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'm pretty much fine with any additional change (while still holding the original idea of three items mentioned in PR). So go ahead, you have my blessing 👍

<ul>
<li>clock</li>
<li>comments</li>
<li>graph</li>
<li>iframe</li>
<li>image</li>
<li>list</li>
<li>meter</li>
<li>number</li>
<li>text</li>
</ul>
</p>
<p>In addition, there are a <a href="https://github.com/Shopify/dashing/wiki/Additional-Widgets">lot of 3rd party widgets available</a> - and you're welcome to contribute more!</p>

</div>
</section>

Expand Down
6 changes: 3 additions & 3 deletions style.css
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ code {
margin: 2px 6px 0 0; }
#main-navigation a {
display: block;
padding: 12px 30px;
padding: 12px 24px;
text-decoration: none;
color: #222; }
#main-navigation a:hover {
Expand All @@ -225,14 +225,14 @@ code {
float: right;
margin: 0 5px 0 0;
display: block;
width: 250px;
width: 180px;
height: 50px;
line-height: 50px;
text-align: center;
background-color: #1975bc;
border: 1px #13598f solid;
text-shadow: 0 1px 0 #125386;
font-size: 18px;
font-size: 16px;
font-family: 'Quando', serif;
font-weight: 300;
color: #fff;
Expand Down