docs: Add service documentation links and expand contributing guide

- Added clickable links to service documentation (Keycloak, Elastic Search, nginx)
- Expanded 'Making a Code Changes' section with workflow, testing, and PR process details
- Removed TODO comments
- Improves onboarding for new contributors

Author: DUSHIMEDanPaul

docs/contributing.md

@@ -96,11 +96,40 @@ This will install some hooks to run before a commit can be made, these hooks wil
 These hooks help make sure formatting is more homogeneous across the project, and that no breaking changes are accidentally committed.
 
 ## Making a Code Changes
+
 See the ["Developer Documentation"](developer/index.md) for the technical documentation of this project.
-More to be added.
 
-Note that when using our convenience scripts to launch docker containers (see ["Shorthands"](hosting/index.md#shorthands)),
+### Code Change Workflow
+
+1. Create a branch from the latest `main` branch for your changes.
+2. Make your changes following the project's code style and conventions.
+3. Test locally using the development setup as described above.
+4. Commit your changes with clear, descriptive commit messages.
+5. Push your branch to your fork and create a Pull Request against the `main` branch.
+
+### Testing Requirements
+
+Before submitting a Pull Request, ensure:
+
+- All unit tests pass: Run the test suite locally with `pytest`
+- Pre-commit hooks pass: These are configured automatically with `pre-commit install` and will run:
+  - Code formatter (to ensure consistent style)
+  - Linter (to catch common issues)
+  - File validation
+  - Unit tests
+- Your code changes do not break existing functionality
+- For new features, consider adding tests to verify the functionality
+
+### Pull Request Process
+
+- Create a Pull Request with a clear title and description explaining what your changes do
+- Reference any related issues (e.g., "Closes #123")
+- Ensure all CI checks pass before requesting review
+- Be responsive to any feedback during the review process
+- The core team will review your contribution and provide feedback
+
+### Important Notes
+
+When using our convenience scripts to launch docker containers (see ["Shorthands"](hosting/index.md#shorthands)),
 local code changes are not mounted to the docker containers unless `USE_LOCAL_DEV` is set to `true`. You should configure this
 variable in your `override.env`.
-
-[//]: # (## Setting up a pull request)

docs/hosting/index.md

@@ -52,15 +52,13 @@ From the root of the project directory (i.e., the directory with the `docker-com
 This will start a number of services running within one docker network:
 
  * Database: a [MySQL](https://dev.mysql.com) database that contains the metadata.
- * Keycloak: an authentication service, provides login functionality.
+ * [Keycloak](authentication.md): an authentication service, provides login functionality.
  * Metadata Catalogue REST API: The main API service for managing and accessing metadata.
- * Elastic Search: indexes metadata catalogue data for faster keyword searches.
- * Logstash: Loads data into Elastic Search.
+ * [Elastic Search & Logstash](elastic_search.md): Indexes metadata catalogue data for faster keyword searches.
  * Deletion: Takes care of cleaning up deleted data.
- * nginx: Redirects network traffic within the docker network.
+ * [nginx](proxy.md): Redirects network traffic within the docker network and handles proxying.
  * es_logstash_setup: Generates scripts for Logstash and creates Elastic Search indices.
 
-[//]: # (TODO: Make list items link to dedicated pages.)
 These services are described in more detail in their dedicated pages.
 After the previous command was executed successfully, you can navigate to [localhost](http://localhost.com)
 and see the REST API documentation. This should look similar to the [api.aiod.eu](https://api.aiod.eu) page,