Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #16

Open
raquelalegre opened this issue Dec 1, 2020 · 2 comments
Open

Documentation #16

raquelalegre opened this issue Dec 1, 2020 · 2 comments
Assignees
Labels
Documentation Improvements or additions to documentation Technical
Milestone

Comments

@raquelalegre
Copy link
Contributor

raquelalegre commented Dec 1, 2020

Peter is already working on the developer documentation which is updated as he makes progress and will be used by RSDG while maintaining the website.

We will also need to create some docs for the final users of the application, especially for the admin group who will be creating other users' accounts and giving access to them. A simplified version of the Django documentation for this task would be great. This could preferably be in the form of a help section on the website.

@raquelalegre raquelalegre added Documentation Improvements or additions to documentation Technical To Do labels Dec 1, 2020
@raquelalegre raquelalegre removed the To Do label Dec 1, 2020
@raquelalegre
Copy link
Contributor Author

This needs to include adding a non-standard character to the project's font.

@raquelalegre raquelalegre added this to the Peter leaves milestone Feb 25, 2021
@raquelalegre
Copy link
Contributor Author

raquelalegre commented Mar 31, 2021

We haven't had enough time to write al the documentation that we'd like to! A lot has happened in Teams chats between @peterbispham and me. I'll have to put look into the existent documentation and update, and add other things related to loaddata/dumpdata and other bits I need to review.

There is documentation I have to also add regarding the deployment of the servers which I was waiting to finalise once I deployed pre-prod.

User documentation is also needed for general hypothesis installation and usage (see #21), as well as the admin screen to manage users, permissions and special characters.

Not sure time will allow a lot of in depth documentation, but I'll try to put together some in this repo's wiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Technical
Projects
Status: Technical
Development

No branches or pull requests

2 participants