Docs release worfklow and scripts

[jaenrig-ifx]

By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---

CONTRIBUTING.md also tells you what to expect in the PR process.

Here the rendered docs:

https://ifx-arduino-devops.readthedocs.io/en/docs-release-wflow-scripts/index.html

This pull request enhances the documentation for the Arduino DevOps workflows, focusing on the compile-examples and release workflows. It introduces detailed descriptions, getting-started guides, and advanced configuration options for these workflows. Additionally, it improves the structure and clarity of the overall documentation.

Documentation Enhancements for Workflows:

Compile Examples Workflow:

• Added a comprehensive description of the compile-examples workflow, explaining its purpose, functionality, and implementation details (docs/compile-examples/description.rst).
• Created a detailed "Getting Started" guide for setting up the compile-examples workflow, including prerequisites, setup instructions, and matrix configuration examples (docs/compile-examples/getting-started.rst).
• Updated the table of contents to include the description and getting-started sections for the compile-examples workflow (docs/compile-examples/index.rst).

Release Workflow:

• Added a detailed description of the release workflow, covering its purpose, features, and implementation details (docs/release/description.rst).
• Provided a "Getting Started" guide for the release workflow, outlining setup steps, additional options, and different methods for creating releases (docs/release/getting-started.rst).

General Documentation Improvements:

• Improved the structure and readability of the main documentation index by updating the toctree and adding a warning about upcoming script unification (docs/index.rst).
• Standardized section headings for consistency across the documentation (docs/overview/motivation.rst, docs/overview/usage.rst). [1] [2] [3]

[LinjingZhang]

Nice!
We can merge them first, then gradually optimise them during use.

[LinjingZhang]

It also mentions that the script will include all previous versions. But where can they be obtained?

• Local JSON
• Remote GitHub JSON

[jaenrig-ifx]

The previous versions are obtained from the release asset package_xmc_index.json. That is the "single source of truth" when it comes to package_index.json.

The local json is relevant for ci/cd, as we only care the current commit, and we don´t need to know about past releases.
(And yet arduino-cli cannot install a core from a local .zip) without a JSON manifest.
Therefore, the local manifest is a workaround, to be able to install the current (or workflow triggering head) commit.

[LinjingZhang]

For some reason, it also needs tag history (we need at least one Git tag in the history for this to work properly).

[jaenrig-ifx]

Yes, the history is included.

[ramya-subramanyam]

Looks good.

[IFX-Anusha]

Nice!