Skip to content

BuildStream in Detail

What is it?

  • New content
  • Update existing content

Metadata

  • Maintainer: @valentindavid
  • Milestone: %BuildStream_v1.2
  • Follow up from:
  • Target audience: users that might turn into contributors
  • Topic:
    • Community
    • Management
    • Promotion
    • Code and metadata
    • BuildStream description
    • Outcomes
    • Landing/Project page
    • Other

Rationale

This is the rationale included in the Content Structure document:

This would be the content describing in detail the tool, including the features, components, dependencies and other elements. The ideal situation would be to have a page that provides an overall context of all the features, called BuildStream in Detail, and then links to more detailed information about each feature or component. It is important to provide a clear relation between problem statement/use case and feature.

It is important to translate to the content the architecture of the tool when it comes to core vs complementary features if, like in our case, they are developed/managed slightly different, so the feature and associated content maintenance expectations are set correctly.

It is important to link the feature descriptions to code, so the content is worth for a wide range of profiles, making the published content valuable in a wider range of situations.

Content structure and description

Users that get here are truly interested in BuildStream and we assume they have it installed already. We can go very technical here and point to where to ask, how to report bugs, how to contribute code, roadmap, consume development snapshots, etc.

The following content will be added to this page:

  • BuildStream tool set definition
  • Block diagram
  • List including a short description of the main components or elements of BuildStream
    • Include links to external information if required.
  • There should be a section for key feature of BuildStream with a short description of what is it used for.
    • You get to each section from the release feature page (what's new feature table)
  • Link section including:
    • Links to how-tos/examples
  • Section focused in turning users into contributors
    • Links to how to contribute
    • Links to the code
    • Link to documentation about code style, processes, etc.

References

Edited by toscalix