Add new examples to overwrite the inheritance problem

[mcasquer]

The examples code block from spec/plans/main.fmf
is being wrongly inherited by some of the specs. Adding
new examples blocks to avoid this problem.

Pull Request Checklist

• update the specification

[mcasquer]

The same idea needs to be implemented for the discover specification where the same happens and perhaps in the execute as well. The point is that using the same approach will erase the full spec from the documentation. So my guess is that further modifications (still unknown to me) are needed for both cases.

[psss]

I was thinking a bit more about the possible solutions, here's my brainstorm:

• introduce inherit: false plus define the story key down in the structure key keep stories being stories
• add a simple motivational example for each step (e.g. showing html plugin for the report step)
• modify the tmt story export implementation to ignore child keys which are the same for parent

Last one would probably break some other export cases, so probably not a good choice. Adding stories would not bring much benefit to the user. So, I believe, the second option would be the best one.

@mcasquer, could you add a simple, few-lines example, for each step? This would override the inherited general one. Anyway, we don't want to spend much time on this as the long-term plan is to deduplicate the step plugin docs by moving the to the plugin code.

[mcasquer]

@psss added an empty :example statement in the main report section, this way the wrong inherited example is not displayed and for the file spec I considered the YAML could be the example (I wanted for it to be displayed at the beginning but seems not possible) What do you think of this change now? Then the work in the de-duplication could be started

[psss]

Looks ok, just two comments.

[psss]

Thanks for fixing this! Looks good, I've only adjusted the example indentation.

[psss]

Spec change only, merging.