diff --git a/Moderation/README.md b/Moderation/README.md deleted file mode 100644 index 97424ce0..00000000 --- a/Moderation/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Moderation - -This folder contains information and resources relating to co-creating a moderation process for the AutSPACEs platform. diff --git a/get-involved/related-work/README.md b/get-involved/related-work/README.md new file mode 100644 index 00000000..ae4eb081 --- /dev/null +++ b/get-involved/related-work/README.md @@ -0,0 +1,3 @@ +# Related Work + +Here you will find informationon on related work to the AutSPACEs project. diff --git a/get-involved/resources-and-recommendations.md b/get-involved/resources-and-recommendations.md deleted file mode 100644 index 9d73ab14..00000000 --- a/get-involved/resources-and-recommendations.md +++ /dev/null @@ -1,50 +0,0 @@ -# Resources and recommendations - -This file contains links to resources and recommendations provided by project collaborators. - -## Contents - -#### Autism -- Guidance -- Books -- Articles -- Academic papers and journal articles - -#### Citizen Science -- Guidance -- Books -- Articles -- Academic papers and journal articles - -## Autism - -### Guidance - -* [Coping with the uncertainty of Coronavirus](Coping with the uncertainty of Coronavirus). Autistica. **For autistic people** -* [Impacts of covid for autistic employees](https://www.autistica.org.uk/news/impacts-of-covid-19-for-autistic-employees). Autistica. **For employers** - -### Books - -### Articles - -* 11-03-2020 ["Neurodiverse scientist’s ‘instruction manual for humans’ wins the 2020 Royal Society Science Book Prize"](https://royalsociety.org/news/2020/11/royal-society-science-book-prize-winner-announced/?utm_source=adestra&utm_medium=email&utm_project=Public%20newsletter&utm_workspace=Newsletters&utm_campaign=6956&utm_name=2020-11%20Public%20newsletter). The Royal Society. **General interest** - -### Academic papers and journal articles - -### Films - -### Participatory frameworks - -[Starting toolkit](httpshttps://www.shapingautismresearch.co.uk/post/163944360130/its-here-a-starter-pack-for-participatory-autism). **For Autitic People** - - -## Citizen Science - -- Guidance -- Books -- Articles - -### Academic papers and journal articles - -["What Do We Know about Young Volunteers? An Exploratory Study of Participation in Zooniverse"](https://outlook.office.com/mail/AAMkADE4OWRiMTE5LTM3ZWQtNDJlNC1iYTQwLTAyMTE5M2Y1MTZjOAAuAAAAAAAbtaS%2BS3UQRpa%2FbZyOVgmDAQBnkuESs84DQJNijqLGkRHKAAGKYd1gAAA%3D/id/AAQkADE4OWRiMTE5LTM3ZWQtNDJlNC1iYTQwLTAyMTE5M2Y1MTZjOAAQAAgwxM%2BOEIpIlwUWOTQwe9g%3D?state=0) -[Exteroceptive Sensory Abnormalities in Childhood and Adolescent Anxiety and Obsessive-Compulsive Disorder: A Critical Review](https://www.jaacap.org/article/S0890-8567(19)30447-2/fulltext) diff --git a/Resources/README.md b/get-involved/resources/resources-and-recommendations.md similarity index 99% rename from Resources/README.md rename to get-involved/resources/resources-and-recommendations.md index bd110775..6e40eabc 100644 --- a/Resources/README.md +++ b/get-involved/resources/resources-and-recommendations.md @@ -1,4 +1,4 @@ -# Resources +# Resources and Recommendations This folder contains uploads, links, and recommendations from community members. Whether you want to get guidance, explore further, dig deeper, or find a foothold, this is a great place to look. @@ -75,6 +75,7 @@ Happé, F., & Fletcher-Watson, S. (2019). **Autism: A New Introduction to Psycho * Budin-Ljøsne, I., Teare, H. J. A., Kaye, J., Beck, S., Bentzen, H. B., Caenazzo, L., Collett, C., D’Abramo, F., Felzmann, H., Finlay, T., Javaid, M. K., Jones, E., Katić, V., Simpson, A., & Mascalzoni, D. (2017). Dynamic Consent: A potential solution to some of the challenges of modern biomedical research. BMC Medical Ethics, 18(1), 4. https://doi.org/10.1186/s12910-016-0162-9: this is an academic paper which looks at the conditions which give people genuine agency over data used for medical research. It's great for laying out clearly a raange of reaasons to adopt dynamic consent (in which paarticipants of reseaarch studies are able to easily change their consent.) * Ram, K. (2013). Git can facilitate greater reproducibility and increased transparency in science. Source Code for Biology and Medicine, 8(1), 7. https://doi.org/10.1186/1751-0473-8-7 + ## Citizen science * Arnstein, S. R. (2007). A Ladder Of Citizen Participation. Journal of the American Institute of Planners, 35(4), 216–224. https://doi.org/10.1080/01944366908977225 diff --git a/images/project-roadmap.jpg b/images/project-roadmap.jpg new file mode 100644 index 00000000..7813d04f Binary files /dev/null and b/images/project-roadmap.jpg differ diff --git a/Moderation/Moderation Strategic thinking.docx b/platform-designs/moderation/Moderation Strategic thinking.docx similarity index 100% rename from Moderation/Moderation Strategic thinking.docx rename to platform-designs/moderation/Moderation Strategic thinking.docx diff --git a/Moderation/Moderation.pptx b/platform-designs/moderation/Moderation.pptx similarity index 100% rename from Moderation/Moderation.pptx rename to platform-designs/moderation/Moderation.pptx diff --git a/platform-designs/moderation/README.md b/platform-designs/moderation/README.md new file mode 100644 index 00000000..e7f0bd49 --- /dev/null +++ b/platform-designs/moderation/README.md @@ -0,0 +1,3 @@ +# Moderation + +Here you will find all documentation that is linked to co-creating the moderation process for the AutSPACEs platform. diff --git a/project-management/Technical-Docs/development-tools.md b/project-management/Technical-Docs/development-tools.md deleted file mode 100644 index 8ab741fc..00000000 --- a/project-management/Technical-Docs/development-tools.md +++ /dev/null @@ -1,144 +0,0 @@ - -# Web technologies - -In this project, we envisage the use of HTML and CSS as a bare minimum. There is also potentially some scope for client side JavaScript in order to create more dynamic content. - -The purpose of this document is to ascertain the correct frameworks and developments tools for this project to use, as well as assessing alternatives. - -## Frameworks - -Whilst it is not necessary to use a web framework in order to create a web application, it can be used in order to cut the time required to get going. - -For example, [Bootstrap](https://getbootstrap.com) and [bulma](https://bulma.io) are front-end web frameworks. - -### Bootstrap - -Bootstrap prides itself as being the "most popular open source front-end framework in the world" and so that would suggest it is popular with developers. It is relatively simple to use and contains a large selection of [pre-built components](https://getbootstrap.com/docs/4.5/components/alerts/). - -It uses HTML, CSS and JavaScript (jQuery). - -As far as long term support goes, bootstrap was originally a Twitter offering, which quickly became entirely open-source in 2011. 8 Years later it is still going strong and development on their [github repository](https://github.com/twbs/bootstrap) is very active. - -### Bulma - -Bulma is much more recent than Bootstrap, but it is certainly up and coming. The provided framework is 100% CSS, and *requires* no JavaScript. This typically means it is much more lightweight, however the real world performance differences would be negligible. - -Part of is modernity is that it is built from the ground up on the relativity new "[Flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox)" which is a CSS display pattern that responded to the proportions of the screen in order to create responsive designs with ease. (As of Bootstrap v4 it uses Flexbox too) - -### Conclusion - -Bulma is a great CSS framework and perfect for getting started. It provides just enough and is extremely lightweight. However, Bootstrap has an enormous amount of community support, and so for an open-source project it makes sense to go with it. - -# Website Rending frameworks - -## Django - -### What is Django? - -Django is a framework written in python which allows for server-side rendering of web applications. It was designed to be utilised for rapid development, taking security and scalability into mind. [(source)](https://www.djangoproject.com) - -## Django popularity - -### Github Stars: 49.6k - -### Github Forks 21.5k - -### Github Used By: 417k - -## Language popularity - -Django uses the python programming language which sits as the second most popular language on GitHub at last review: -![Octoverse Graph](https://user-images.githubusercontent.com/3026030/83363562-47994080-a392-11ea-9da2-351097f7113e.png) -[(source)](https://octoverse.github.com) - - -## Pros to using Django in context - -* There is already a library for [OpenHumans/django-open-humans](https://github.com/OpenHumans/django-open-humans) - -* Python is widely known as a good starter language, for example it is taught in lots of schools. This could mean an increase in contributions. - -* Django is relatively simple once set up, and so would be easy for someone to contribute even at a later date. - -## Cons to Django in context - -* Django isn't the quickest rendering too especially when combined with python which is interpreted rather than compiled. - -* The default templating language is limited and contains caveats such as not being able to call a function. (Note - it is possible to use Jinja2 instead, which would be recommended and is much more 'standard' in the industry) - -* Django follows a Database driven approach, meaning it may be more applicable in contexts where an ORM (Object Relational Mapper) exists. Django focuses on developing models which are then turned into the [(source)](https://docs.djangoproject.com/en/3.0/intro/overview/) - -## Notable uses - -* Instagram [(source)](https://reinout.vanrees.org/weblog/2016/11/04/instagram.html) ( *It is likely that parts of Instagram have been rewritten in React due to Facebook's acquisition* ) - -* ... - -## Other Python Alternatives - -In light of Django primarily being created so that Database backed web apps can be used, and that this project focuses on not using its own database in favour of OpenHumans, other Python alternatives could be looked at. - -### Flask - -[Flask](http://flask.pocoo.org/) - -# Angular - -## What is Angular? - -Angular is a TypeScript (A Superset of JavaScript) framework which provides the tooling to enable the creation of web applications. It is client-side rendered meaning that web pages are rendered in the users browser. - -## Angular Popularity - -### Github Stars: 61.5k - -### Github Forks: 16.7k - -### No Github used by stats available at the time of writing - -## Language Popularity -Angular uses the TypeScript language, which is a superset of JavaScript. Both these languages fair well in terms of use in the open-source community: -![Octoverse Graph](https://user-images.githubusercontent.com/3026030/83363562-47994080-a392-11ea-9da2-351097f7113e.png) -[(source)](https://octoverse.github.com) -TypeScript operates with a very similar syntax to JavaScript, but is not *identical*. It's purpose is mainly to add strong typing to JavaScript in order to make debugging and development errors easier to catch earlier. - -## Pros to Angular in context - -* Angular requires much less server-side performance (due to client side rendering), meaning it is less susceptible to decreased performance under larger loads. - -* Only front-end knowledge is needed to start building, as it doesn't involve server-side code. - -* Angular is supported by Google, therefore it is likely to be of interest in the development community for some time. - -* Development speed can be greatly increased as the codebase is smaller and the front-end can react to changes instantly, without the need to re-compile or re-run. - -## Cons to Angular in context - -* Page rendering can be slower as the browser is required to do all of the work. In the same point, angular relies on the power of the end users computer, which can be a limitation - -* Compatibility with older browsers can be an issue as the majority of the visible content relies on the end users browser to be displayed. - -* There is no existing OpenHumans plugin to use, meaning all interaction with the OH API would need to be written from scratch - -## Notable uses - -* ... - -# Conclusion - -**Prototyping** - -For the current phase of the project, Fujitsu are prototyping a number of components and wireframe designs in order to create collateral that can be demonstrated to the community. This is valuable as we need to seek approval and feedback from stakeholders. - -As there is already a demo of how OpenHumans works with Django, we have chosen to fork this repository and work from it, rather than start completely fresh. In the short term this has sped up prototype development; However, we have had to undergo training exercises. - -## Training so far - -*The list below represents the list of external training that the Fujitsu development team may have undertaken* - -### Django - -* https://www.pluralsight.com/courses/django-fundamentals-update - -* https://www.pluralsight.com/courses/django-getting-started - diff --git a/project-management/Technical-Docs/translatable-platform.md b/project-management/Technical-Docs/translatable-platform.md deleted file mode 100644 index 12941e42..00000000 --- a/project-management/Technical-Docs/translatable-platform.md +++ /dev/null @@ -1,95 +0,0 @@ -# Translations in Django - -# Python configuration - - -##### settings.py -``` python - -from django.utils.translation import ugettext_lazy - -# Set up a list of languages to be supported -LANGUAGES = ( - ('en', _('English')), - ('fr', _('French')), -) - -# If the browser doesn't send us a locale, use this: -LANGUAGE_CODE = 'en' - -# Configure the base dir for the locale path -LOCALE_PATHS = ( - os.path.join(BASE_DIR, 'locale'), -) - -``` - -Ensure that: - -- `django.contrib.sessions.middleware.SessionMiddleware` -- `django.middleware.locale.LocaleMiddleware` -- `django.middleware.common.CommonMiddleware` - -are in the `MIDDLEWARE_CLASSES` dict. - -# How to generate new translations - -Ensure the language code you use is in the language configuration as above. - -You must also ensure it is a valid as per [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). - -Run the command: `python manage.py makemessages -l ''` - -This creates the `.po` file which can be found in `locale//LOCALE_MESSAGES/django.po` - -It also conveniently generates translation messages it finds in templates and classes - ready for the msgstr to be populated. - -# How to compile translations - -Translations need to be compiled before Django can utilise them. - -This is done by running the following command: - -`python manage.py compilemessages` - -Which generates a `.mo` binary file in the same location as the `.po`. - -# How to make use of the translations - -## In a django template file - -``` -{% raw %} -

