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

User guide #251

Open
5 tasks
dandavies99 opened this issue Jan 10, 2023 · 0 comments
Open
5 tasks

User guide #251

dandavies99 opened this issue Jan 10, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request frontend related to the frontend

Comments

@dandavies99
Copy link
Contributor

dandavies99 commented Jan 10, 2023

A basic user guide should be written to include:

  • Basic usage for uploading data (devices, experiments etc)
  • Information on the permissions system
  • More advanced topics like how to create new parsers to map new columns to existing parameters, and how to define new parameters (all via the admin site)
  • The procedure for user registration, activation and giving them permissions (again via the admin site)
  • Development notes for creating a new parsing engine for other cycler brands - this is something that is likely going to be desired if further development takes place.

For simplicity, these can initially take the form of markdown files, linked to from the main README.

This could also be an opportunity to tidy the main README a bit.

Aha! Link: https://imperial-college-ict.aha.io/requirements/RSE-132-23

@dandavies99 dandavies99 self-assigned this Jan 10, 2023
@dandavies99 dandavies99 added enhancement New feature or request frontend related to the frontend labels Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request frontend related to the frontend
Projects
None yet
Development

No branches or pull requests

1 participant