If you would like to contribute to the documentation , you can follow these steps:
Before contributing, ensure that you have the necessary tools and dependencies set up on your system.
-
Clone the repository to your local machine:
git clone https://github.com/Kan-T-IT/geonode_cloud_documentation
-
Set up a virtual environment and install the required dependencies:
virtualenv -p python3.10 env3 source env3/bin/activate pip install mkdocs-material
Once you have the environment configured, you can start contributing to the documentation.
-
Navigate to the project directory:
cd geonode_cloud_documentation
-
Make the desired changes to the documentation using your preferred text editor.
-
Preview your changes locally by running:
mkdocs serve
This command will start a local server that allows you to view the documentation with your changes in your web browser. The server will provide you with a local URL (usually http://127.0.0.1:8000) to access the documentation.
-
Review your changes in the browser to ensure they look as expected. Make any necessary adjustments.
-
Once you are satisfied with your changes, commit your edits to your local Git repository:
git add . git commit -m "Added/Updated documentation on [Your Contribution]"
-
Push your changes to your fork of the repository:
git push origin main
-
Create a pull request (PR) to submit your changes to the original project repository.
Before contributing, make sure you have the necessary tools and dependencies set up on your system.
- Last version Docker
- Last version Docker Compose
Once you have the environment configured, you can begin contributing to the documentation.
-
Clone the repository to your local machine:
git clone https://github.com/Kan-T-IT/geonode_cloud_documentation
-
Navigate to the project directory:
cd geonode_cloud_documentation
-
Run the following command in the console:
docker-compose -d up
-
Make the desired changes to the documentation using your preferred editor.
-
Preview your changes locally by running. The server will provide you with a local URL (usually http://127.0.0.1:8000) to access the documentation.
-
Review your changes in the browser to ensure they look as expected. Make any necessary adjustments.
-
Once you are satisfied with your changes, commit your edits to your local Git repository:
git add . git commit -m "Added/Updated documentation on [Your Contribution]"
-
Push your changes to your fork of the repository:
git push origin main
-
Create a pull request (PR) to submit your changes to the original project repository.
After you create a pull request, the project maintainers will review your contribution. If everything is in order, they will merge your changes into the main documentation. Thank you for contributing to documentation!!