search

HGustavs / LenaSYS

Code Viewer and Course Organization System used in some courses at University of Skövde
57 stars 31 forks source link

Close "Add documentation for microservices in X" issues #16208

Closed c20juler closed 1 month ago

c20juler commented 1 month ago

There are numerous open issues in the vein of "add documentation for microservices in X". Having already implemented a few of those I found that there already exists a comprehensive detailed documentation for presumably all microservices named "Microservices.md". To not confuse next years group of students, all open issues in the likes of "add documentation for microservices X" should be closed if documentation for that particular microservice already exists in "Microservices.md". Its important that documentation exists for all microservices that are mentioned in the currently open issues. Therefore I will go through every open issue to ensure that no documentation is missing before closing said issue.

Afterwards I will go through the existing smaller documentation files that are already implemented and remove those as they are redundant. Before doing so however I will need to go through each one to check if it is present in "Microservices.md", and if any useful documentation info is missing and may perhaps enrich the "Mircoservices.md" document if will create a request to add it. This will probably require a new issue.

c20juler commented 1 month ago

Created a new issue #16209 regarding removing redundant documentation, which will be addressed after this issue is complete.

c20juler commented 1 month ago

To be evaluated and closed:

c20juler commented 1 month ago

https://github.com/HGustavs/LenaSYS/issues/15972 Documentation exists for most microservices except for a recently created microservice "retrieveGitCommitService_ms.php". I will create a new issue for adding documentation for this particular microservice in "Microservices.md".

Edit: Issue has been created https://github.com/HGustavs/LenaSYS/issues/16210

c20juler commented 1 month ago

15973 Documentation is incomplete for "getGithubURLCommit_ms.php" in Microservices.md. I have created a new issue that will address this #16212. All other microservices are documented in "Microservices.md".

c20juler commented 1 month ago

15969 Documentation does not exist for the microservice "specialUpdate_ms.php" in Microservices.md (courseedService). I have created a new issue for this #16213. All other microservices in courseedService are documented in Microservices.md.

c20juler commented 1 month ago

All previously open "add documentation for microservices in X" issues in the task list above has been evaluated and closed. The documentation for microservices that where incomplete or absent in Microservices.md has been created as new issues according to the comments above. This issue is now resolved and will be closed.