revised documentation

polifonia-project · Jun 9, 2022 · 6436aab · 6436aab
1 parent 252456e
commit 6436aab
Show file tree

Hide file tree

Showing 18 changed files with 166 additions and 152 deletions.
diff --git a/app.py b/app.py
@@ -1,7 +1,7 @@
 from flask import Flask, render_template, request, url_for, redirect, session
 from flask_session import Session
 import json
-import github_sync
+import github_sync , conf
 
 app = Flask(__name__)
 app.config["SESSION_PERMANENT"] = False

diff --git a/documentation/getting_started.html b/documentation/getting_started.html
@@ -46,7 +46,7 @@ <h2 class="text-lg sm:text-xl text-gray-900 font-medium title-font mb-2">Get the
                             <p>Download the latest release<a class="reference external" href=""></a>:</p>
                             <div class="highlight-bash notranslate">
                                 <div class="highlight">
-                                    <code id="codecell0"><span></span>to be added</code>
+                                    <code id="codecell0"><span></span>https://github.com/polifonia-project/dashboard/releases</code>
                                 </div>
                             </div>
                         </div>
@@ -286,4 +286,4 @@ <h2 class="title-font font-medium text-gray-900 tracking-widest text-sm mb-3">CA
         crossorigin="anonymous"></script>
 </body>
 
-</html>
+</html>
diff --git a/documentation/img/barchart1.png b/documentation/img/barchart1.png
diff --git a/documentation/img/barchart2.png b/documentation/img/barchart2.png
diff --git a/documentation/img/count.png b/documentation/img/count.png
diff --git a/documentation/img/donut.png b/documentation/img/donut.png
diff --git a/documentation/img/final1.png b/documentation/img/final1.png
diff --git a/documentation/img/final2.png b/documentation/img/final2.png
diff --git a/documentation/img/home.png b/documentation/img/home.png
diff --git a/documentation/img/setup.png b/documentation/img/setup.png
diff --git a/documentation/img/setup1.png b/documentation/img/setup1.png
diff --git a/documentation/img/setup2.png b/documentation/img/setup2.png
diff --git a/documentation/img/setup3.png b/documentation/img/setup3.png
diff --git a/documentation/img/story1.png b/documentation/img/story1.png
diff --git a/documentation/img/story2.png b/documentation/img/story2.png
diff --git a/documentation/style.css b/documentation/style.css
@@ -40,4 +40,7 @@ code {
 
 a:hover {
     color: #aec5b8;
-}
+}
+
+p {padding: 0.5em 0px;}
+h2 {padding-top: 2em;}
diff --git a/documentation/user_guide.html b/documentation/user_guide.html
diff --git a/index.html b/index.html
@@ -37,16 +37,16 @@ <h2 class="sm:text-3xl text-2xl text-green-500 font-medium title-font mb-2 md:w-
                 Data Visualization and Storytelling</h2>
             <div class="md:w-3/5 md:pl-6">
                 <p class="leading-relaxed text-base"><b>MELODY</b> - <i>Make mE a Linked Open Data StorY</i> is a
-                    dashboarding system that allows expert users to create web-ready data stories based on one or more
-                    Linked Open Dataset.
+                    dashboarding system that allows users familiar with Linked Open Data to create web-ready data stories.
+                    </p>
                 <ul style="list-style: inside;" class="mb-3 pl-3">
+                    <li>Authenticate with <b>GitHub</b> to create a new story.</li>
                     <li>Access data from <b>any SPARQL endpoint</b>.</li>
-                    <li><b>Link or export</b> the data story in several formats.</li>
-                    <li>Choose among different <b>layout templates</b>.</li>
-                    <li>Choose among different types of <b>charts</b>.</li>
-                    <li>Understand what you are creating thanks to a <b>preview</b> mechanism.</li>
+                    <li>Select the <b>layout template</b> of your story.</li>
+                    <li>Include <b>charts</b>, sections, filters, and descriptions.</li>
+                    <li><b>Preview</b> the final data story while creating it.</li>
+                    <li><b>Embed or export</b> your data story and single charts in several formats.</li>
                 </ul>
-                </p>
             </div>
         </div>
     </section>
@@ -61,9 +61,7 @@ <h1 class="sm:text-3xl text-2xl font-medium title-font text-gray-900 mb-4">Make
                 <p class="text-base leading-relaxed xl:w-2/4 lg:w-3/4 mx-auto text-gray-500s"> MELODY is a flexible
                     software that
                     allows scholars to produce data stories via user-friendly interfaces. Data visualizations are
-                    produced by querying
-                    one or more SPARQL endpoints. So created charts are
-                    optionally accompanied by human-curated contents.
+                    produced by querying a SPARQL endpoints. Charts can be accompanied by curated contents.
                     <b>Discorver how to create your own!</b>
                 </p>
                 <div class="flex mt-6 justify-center">
@@ -297,4 +295,4 @@ <h2 class="title-font font-medium text-gray-900 tracking-widest text-sm mb-3">CA
         crossorigin="anonymous"></script>
 </body>
 
-</html>
+</html>