Skip to content

Commit

Permalink
Added FAIRshake insignia anatomy figure to documentation
Browse files Browse the repository at this point in the history 
References #101
  • Loading branch information
@u8sand
u8sand committed Jan 7, 2019
1 parent 65699e4 commit 1b699a5
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 66 deletions.
Binary file added FAIRshakeHub/static/image/insignia-anatomy.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
142 changes: 76 additions & 66 deletions FAIRshakeHub/templates/fairshake/documentation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,84 +3,94 @@
{% block content %}
<div class="container">
<h1 class="project-head text-left">Documentation</h1>

<h4>Tutorials</h4>
<ul>
<li>
<a href="https://www.youtube.com/playlist?list=PLdix4HBQmtjxCeDo3Px5GxRgXu4GxLotp">
Youtube tutorials about how to use FAIRshake
</a>
</li>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshake/blob/master/scripts/tutorial-pyswaggerclient.ipynb">
Python API Access with PySwaggerClient
</a>
</li>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshake/blob/master/scripts/tutorial-coreapi.ipynb">
Python API Access with CoreAPI
</a>
</li>
<li>
<a href="http://jsfiddle.net/tybx32gu/17/">
Insignia JS Fiddle Example
</a>
</li>
</ul>

<h4>Information</h4>
<ul>
<li>
<a href="{% url 'jsonschema_documentation' %}">
JSONSchema for Automated Assessments
</a>
</li>
</ul>

<h4>API Documentation Endpoints</h4>
<ul>
<li>
<a href="/swagger/">Swagger UI</a>

<div class="row">
<div class="col-sm-12 col-md-6 col-md-push-6">
<img
width="100%"
src="{% static 'image/insignia-anatomy.png' %}"
/>
</div>
<div class="col-sm-12 col-md-6 col-md-pull-6">
<h4>Tutorials</h4>
<ul>
<li>
<a href="/swagger/swagger.json">
swagger.json
<a href="https://www.youtube.com/playlist?list=PLdix4HBQmtjxCeDo3Px5GxRgXu4GxLotp">
Youtube tutorials about how to use FAIRshake
</a>
</li>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshake/blob/master/scripts/tutorial-pyswaggerclient.ipynb">
Python API Access with PySwaggerClient
</a>
</li>
<li>
<a href="/swagger/swagger.yml">
swagger.yml
<a href="https://github.com/Nitrogen-DCPPC/FAIRshake/blob/master/scripts/tutorial-coreapi.ipynb">
Python API Access with CoreAPI
</a>
</li>
<li>
<a href="http://jsfiddle.net/tybx32gu/17/">
Insignia JS Fiddle Example
</a>
</li>
</ul>

<h4>Information</h4>
<ul>
<li>
<a href="{% url 'jsonschema_documentation' %}">
JSONSchema for Automated Assessments
</a>
</li>
</ul>
</li>
<li>
<a href="/?format=api">Django Rest Framework API Explorer</a>
</li>
<li>
<a href="/coreapi/">CoreAPI UI</a>
</li>
<li>
<a href="http://smart-api.info/ui/8113167e81987d36b707ae4aa795b17e">SmartAPI</a>
</li>
</ul>

<h4>Github</h4>
<ul>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshake">FAIRshake</a>
<h4>API Documentation Endpoints</h4>
<ul>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshake/issues">Report an Issue</a>
<a href="/swagger/">Swagger UI</a>
<ul>
<li>
<a href="/swagger/swagger.json">
swagger.json
</a>
</li>
<li>
<a href="/swagger/swagger.yml">
swagger.yml
</a>
</li>
</ul>
</li>
<li>
<a href="/?format=api">Django Rest Framework API Explorer</a>
</li>
<li>
<a href="/coreapi/">CoreAPI UI</a>
</li>
<li>
<a href="http://smart-api.info/ui/8113167e81987d36b707ae4aa795b17e">SmartAPI</a>
</li>
</ul>

<h4>Github</h4>
<ul>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshake">FAIRshake</a>
<ul>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshake/issues">Report an Issue</a>
</li>
</ul>
</li>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRShake-chrome-extension">FAIRshake Chrome Extension</a>
</li>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshakeInsignia">FAIRshake Insignia Client Library</a>
</li>
</ul>
</li>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRShake-chrome-extension">FAIRshake Chrome Extension</a>
</li>
<li>
<a href="https://github.com/Nitrogen-DCPPC/FAIRshakeInsignia">FAIRshake Insignia Client Library</a>
</li>
</ul>
</div>
</div>
</div>
{% endblock %}

0 comments on commit 1b699a5

Please sign in to comment.