Skip to content

Commit

Permalink
Updated Sphinx doc for:
Browse files Browse the repository at this point in the history
1. Curation Workflow Diagram
2. gStudio implementation diagram for CLIx
3. Restructuring of index
  • Loading branch information
kedar2a committed Apr 18, 2018
1 parent 5903644 commit ad8a6aa
Show file tree
Hide file tree
Showing 10 changed files with 25 additions and 13 deletions.
2 changes: 1 addition & 1 deletion doc/source/CounterAnalyticsNotes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# gStudio Data
# Data

### [A]. [Quantitative data](counter-analytics-notes.html)
1. Comments
Expand Down
4 changes: 2 additions & 2 deletions doc/source/api.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
gstudio API
==========================
API
===

Providing version 1 ( ``v1`` ) API for gStudio, built with native python methods and mongo queries. In next version 2 ( ``v2`` ), we will be having comprehensive API's built on top of *Elastic-Search*.

Expand Down
4 changes: 2 additions & 2 deletions doc/source/cookie.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
gStudio Cookie
==============
Cookies
=======

**This document describes how gStudio creates/uses cookies**

Expand Down
Binary file added doc/source/curation-workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions doc/source/curation-workflow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Curation Workflow
=================

.. image:: curation-workflow.png
Binary file added doc/source/gStudio-CLIx-Implementation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions doc/source/gStudio-clix-integration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
gStudio for CLIx project
========================


.. image:: gStudio-CLIx-Implementation.png
5 changes: 3 additions & 2 deletions doc/source/gstudio-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ GStudio work with platforms that support OSID (http://osid.org/). A
python binding of DLKit (http://dlkit-doc.readthedocs.io/en/latest/) is
being used in collaboration with Office of the Digital Learning at MIT.

Design of the Platform
======================

Platform Design
===============

The platform is designed around Users, Workspaces and Apps to make and
publish digital resources.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/implementation/gstudio-lite.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# gStudio Lite
# gStudio-Lite
> Elastic Search & RCS implementation of gStudio

Expand Down
12 changes: 7 additions & 5 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,21 @@ Welcome to gstudio's documentation

gstudio-index
api
CounterAnalyticsNotes
dump-restore
quiz
cookie
curation-workflow
dump-restore
CounterAnalyticsNotes
data-collection
implementation/gstudio-lite
implementation/implementing-interactives
cookie
implementation/gstudio-lite
gStudio-clix-integration


.. toctree::
:hidden:

counter-analytics-notes.rst
.. counter-analytics-notes.rst
.. :titlesonly:
Expand Down

0 comments on commit ad8a6aa

Please sign in to comment.