Merge pull request #14 from ail-project/doc

chg: [doc] Added doc to remove stuck uuid from the queue

.github/pull_request_template.md

@@ -1,7 +1,7 @@
 First of all, thank you very much for opening a pull request in this repository.
 
 In order for us to review your changes prior merging them, please makes sure it follows the rules below (if relevant):
-* no reformating changing the line length globally
+* no reformatting changing the line length globally
 * make multiple PRs if you're changing multiple things
 
 What kind of change does this PR introduce?
@@ -10,18 +10,18 @@ What kind of change does this PR introduce?
 * [ ] New Feature
 * [ ] Code style update (formatting, local variables)
 
- **NOTE**: if you used black or any other code formating tool, we will only accept one change per Pull Request. 
+ **NOTE**: if you used black or any other code formatting tool, we will only accept one change per Pull Request. 
            Do not attempt to "fix" everything in a single PR, as it makes reviewing the changes extremely difficult to review.
            If the fix is related to the length of the lines, it will be rejected.
 
-* [ ] Refactoring (no functional changes, no api changes)
-* [ ] CI related changes
+* [ ] Refactoring (no functional changes, no API changes)
+* [ ] CI-related changes
 * [ ] Documentation content changes
 * [ ] Tests
 * [ ] Other - please describe extensively what it does
 
 If you're using an AI to assist you in generating this PR, please review the changes extensively and make sure they are accurate and useful. 
-Onve it is the case, please tick the box below.
+Once it is the case, please tick the box below.
 
 * [ ] I used an AI to generate this PR and made sure I'm not wasting the time of the reviewer.
 

README.md

@@ -69,3 +69,27 @@ poetry run stop
 
 With the default configuration, you can access the web interface on `http://0.0.0.0:7100`,
 where you will find the API and can start playing with it.
+
+# Maintenance
+
+If you have recurring messages like the ones below you can remove the uuid from the queue as follows.
+
+```
+2023-11-17 08:00:59,936 LacusCore WARNING:[ef7f653d-4cfd-4e7b-9b91-58c9c2658868] Attempted to clear capture that is still being processed.
+2023-11-17 08:01:00,939 LacusCore WARNING:[ef7f653d-4cfd-4e7b-9b91-58c9c2658868] Attempted to clear capture that is still being processed.
+2023-11-17 08:01:01,941 LacusCore WARNING:[ef7f653d-4cfd-4e7b-9b91-58c9c2658868] Attempted to clear capture that is still being processed.
+2023-11-17 08:01:02,944 LacusCore WARNING:[ef7f653d-4cfd-4e7b-9b91-58c9c2658868] Attempted to clear capture that is still being processed.
+2023-11-17 08:01:03,947 LacusCore WARNING:[ef7f653d-4cfd-4e7b-9b91-58c9c2658868] Attempted to clear capture that is still being processed.
+...
+```
+
+
+While redis is running connect to it via its socket and zrem then entry.
+
+```
+ail@ail-tokyo:~$ cd lacus/
+ail@ail-tokyo:~/lacus$ ../redis/src/redis-cli -s cache/cache.sock
+redis cache/cache.sock> zrem lacus:ongoing ef7f653d-4cfd-4e7b-9b91-58c9c2658868
+(integer) 1
+redis cache/cache.sock>
+```