Skip to content

Commit

Permalink
Merge branch 'master' of github.com:d45/ProjectFrelard
Browse files Browse the repository at this point in the history
pulling in Brendan's community page changes
  • Loading branch information
d45 committed Oct 6, 2017
2 parents dc54313 + 5a774fa commit 05ebbc7
Show file tree
Hide file tree
Showing 10 changed files with 274 additions and 77 deletions.
125 changes: 125 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.9)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.4.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
colorator (0.1)
ethon (0.10.1)
ffi (>= 1.3.0)
execjs (2.7.0)
faraday (0.9.2)
multipart-post (>= 1.2, < 3)
ffi (1.9.18)
gemoji (2.1.0)
github-pages (80)
github-pages-health-check (= 1.1.0)
jekyll (= 3.1.6)
jekyll-coffeescript (= 1.0.1)
jekyll-feed (= 0.5.1)
jekyll-gist (= 1.4.0)
jekyll-github-metadata (= 1.11.1)
jekyll-mentions (= 1.1.2)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.10.0)
jekyll-sass-converter (= 1.3.0)
jekyll-seo-tag (= 1.4.0)
jekyll-sitemap (= 0.10.0)
jemoji (= 0.6.2)
kramdown (= 1.10.0)
liquid (= 3.0.6)
listen (= 3.0.6)
mercenary (~> 0.3)
rouge (= 1.10.1)
terminal-table (~> 1.4)
github-pages-health-check (1.1.0)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 1.4)
typhoeus (~> 0.7)
html-pipeline (2.4.1)
activesupport (>= 2, < 5)
nokogiri (>= 1.4)
i18n (0.8.6)
jekyll (3.1.6)
colorator (~> 0.1)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-feed (0.5.1)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-github-metadata (1.11.1)
octokit (~> 4.0)
jekyll-mentions (1.1.2)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.10.0)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-seo-tag (1.4.0)
jekyll (~> 3.0)
jekyll-sitemap (0.10.0)
jekyll-watch (1.4.0)
listen (~> 3.0, < 3.1)
jemoji (0.6.2)
gemoji (~> 2.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
kramdown (1.10.0)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9.7)
mercenary (0.3.6)
mini_portile2 (2.0.0)
minitest (5.10.3)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.6.7.2)
mini_portile2 (~> 2.0.0.rc2)
octokit (4.3.0)
sawyer (~> 0.7.0, >= 0.5.3)
public_suffix (1.5.3)
rb-fsevent (0.10.2)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (1.10.1)
safe_yaml (1.0.4)
sass (3.4.22)
sawyer (0.7.0)
addressable (>= 2.3.5, < 2.5)
faraday (~> 0.8, < 0.10)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.3)
thread_safe (~> 0.1)
unicode-display_width (1.3.0)

PLATFORMS
ruby

DEPENDENCIES
github-pages

BUNDLED WITH
1.12.5
28 changes: 5 additions & 23 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,19 @@
# Site settings
title: Project Frelard
email: git@tableau.com
title: Tableau Extensions API
email: github@tableau.com
description: Create add-ins to extend the functionality of Tableau.
repository: d45/tableau.github.io
# baseurl: "/extensions-api"
baseurl: "/dave2/extensions-api"
# host: 127.0.0.1
host: "http://onlinehelp.tsi.lan"
# host: "http://tableau.github.io"
# permalink: pretty

baseurl: "/ProjectFrelard"
permalinks: pretty
defaults:
-
scope:
path: "" # Apply to all files
type: pages
values:
layout: "default"
permalink: /:path/:basename:output_ext
# scope:
# type: pages
# values:
# permalink: /:path/:basename:output_ext

# Build settings
markdown: kramdown
highlighter: rouge
github: [metadata]

kramdown:
toc_levels: 1..3

# Exclude
exclude: ['node_modules', 'Examples']


exclude: ['node_modules']
3 changes: 3 additions & 0 deletions _includes/docs_menu.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
<li>
<a href="{{ site.baseurl }}/docs/trex_debugging.html">Remote Debugging of JavaScript and HTML</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/trex_contributing.html">Hosting and Contributing to the Community Portal</a>
</li>

<li class="nav-header">Reference</li>
<li>
Expand Down
1 change: 1 addition & 0 deletions _includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
<li><a href="{{ site.baseurl }}/docs/trex_getstarted.html">Docs</a></li>
<li><a href="{{ site.baseurl }}/docs/index.html" target="_blank">API Reference</a></li>
<li><a href="{{ site.baseurl }}/docs/trex_examples.html">Samples</a></li>
<li><a href="{{ site.baseurl }}/community/">Community Extensions</a></li>
<li><a target="_blank" href="https://community.tableau.com/community/developers/">Forum</a></li>
<li><a href="{{ site.baseurl }}/docs/trex_release-notes.html">Release Notes</a></li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions _layouts/community.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ <h2>{{ page.title }}</h2>
</header>
<div class="row">
<div id="grid" data-columns>
<!-- dynamically loaded from community/community_connectors.json -->
<!-- dynamically loaded from community/community_extensions.json -->
</div>
</div>

