Make doesnt work, files are update anyways

SmartPlastic · Sep 21, 2019 · 63608e9 · 63608e9
1 parent ef95dd0
commit 63608e9
Show file tree

Hide file tree

Showing 18 changed files with 188 additions and 123 deletions.
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/Docs.iml b/.idea/Docs.iml
diff --git a/.idea/dictionaries/flo.xml b/.idea/dictionaries/flo.xml
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,9 +24,9 @@
 author = 'Florian Hauser & Thomas Lenz (HauserLenz)'
 
 # The short X.Y version
-version = 'v0.2'
+version = 'v0.3'
 # The full version, including alpha/beta/rc tags
-release = 'v0.2.2-alpha'
+release = 'v0.3.0-alpha'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/content/app/information.rst b/docs/content/app/information.rst
@@ -1,5 +1,7 @@
-###########################
-The information tab (empty)
-###########################
+The information tab
+===================
 
-Content to follow ...
+Here you can see all infos created by the authors of the SmartPlastic app team.
+These infos will always be visible, although they will get grouped if there are too many.
+We plan to add a feature to filter for a specific name, topic or content so that you can
+find specific information more easily.
diff --git a/docs/content/app/tracker.rst b/docs/content/app/tracker.rst
@@ -1,5 +1,8 @@
-#######################
-The tracker tab (empty)
-#######################
+The tracker tab
+===============
 
-Content to follow
+In this menu you can track your so called "SmartPlastic Score": Estimating a value for the plastic you
+threw away, categorizing it as easy as in three sizes: Small, Medium and Large, you can keep track of
+your plastic usage and strive to reduce the amount continuously. As soon as multiple scores across
+different countries have added up, we will publish some interesting statistics, strategies to reduce
+ones plastic usage and some experience reports.
diff --git a/docs/content/home/about-us.rst b/docs/content/home/about-us.rst
@@ -1,7 +1,29 @@
-.. _team: https://smartplastic.readthedocs.io/en/latest/content/home/team.html
-
 About us
 ========
 
