clarity of Layered Build Reference in StarlingX

[Michel Thebeau [WIND]]

The layered build doc is inaccurate in this way:
https://docs.starlingx.io/developer_resources/Layered_Build.html

The descriptions of layers requirements is unclear for all members leading to build failures when attempts to add packages are not correctly presented in the layers. Interpersonal dialogues are not currently sufficient for transmitting the information as no-one really knows how it works. As this is a developer reference, it is also unclear what needs to be tested in what ways to make sure builds will not fail.

Specifically noted in this request:
 - An RPM that must be on the ISO must be in the flock layer. The point "It is required to build the iso" should read "Add to the flock layer if it is required to build the iso". This sense is also is not otherwise within the current description of flock layer.
 - A testing requirement section should added describing what developers must do before submitting code reviews
 - What is the relationship between building a lower layer and subsequently building an ISO to test Starlingx? If one builds the compiler layer, can one then run 'build-iso' to get an install media.

[M Camp (mcamp859)]

@Michel, thanks for submitting this doc bug against the Layered Build Reference.

There is another STX doc that provides step-by-step details, called the Layered Build Guide.
https://docs.starlingx.io/developer_resources/layered_build_guide.html

Can you please review the other guide also? It is possible that your feedback should be addressed in both docs.

Thanks in advance,
Mary Camp

[Michel Thebeau [WIND] (mthebeau)]

Hi Mary,

Thanks for the invitation. I am working on the conversation with peers.

I am expecting that more feedback will be required for this one. I was asked to defer detail to one of my colleagues.

I am also intending to look at layered_build_guide.html as it pertains to my current work. And in this sense I am certainly interested in make sure that document is free from error. The Layered_Build.html is a lot of conceptual information which makes it a different kind of 'literature' than the layered_build_guide.html. I do not expect to find errors build guide as such. I had briefly reviewed it for conceptual information to help me with the Layered_Build.html.

M

[Ghada Khalil (gkhalil)]

Scott Little is the best person to provide the required clarifications. He's the layered build expert.

[Ghada Khalil (gkhalil)]

Tagged for stx.5.0 since having clear build documentation is important to the community. Assigning to Scott to update the docs or to provide input to the stx doc team to update.

[Frank Miller (sensfan22)]

Re-tagged to stx.6.0 -- it would be nice to update the documentation but this has not been a gating issue for developers so should not hold up the stx.5.0 release.

[Frank Miller (sensfan22)]

Removed stx.6.0 tag - this is not truly gating for any release but the documentation should be updated when Scott can find some time. This has not been a gating issue for developers so should not hold up the stx.6.0 release