<script src="{{ site.baseurl }}/assets/js/salvattore.min.js"></script>
<script src="{{ site.baseurl }}/assets/js/community_connectors.js"></script>
<script src="{{ site.baseurl }}/assets/js/community_extensions.js"></script>
{% include footer.html %}
</div>
</body>
Expand Down
52 changes: 0 additions & 52 deletions assets/js/community_connectors.js

This file was deleted.

52 changes: 52 additions & 0 deletions assets/js/community_extensions.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
function append(extension) {
var grid = document.querySelector('#grid');
var item = document.createElement('div');

var h = '<div>';
h += '<div class="thumbnail">';
h += '<div class="extension_title">';
h += '<h2><a href="' + extension.url + '" alt="extension Link">' + extension.name + '</a>';
h += '</div>';
h += '<div class="caption">';

if (extension.github_username) {
h += '<p><b>Written by: </b><a href="https://github.com/' + extension.github_username + '" alt="GH Link">' + extension.author + '</a></p>';
} else {
h += '<p><b>Written by: </b>' + extension.author + '</p>';
}

if (extension.source_code) {
h += '<p><a href="' + extension.source_code + '" alt="Source code link">Source Code Available</a></p>';
}

if (extension.description) {
h += '<p><b>Description: </b>' + extension.description + '</p>';
}

if (extension.tags) {
extension.tags.forEach(function(tag) {
h += '<span class="label label-pill label-primary">' + tag + '</span>';
});
}

h += '</div>';
h += '</div>';

salvattore['append_elements'](grid, [item]);
item.outerHTML = h;
}

function extensionSort(a , b) {
if (a.name.toLowerCase() < b.name.toLowerCase()) {
return -1;
}

return 1;
}

$.getJSON("./community_extensions.json", function(data) {
var sorted = data.sort(extensionSort);
$(sorted).each(function(i, extension) {
append(extension);
});
});
20 changes: 20 additions & 0 deletions community/community_extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[
{
"name": "Sample Extension1",
"url": "http://extensions.com/sample1.html",
"author": "Cool Person",
"github_username": "coolPerson",
"tags": ["v_1.0"],
"description": "A cool extension",
"source_code": "https://github.com/cool/Extension"
},
{
"name": "Sample Extension2",
"url": "http://extensions.com/sample2.html",
"author": "Cool Person",
"github_username": "coolPerson2",
"tags": ["v_12.0"],
"description": "Another cool extension",
"source_code": "https://github.com/cool/Extension2"
}
]
11 changes: 11 additions & 0 deletions community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Community Portal
layout: community
---

The following extensions have been written by the Tableau Community and made available to use. Click on the extension to download the `.trex` file, then copy that file to `~\Documents\My Tableau Repository (Beta)\Extensions` to use the extension in Tableau. If you write an extension, [please contribute!]({{ site.baseurl }}/docs/trex_contributing)



**Important:** These extensions are not written by or supported by Tableau. If you encounter an issue with one of the extensions here, please reach out to the developer.

55 changes: 55 additions & 0 deletions docs/trex_contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Hosting and Contributing to the Community Portal
layout: docs
---

Submit your extension to the [Community Extension]({{ site.baseurl }}/community/)
portal to share your work with other developers. To make it easier for others to use your extension,
we ask that you include a link to a hosted version of your extension.

If you don't have a hosted version yet, see our [suggestions for hosting](#hosting).

Submitting to the Community Portal {#portal}
----------------------------------

**Note:** Before you submit a extension, you'll need a GitHub account.

1. Create a fork of the `extensions-api` repository.

2. In your fork of the repository, checkout the `submissions` branch.

3. In your fork of the repository, find the community folder at the root of the repository.

4. In the `community_extensions.json` file, add an entry for your extension. All fields are required.

5. Add the manifest file (`.trex`) for your extension to the `community/manifests` folder.

6. Submit a pull request from the submissions branch of your fork, to the submissions branch in the offical repository.


After that, a member of the Tableau Extensibiltiy team will review your submission.

Suggestions for hosting your extension {#hosting}
---------------------------------------

There are several free hosting services that you can use for your extension. You can host
your extension anywhere you please, but we have two suggested locations that we have
seen to be the easiest to use.

1. Host your static content on GitHub pages.

If your extension is composed of client-side code only (just HTML/CSS/JS files),
you can host your content for free on GitHub Pages (This is actually what's hosting the documentation
you are currently reading!).

GitHub Pages makes it really easy to host content, especially if your extension code
is already on GitHub. Check out their tutorial for details: [pages.github.com/](https://pages.github.com)

2. Host your node app on Heroku.

If your extension contains a sever component, like the Node Proxy sample,
you can host your extension for free on Heroku. There are certain usage restrictions; for example,
their free tier requires the extension to be offline for a few hours a day.

Check out their tutorial for more details:
[Heroku Tutorial](https://devcenter.heroku.com/articles/getting-started-with-nodejs#introduction)

0 comments on commit 05ebbc7

Please sign in to comment.