Skip to content

WIP: Use freedesktop-sdk as a base for tutorials as much as possible

Tristan Maat requested to merge tlater/freedocstop-sdk into master

Description

This transforms our current "doctored alpine image" base into a freedesktop-sdk public stack for the sake of the tutorial.

To do so, we first introduce the basic concepts of BuildStream using the old doctored image (since it is rather nice in explaining how we transform file systems), and then immediately introduces a junction to freedesktop-sdk, which is then used throughout the rest of the tutorial.

I think this is a useful change because it gives new users a good starting point (freedesktop-sdk can and should probably be used as a base system for the average project), that allows BuildStream to keep most of its features (and not give everything up to, say, a Dockerfile).

It also gives us a good starting point for generating system images from scratch, which is a piece of documentation that I would like to produce as well, and might help with #321 (closed).

Currently still WIP because (as the commit comment says):

  • We need to introduce a buildstream docs cache since this takes ages to compile.
  • I'm not happy with the integration-commands doc - I should add another nested dependency and give a real reason for using integration commands.
  • Session output has not yet been updated - this will need to be done post-cache implementation.
  • A section on installing bst-external should probably be included, but this should be coordinated with the current plugin discussions.

I also realized that I missed converting some examples:

  • Advanced junctions sub-project
  • Developing

Changes proposed in this merge request:

  • Make the buildstream tutorial (mostly) use freedesktop-sdk as a base

I currently don't have an issue for this - do tell if I should create one!

Edited by Tristan Maat

Merge request reports