[Starlingx-discuss] Test Case Submission in rst format

[Arce Moreno, Abraham]

Hi Numan,

> We are currently in process of submitting our test cases in stx-test git
> repository. There has been a request to upload manual tests is rst format so
> that they can be visible on a wiki.

Thanks to you and all test team for all the support to take advantage of existing
documentation infrastructure and give it a try to have it under our official
documentation channel at starlingx.io

> Conversion of test cases from plain text format to rst format is causing a lot
> of pain and time lost. At the same time it is also not an absolute requirement
> as any tester who wants to execute these test cases can easily access them
> from git in text format.

We understand this is a time consuming process considering the number of
test cases you have and the ramp up in the learning of the RST format if
automated tools are not used. Agree that the format is not relevant to
execute a test case.

> I am not sure about how much time is spent by Ada's team in converting
> these test cases but I would suggest that we should submit them in plain text
> format and if documentation team wants to convert them in rst then they
> can update them.

Let's add this option to the table. At the end, you as a team has the final decision
and decide what is the best approach that works for you, here you have the existing
options:

[ Option A ] Convert all test cases to RST format and merge.
[ Option B ] Keep all test cases in X format and merge.
[ Option C ] Only merge what has been converted to RST format.

There is no right option, again, it all depends on the needs and priorities of the team,
your call.

> Secondly, if these test cases are to be shown in Wiki, what is your plan for
> showing them in next release? 

The test cases could land (one commit away to make this happen) under our official 
StarlingX documentation site at: https://docs.starlingx.io/

Our proposal is to add "Test" down to "Tools", under "There are several supporting projects and repositories":

- Tools < pointing to https://docs.starlingx.io/stx-tools/index.html
- Test < pointing to https://docs.starlingx.io/stx-test/index.html

This way we are taking full advantage of the StarlingX documentation 
infrastructure based in OpenStack guidelines and giving a standard and
formal way to present it to the community.

> Would there be a release specific Wiki or a selection available to check
> test cases for each release?

We can discuss what are your needs in terms of versioning in our weekly meeting.
As an example, we are currently working to split the installation documentation 
in 2 versions based in "directories":

1. Version one: old way to deploy StarlingX 
2. Version two: new containerized way to deploy StarlingX

More information about this "versioning" task under our meeting minutes here:
https://etherpad.openstack.org/p/stx-documentation

Please let us know any other question you might have. More than happy to support
your team objectives.