-While this article is under construction, refer to the team_ article for
-further information about us.
+We, Florian Hauser and Thomas Lenz, started SmartPlastic in August 2018.
+We have been asked to create the SmartPlastic app for the Erasmus project by
+one of our teachers and started thinking about it. In Germany, you can do a
+special scientific work called *BLL* (which roughly translates to
+*Special-Study-Accomplishment*) and thus earn points for your graduation.
+We decided to create the app and make it the subject of this scientific work we
+need to turn in before July 2019.
+
+Before starting this project, we have been coding for fun using different
+languages, but haven't heard of ``reStructuredText``, haven't have any
+experience dealing with server hosting nor dived into ``Python`` this deeply.
+As this app is literally *tons of work*, we are happy for every helping hand we
+can reach out to, and as you can see with us as an example, it doesn't even take
+any precognitions. Writing or translating documentation doesn't require any
+coding experience at all (besides rest markup, but that's easy, duh), and we
+also need people for ``HTML`` and ``CSS`` styling the WebApp, too.
+
+We are happy that we are dealing with a topic with such a great importance.
+Environmental protection is important to us, and this is how we thought of
+"We are not just into this, we are up for the cause." as our project's caption.
+We are looking forward to working together with great companies like the
+`WWF <https://wwf.org>`__ or `Parley <https://parley.tv>`__ during the project.
+
+You are always welcome to start a little chat with us, just visit
+`the interface <https://smartplastic.cloud>`__ where you will be able to find
+our email addresses and GitHub usernames!
diff --git a/docs/content/home/beta.rst b/docs/content/home/beta.rst
@@ -0,0 +1,73 @@
+Beta Testing
+############
+
+.. sidebar:: iOS screenshots
+
+    .. image:: /resources/TestflightScreens/2_invitation_email.png
+        :alt: Picture of email
+
+    *The invitation email you get after messaging us.*
+
+    .. image:: /resources/TestflightScreens/1_empty_testflight.png
+        :alt: Picture of Testflight
+
+    *Testflight might be empty after installing it - simply click on the link again to bring up SmartPlastic*
+
+    .. image:: /resources/TestflightScreens/3_before_installation.png
+        :alt: Picture of SmartPlastic in Testflight
+
+    *The SmartPlastic app's Testflight page should look similar to this - press "INSTALL" to proceed*
+
+    .. image:: /resources/TestflightScreens/4_after_installation.png
+        :alt: Picture of installed app
+
+    *Finally, you should have the app installed as usual on your device.*
+
+
+Currently, we provide a beta app for both the Android and iOS powered
+mobile phones. If you are prompted for log in credentials, use ``test`` as
+the username and ``Erasmus+`` as the password.
+To install the beta, follow the steps below:
+
+Android beta
+************
+
+#. Make sure your Android version is ``5.0`` or higher.
+   You can find your version number in your phone's settings.
+#. Follow `this link <https://play.google.com/apps/testing/eu.smartplastic.smartplastic>`__ on your mobile to get to the beta entrance website. On this
+   website, press the button to enter beta (you may need to authenticate with
+   your Google account)
+#. After the successfull entry, you'll be able to find the app in your usual
+   Play Store by searching for "SmartPlastic". Download it, and it should appear
+   on your home screen or the apps list. You are now able to start the app.
+
+
+iOS beta
+********
+
+#. Make sure your iOS version is ``9.0`` or higher. You can find your version
+   number in your phone's settings: ``Settings > General > About > Version``.
+#. Send an E-Mail to lenz@smartplastic.eu. Please provide (1) your Apple-ID
+   and (2) your full name.
+#. You will be added to the beta tester group and receive an email that should
+   look somewhat similar to the one on the right.
+#. Click the link inside the email adress. You will be redirected to a page
+   that offers you to enter the beta upon installing the App ``Testflight``.
+#. Download ``Testflight`` from your iPhone's App Store and click the link in
+   email again if the SmartPlastic beta doesn't show up in the app.
+#. Inside ``Testflight``, download SmartPlastic. It should appear on your homescreen
+   and feature a red dot left of the name to signal that it's a beta
+   application. Now you can click on the app and enjoy.
+
+
+Troubleshooting
+***************
+
+Right now, there are no known errors that could impact the installation of the
+SmartPlastic beta. If you face a problem, write us an email:
+
+* Message hauser@smartplastic.eu for Android support ...
+* ... or lenz@smartplastic.eu for iOS support.
+* If you get a general question regarding the beta app and haven't found a
+  useful answer in the FAQ, contact hello@smartplastic.eu for any further
+  assistance.
diff --git a/docs/content/home/changelog.rst b/docs/content/home/changelog.rst
@@ -1,6 +1,9 @@
 Changelog
 =========
 
+For more recent versions, see the `GitHub releases <https://github.com/SmartPlastic/Django/releases>`__ page.
+Be aware that you need authorization to access this website.
+
 v0.2.3-alpha
 ------------
 

diff --git a/docs/content/home/jointstafftraining.rst b/docs/content/home/jointstafftraining.rst
@@ -64,76 +64,7 @@ hello@smartplastic.eu and you will be added to the GitHub org as well.
 Installing the beta app
 -----------------------
 
-.. sidebar:: iOS screenshots
-
-    .. image:: /resources/TestflightScreens/2_invitation_email.png
-        :alt: Picture of email
-
-    *The invitation email you get after messaging us.*
-
-    .. image:: /resources/TestflightScreens/1_empty_testflight.png
-        :alt: Picture of Testflight
-
-    *Testflight might be empty after installing it - simply click on the link again to bring up SmartPlastic*
-
-    .. image:: /resources/TestflightScreens/3_before_installation.png
-        :alt: Picture of SmartPlastic in Testflight
-
-    *The SmartPlastic app's Testflight page should look similar to this - press "INSTALL" to proceed*
-
-    .. image:: /resources/TestflightScreens/4_after_installation.png
-        :alt: Picture of installed app
-
-    *Finally, you should have the app installed as usual on your device.*
-
-
-Currently, we provide a beta app for both the Android and iOS powered
-mobile phones. If you are prompted for log in credentials, use ``test`` as
-the username and ``Erasmus+`` as the password.
-To install the beta, follow the steps below:
-
-Android beta
-************
-
-#. Make sure your Android version is ``5.0`` or higher.
-   You can find your version number in your phone's settings.
-#. Follow `this link <https://play.google.com/apps/testing/eu.smartplastic.smartplastic>`__ on your mobile to get to the beta entrance website. On this
-   website, press the button to enter beta (you may need to authenticate with
-   your Google account)
-#. After the successfull entry, you'll be able to find the app in your usual
-   Play Store by searching for "SmartPlastic". Download it, and it should appear
-   on your home screen or the apps list. You are now able to start the app.
-
-
-iOS beta
-********
-
-#. Make sure your iOS version is ``9.0`` or higher. You can find your version
-   number in your phone's settings: ``Settings > General > About > Version``.
-#. Send an E-Mail to lenz@smartplastic.eu. Please provide (1) your Apple-ID
-   and (2) your full name.
-#. You will be added to the beta tester group and receive an email that should
-   look somewhat similar to the one on the right.
-#. Click the link inside the email adress. You will be redirected to a page
-   that offers you to enter the beta upon installing the App ``Testflight``.
-#. Download ``Testflight`` from your iPhone's App Store and click the link in
-   email again if the SmartPlastic beta doesn't show up in the app.
-#. Inside ``Testflight``, download SmartPlastic. It should appear on your homescreen
-   and feature a red dot left of the name to signal that it's a beta
-   application. Now you can click on the app and enjoy.
-
-
-Troubleshooting
-***************
-
-Right now, there are no known errors that could impact the installation of the
-SmartPlastic beta. If you face a problem, write us an email:
-
-* Message hauser@smartplastic.eu for Android support ...
-* ... or lenz@smartplastic.eu for iOS support.
-* If you get a general question regarding the beta app and haven't found a
-  useful answer in the FAQ, contact hello@smartplastic.eu for any further
-  assistance.
+To participate in beta-testing, follow our `guide <https://smartplastic.readthedocs.io/en/latest/content/home/beta.html>`__.
 
 Downloads
 ---------

diff --git a/docs/content/home/team.rst b/docs/content/home/team.rst
diff --git a/docs/content/interface/information.rst b/docs/content/interface/information.rst
@@ -1,5 +1,7 @@
-###################
 Information (empty)
-###################
+===================
 
-Content to follow...
+The information tab is to add static information, that separates from articles by their
+"timeless" status. While articles should be editorial content that have up-to-dateness,
+info tabs should feature content that will not change and is information not associated
+with special real-world events or a specific time.
diff --git a/docs/content/interface/registration.rst b/docs/content/interface/registration.rst
@@ -0,0 +1,16 @@
+Registering a new account in the Interface
+==========================================
+
+To create a new account for your students, ask them to visit
+`https://smartplastic.cloud/accounts/register <https://smartplastic.cloud/accounts/register>`__
+and let them fill in the information. Remind them to fill in all information in English,
+this is needed for the app to work correctly. The "Description" field will be displayed below
+every article published by the student, so it should be informative but kept short. All information,
+including the password, can be changed at any time. After they filled out the form and sent it to
+our server, they need to tell you their username, with which you are able to promote them through
+your admin interface access: Navigate to `https://smartplastic.cloud/admin <https://smartplastic.cloud/admin>`__,
+log in with your credentials, visit the "Groups" tab and add them to the "authors" group - now they should be
+able to log into the interface and create articles.
+
+Should your student have forgotten his or her password, you can reset it by logging into the admin panel,
+clicking on users, selecting the student and click on the form below they username.
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,7 @@ to take an active (coding) part in the project to dive in.
 
 If you got any questions going beyond what is mentioned in the documentation,
 feel free to say hi to us via email (find them on the
-`interface's website <http://interface.smartplastic.eu>`__).
+`interface's website <https://smartplastic.cloud>`__).
 
 Greetings from Germany!
 
@@ -28,9 +28,9 @@ Florian & Thomas
     :hidden:
 
     content/home/about-us.rst
-    content/home/team.rst
     content/home/changelog.rst
     content/home/jointstafftraining.rst
+    content/home/beta.rst
     content/home/faq.rst
 
 .. toctree::
@@ -42,6 +42,7 @@ Florian & Thomas
    content/interface/tracker.rst
    content/interface/map.rst
    content/interface/information.rst
+   content/interface/registration.rst
 
 .. toctree::
     :maxdepth: 1