Streamlining website and documentation

[naskio]

Description

This issue tracks improvements for our website (https://armadaproject.io/) and documentation.

Current Challenges

The current website and documentation setup presents several hurdles:

• Maintaining Consistency: Keeping documentation in sync across the master and gh-pages branches is cumbersome and prone to inconsistencies. (related issue: CI: Automatic deploy of GitHub Pages doesn't work due to required protection on branches #3715)
• Outdated Content: The website includes pages that are no longer part of the current documentation. (for example: https://armadaproject.io/developer/aws-ec2.html)
• Broken Links: Many website links are broken (for example: https://armadaproject.io/developer/etc-localdev.md).
• Deployment Limitations: Absolute URLs prevent deployment on forks (related issue: armadaproject.io: Make it possible to develop via a fork #1105).
• Manual Updates: Protection rules necessitate manual pull requests for syncing files between branches (related issue: CI: Automatic deploy of GitHub Pages doesn't work due to required protection on branches #3715).

Solution

1. Move Website Source Code to Master:
   Relocate the website source code from the gh-pages branch to a dedicated website/ folder within the master branch. This consolidates all source code into a single branch, streamlining the workflow and helps overcoming GitHub limitations related to protection rules and GitHub Pages.
   move all from gh-pages branch to master website/ #4163

2. Centralized Documentation:
   Consolidate all documentation into a single source using Markdown format. This centralized approach simplifies maintenance, updates, and accessibility from the GitHub UI, IDEs, and the website itself.
   Centralize documentation #4164

3. Documentation Validation:
   Implement a workflow to validate the documentation and ensure there are no broken links.

4. Enabling Fork Deployment:
   Employ relative links to allow developers to work on their forks and facilitate website preview for maintainers before merging.

5. Automated Workflows with GitHub Actions:
   Leverage GitHub Actions to automate documentation validation, website building, and deployment whenever changes occur in the documentation or website source code. This ensures the website remains consistently up-to-date.