[LTP] [RFC PATCH 1/1] doc: Split test-writing-guidelines

[Petr Vorel]

> On Thu, May 27, 2021 at 12:19 PM Petr Vorel <pvorel@suse.cz> wrote:

> > Hi Li, all,

> > > > > https://github.com/pevik/ltp/wiki/Test-Writing-Guidelines
> > > > > https://github.com/pevik/ltp/wiki/C-Test-API

> > > Seems we have a similar guideline "c-test-tutorial-simple.txt",
> > > maybe better to combine them together?
> > I'd prefer to keep them separate. Because otherwise page gets long again.
> > But I'd consider to unify names ("LTP C Test API" vs. "C Test Case Tutorial"
> > - API vs. Case).

> No problem, I'm OK with unifying names.

> And yes, we can rename with the same prefix start on purposely to make
> them keep nearby in alphabetical sorting.

I'm not sure myself about renaming. But adding list of files generated by us in
HOME [1] and Developers corner [2] should help.

Also I'd add some NOTE: See also links (eg. to C Test API at the top in C Test
Case Tutorial and vice versa, in Shell Test API to C Test API and vice versa).

> > > > > https://github.com/pevik/ltp/wiki/Shell-Test-API

> > > Forgot to mention, with the increased number of docs, do you think it
> > > necessary to create an index for including all documents in a sort?
> > There is list of pages on the right. But as it's sorted alphabetically,
> > it's not enough. Maybe we should add this list to README.md and to HOME wiki
> > page.

> To HOME wiki sounds good, we can do a simple triage in there.

> Thanks a lot for the documentation work!
Thanks for your review!

Kind regards,
Petr

[1] https://github.com/linux-test-project/ltp/wiki
[2] https://github.com/linux-test-project/ltp#developers-corner