Create a simple dev documentation #32
Labels
No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
Valentin/vtaskr-backend#32
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Add a lite documentation for developers in a first step.
Enhance it later for each feature.
Hey! 👋🏾
I'm Sunkanmi and I'm a Technical Writer looking to contribute to API documentation on Github. I want to know if I can submit a PR for a Swagger documentation for this API and help refine your Github readme as well.
Let me know if I can get started on this. :)
Hope to speak with you soon!
Hi @sunkanmii !
Nice to meet you !
Feel free to purpose a merge request to improve documentations.
Actually an API doc is available here : https://api.vtaskr.com/documentation
And a really minimal MkDocs documentation here : https://valbou.github.io/vtaskr-backend/
Please before submitting a merge request, read the MkDocs first.
Hey @Valbou !
Thank you for being super patient with me on this. I've been super busy with work and just had some time to attend to side projects. I have a few questions concerning your backend API and I think you can help me answer and clarify them super easy:
Hoping for a response soon! Thanks!
Hello,
The users app folder is about authentication and permissions.
A group is a group of users (a familly group, a professional group, a project group or any other kind of group...). They each have a role in. Each role have a roletype user defined or pre defined with some rights.
The tasks app folder is about task management. A task is a thing to do that take less than 24 hours to do. You can assign tags to tasks to organise them. Each task is associated to a tenant (a group).
This project is at an early stage, so the code base may strongly evolve in a near futur.
Hmmm.
Thank you so much for this.
I would've preferred we hop on a short call to clarify some key items, but this will do for now!
Okay, I just looked at the codebase again and your descriptions.
I think I'm missing something here.
For example, what exactly is a role? Is "family" a role? Is "manager" as a text a role? What happens to the task if it's not done in 24 hours? What really is the core function of this API? Is it a Todo application that helps you manage your todo lists better or is it just a todo app that has multiple functionalities? I don't know. I think I have way too many questions and I currently lack the understanding of your application to write quality API documentation properly.
I have edited the yaml file a bit in Swagger, but some descriptions are not exactly clear.
Do you mind helping me out with this?
Maybe more explicit : https://valbou.github.io/vtaskr-backend/global/#deep-dive-into-apps
About users: https://valbou.github.io/vtaskr-backend/global/users/
About tasks: https://valbou.github.io/vtaskr-backend/global/tasks/ (a typo in diagram not "is", "has" instead)
You can find a link for each app.
I must fix backend and frontend after some issues about emails, but when it's fixed, I can invite you to create an account on vtaskr website to see how entities works together.
I need few days to fix it.
A role is as you can find in many SaaS software. (RBAC system - Role Based Access Control)
You may have an admin roletype or a observer roletype for example.
This affect what you can do or see.
An admin roletype with all rights is created by default and assigned to a user via a new role for his private group (created automatically after registration). If you want to join another group, you need a role in this group else you stay out.
If you want to share a group access, you can create a dedicated roletype you can name as you want (redactor, or contributor or whatever...). Then you can invite a user in this group with this roletype via an invitation. This invitation become a role after invitation was accepted.
Role is just a join table between RoleType/Group/User.
RoleType contain a name an associated rights.
A task is defined as thing to do that need less to 24 hours to do. But not necessarily to do before tomorrow ! You can have a meet that take 1 hour in 2025 ! Nothing happen if you pass 2 hours in your meeting... If the date is in the past, the frontend might mark the task as "expired", it's not a backend behavior. There is no auto clean.
If you have a meet in a big event that take few days (more than 24h), it's not a task. Your task is to take transport at X, then go to the hotel before Y and make the event opening at Z etc... If you need to sleep between two things, it's 2 different tasks. I hope it's more clear for this part.
Hello,
You can now register and login at : https://app.vtaskr.com
Some features lacks in frontend UI, but you can create and delete tasks.
You also can use API with Postman to complete missing features in frontend.
Wow.
You did great work on this. Excited to write on your product.
Taking a look at it now.
Continuous improvement subject