Update ReadMe.md to include some info about how the repo is managed

[ConnorOKane-Kainos]

Small note added to the readme file as suggested by FE.

Jira link - NA

See PROJ-XXXXXX

Change description

Small note about how the repo is managed has been added to the readme file as suggested by FE.

Testing done

Checklist

• commit messages are meaningful and follow good commit message guidelines
• README and other documentation has been updated / added (if needed)
• tests have been updated / new tests has been added (if needed)
• Does this PR introduce a breaking change

🤖AEP PR SUMMARY🤖

• ReadMe.md
  • Added a note about the codebase updating itself at midnight to pull new production repositories from provided URLs.
  • Added instructions for adding repositories by raising a PR from main and adding them to the production-repos.json file.

[github-actions]

Additional Improvements for ReadMe.md Update

1. Clarify the Self-update Mechanism: The note about automatically pulling new production repositories and updating at midnight could be expanded for clarity. Consider specifying:

   • The timezone for "midnight" to avoid confusion across different locales.
   • The mechanism or service used to perform this update (e.g., a scheduled GitHub Action, a cron job on a server, etc.).
   • Example:
     diff
     +- Note: This codebase self-updates by automatically pulling new production repositories from the provided URLs at midnight UTC, using a scheduled GitHub Actions workflow.

2. Ensure Consistency in Documentation: The ReadMe subtly shifts in voice at certain points. Aim for a consistent tone, either formal or casual, throughout to maintain professionalism and readability.

3. Add a Newline at the End of the File: The diff indicates the absence of a newline at the end of the file. This is against POSIX standards and can cause issues with command line tools and in Unix environments. Adding a newline at the end of the file is a best practice.

   • Example:

     +[common_tags]: URL_PLACEHOLDER
     +

4. Security Considerations: If the mechanism for updating the codebase involves pulling data from external URLs, ensure security measures are in place. Mention the use of secure protocols (e.g., HTTPS) and any validation or sanitization of the fetched data to protect against potential security vulnerabilities such as injection attacks.

   • Example:

     +- Security Note: Data pulled from URLs is validated and sanitized to prevent security vulnerabilities. All connections are made using HTTPS.

5. Cost and Carbon Usage Implications: Although not directly mentioned in the provided diff, the process of updating from external URLs might have cost and carbon usage implications, especially if it invokes cloud-based resources (e.g., AWS Lambda, Azure Functions) to perform operations.

   • Suggest monitoring these resources for unexpected spikes in usage that might translate to higher costs or increased carbon footprint. Utilizing efficient coding practices, selecting the right compute resources, and scheduling tasks during off-peak hours (if feasible and more eco-friendly depending on the region) can mitigate these issues.
   • No direct code example for this point since it's more about operational practices than a code modification.

6. Document How to Modify the List of URLs: If the codebase now supports pulling data from URLs for automatic updates, ensure the ReadMe instructs how to add, modify, or remove these URLs. This ensures maintainers can easily understand and manage this aspect.

   • Example:

     +- To modify the list of URLs for production repositories, navigate to [file/path] and follow the instructions for adding or removing URLs.

These improvements aim to enhance clarity, maintain standards, and address potential overlooked aspects concerning security, costs, and environmental impact.

[github-actions]

ReadMe.md Improvements

1. Clarification on Automated Updates:

   • The note on auto-updating at midnight could create confusion regarding its timezone. Specify the timezone to ensure clarity. For instance:
     diff
     +- A good note to make is that you do not have to update this codebase as it will pull any new production repositories from the URL's provided and update itself at midnight (UTC).

2. Guidance on PR Process:

   • The process for raising a PR could benefit from more detailed steps, ensuring contributors understand the precise actions needed. For example:

     +- If you want to you can manually add repositories by raising a PR from the main branch. Add your repositories to the `production-repos.json` file, providing a description in the PR why this addition is necessary. Ensure to obtain approval from a repository maintainer before merging the PR.

3. Best Practice - Newline at the End of File:

   • The removal of the new line at the end of the file goes against common conventions which facilitate better diffs and concatenation in a Unix-like environment. Recommend adding it back.

     +| <a name=\"output_common_tags\"></a> [common\_tags]
     +

4. Markdown Linting:

   • Ensure the usage of consistent styling in Markdown, particularly with link formatting which appears to be incomplete. The corrected line would look something like this, assuming an intended link was cut off:

     +| <a name=\"output_common_tags\"></a> [common\_tags](#SomeMissingLink)

   However, if the intention was not to provide a link, then converting to pure Markdown without HTML tags for simplicity and consistency might be better:

   +- **common_tags**: This output shows the common tags applied across resources.

5. Security and Cost Implications:

   • Though not directly related to the diff provided, considering you're dealing with Terraform and automation, a review on security practices regarding how production-repos.json is accessed and updated is crucial. Ensure proper access controls and encryption are in place to prevent unauthorized modifications.
   • Regarding the cost, automating the pull and update process could potentially increase the operation cost based on the resources involved during the operation (e.g., computation resources). Estimate and optimize costs by reviewing the compute resources required for the midnight update process. However, without specific details on the infrastructure, a precise cost estimation cannot be provided. Moreover, optimizing this process could also reduce carbon usage, aligning with best practices for environmental sustainability.

6. Documentation Improvement:

   • Adding a section on troubleshooting common issues or FAQs could provide valuable support to users, reducing the need for direct assistance and potentially lowering the support cost and effort.

Each of these improvements aims not just to enhance readability and compliance with best practices but also to ensure clarity in documentation, which is critical for effective team collaboration and project maintenance.