{% trans 'Welcome' %}

-{% endraw %} -``` - - -## In the view -... *pending* ... - - -# How to Contribute to Translations - -The section will detail how the community can get involved with adding translations. - -## The translation files - -The files which include the translations which Django uses are at: -`project_root/locale` - -| Language | locale code | File | -|----------|-------------|--------------------------| -| English | en | en/LC_MESSAGES/django.po | -| French | fr | fr/LC_MESSAGES/django.po | -| ... | | | - -## How the files look - -Each section within the `.po` file looks like this: - -image - -The msgid is the tag, which the Django templating language uses to load the translations in depending on the users Locale setting; and the comment above shows the location of the translations use - file path and line number. - -Where this is a single word, the msgid matches the word needing the translation - however in the event that this is a phrase the msgid represents the marker for the translations' placement. To find the phrase needed to be translated, you can look in the other language files (for example English) to find the orignal phrase. diff --git a/project-management/project-roadmap/README.md b/project-management/project-roadmap/README.md index d8f2e549..71868330 100644 --- a/project-management/project-roadmap/README.md +++ b/project-management/project-roadmap/README.md @@ -8,3 +8,8 @@ We have different versions of this to ensure inclusivity: If you believe anything needs to be added or updated in relation to the roadmap, please edit the markdwon folder and create a pull request. Please add lottycoupat as the reviewer. + +The journey that was taken to create our roadmap follows the roadmapping chapter in the [Turing Way book](https://the-turing-way.netlify.app/project-design/project-repo/project-repo-roadmapping.html?highlight=roadmapping). + +![project roadmap image](../../images/project-roadmap.jpg) + diff --git a/research/README.md b/research/README.md deleted file mode 100644 index b501bd1c..00000000 --- a/research/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Research - -This folder is to collect information and connections to key research and projects that fit in with the wider research scope of the AutSPACEs project. - -To add to this folder either add to this readme or create your own MD document.