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

Add Readme #92

Open
SRADHA-SURESH12 opened this issue Aug 31, 2022 · 2 comments
Open

Add Readme #92

SRADHA-SURESH12 opened this issue Aug 31, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@SRADHA-SURESH12
Copy link

What needs to be done?

There is a need for a structured readme file in order to understand the project.

@frinzekt
Copy link
Member

Hi @SRADHA-SURESH12, thank you very much for raising this issue!

The current documentation of the project can be seen in https://indeaav2-docs.systemhealthlab.com/developer/

that first page of documentation corresponds to this https://github.com/uwasystemhealth/IndEAAv2/blob/develop/docs/docs/developer/index.md in the repository structure.

If you want to know more about the project in terms of its context, here's the requirements document of the project.
Proposal___IndEAA_MPE.pdf

The gist of it:

  1. We are streamlining the course accreditation review process in UWA
  2. This repo is a complete rewrite of https://github.com/uwasystemhealth/IndEAA. The rewrite allows us to scale this to accomodate for other universities or institutions that undergoes a similar format of accreditation review process

@frinzekt
Copy link
Member

Hi @uwasystemhealth/redbacks, can anyone of you review our documentation and add the main documentation link in the readme.md file?

Having a quick look, we have some stuff missing:

  • Backend Specific Documentation (to talk about Docker, Django)
  • User manual Coordinator
  • User manual Reviewer

Happy to divide it into more github issues

@frinzekt frinzekt added the documentation Improvements or additions to documentation label Sep 1, 2022
@frinzekt frinzekt added this to the Iteration #1 milestone Sep 9, 2022
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
Projects
None yet
Development

No branches or pull requests

2 participants