Add readme file for cases and environ variable for ce-oem-provider (New)

[stanley31huang]

Description

Add readme file for cases and environ variable for ce-oem-provider
We would like to have a document to describe which environ variable has been defined in the checkbox-ce-oem provider

AI
The README files are currently generated by a script, and we plan to introduce another PR to facilitate their updates in the future. The idea is to run a script to generate the README files and compare the differences in the GitHub workflow when a PR is created (similar to the tox check). If any differences are found, the script will add a comment to the PR to notify the reviewer.

Resolved issues

N/A

Documentation

N/A

Tests

N/A

[pieqq]

This must have required a lot of work, unless you had some kind of script to generate the content!

A few comments:

• In the "Affected Test Cases" sections, I would point directly to the job in the pxu file. You can use relative links, and GitHub will understand them. Doing this will avoid a lot of duplicated data (environ, summary, description, command) that will probably go out of date quickly
• How do you plan on maintaining this? Are other contributors to ce-oem-provider aware they have to update the associated md files if they introduce a new environment key? Maybe you can add this to the README file.

[stanley31huang]

@pieqq Thanks for the suggestion, I have updated the PR and please see my inline comments

This must have required a lot of work, unless you had some kind of script to generate the content!

A few comments:

• In the "Affected Test Cases" sections, I would point directly to the job in the pxu file. You can use relative links, and GitHub will understand them. Doing this will avoid a lot of duplicated data (environ, summary, description, command) that will probably go out of date quickly

The reason we generate this kind of markdown files is to have a better view to know how to configure the environ variable.
As you may know that not all of jobs has clear description to describe how to configure it, so we may need to look into the command section.

So the idea is to shows some key information in the markdown file and also have a hyperlink to the source file.

• How do you plan on maintaining this? Are other contributors to ce-oem-provider aware they have to update the associated md files if they introduce a new environment key? Maybe you can add this to the README file.

I have uploaded the scripts which use to generate the Markdown file and added a section to describe how to update them.
we had a discussion in QA team about how to maintain those markdown file, the idea is add an step in the github workflow to update those markdown file regularly.

[stanley31huang]

Per discussion with Max few weeks ago, he suggest us not doing changes in the github workflow directly. But running a scripts to check is there any difference for those readme files instead.

So I am going to send another PR to do following actions.

1. Generate the new readme files
2. Compare the readme files
3. Add a comment about the difference of readme files.

So in this PR, it's mainly for adding the readme files. And you could see how is looks like in this branch.

[zongminl]

As the first step of capturing environ variables into README files, this PR looks good enough.
Some environ variables still missing detailed descriptions, this will be something to be fixed in the future.

[stanley31huang]

@pieqq I have updated the description to have an followup action to implement a script to keep these document up to date. Could you please review this PR again?