Add environment setup guide and troubleshooting section #94
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flopezag
requested changes
Dec 19, 2024
flopezag
requested changes
Jan 9, 2025
| Stop the docker compose and start again to ensure the Vault's content is clean before executing the integration tests again. | ||
|
|
||
| For a docker compose clean follow these steps for a complete Docker cleanup: | ||
| - Stop all running containers |
There was a problem hiding this comment.
I suggest that you change all this content by the following:
For a docker compose clean, execute the following command:
sudo docker compose -f docker-compose-env.yaml -f docker-compose-java.yaml down -vThis command deletes all containers, networks, and volumes created on the corresponding compose. It is the normal way to remove resources in a compose. Your steps delete all the containers, volumes, and networks you have created in your machine, including others not related to the deployment of Canis Major.
jason-fox
added
the
patch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request enhances the project documentation by adding two crucial components:
Setup Requirements:
Detailed instructions for setting up the environment to run Canis Major, including specific versions of Java and Docker.
Troubleshooting Guide:
Addresses the most common issue: build failure during integration tests.
Provides a clear, step-by-step solution to resolve the NGSI address problem.
Includes explanations of commands used in the troubleshooting process.
These additions aim to improve the user experience for new contributors and help current users resolve common issues quickly.