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

Add documentation #94

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

asmataamallah25
Copy link
Collaborator

@asmataamallah25 asmataamallah25 commented Dec 19, 2024

This pull request enhances the project documentation by adding three 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.

  • Integration tests guide

These additions aim to improve the user experience for new contributors and help current users resolve common issues quickly.

docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/Troubleshooting.md Outdated Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 -v

This 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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I see merit in including both options. @flopezag has the best default solution, but @asmataamallah25 's drastic clean-up can also be useful if the machine has other resources running in conflict to Canis Major. Maybe something like this would work.

### Solution 1: Clean the docker compose

For a docker compose clean, execute the following command:

`shell
   sudo docker compose -f docker-compose-env.yaml -f docker-compose-java.yaml down -v
`

This command deletes all containers, networks, and volumes created on the corresponding compose. It is the normal way to remove resources in a compose.

### Solution 2: Remove all docker resources from the machine

Delete all the containers, volumes, and networks you have created in your machine, **including others not related to the deployment of Canis Major.**

For a complete Docker cleanup of all resources:
- Stop all running containers
   ```shell
   sudo docker stop $(sudo docker ps -aq)
  • Remove all containers
     sudo docker rm $(sudo docker ps -aq)
  • Remove all volumes
     sudo docker volume rm $(sudo docker volume ls -q)
  • Remove all custom networks
     sudo docker network prune 

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok then, I suggest to put the two options in the documentation.

@jason-fox jason-fox added the patch Should be applied for dependency updates and small bugfixes. label Jan 10, 2025
@asmataamallah25 asmataamallah25 changed the title Add environment setup guide and troubleshooting section Add documentation Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch Should be applied for dependency updates and small bugfixes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants