Hi BuildStreamers!

We think current first impressions when dealing with buildstream are not
optimal, and we think part of the problem is that the website and especially the
installation instructions could be a bit more clear

We would like to help to make the current situation better

Problems we have identified:
- Installation instructions from https://buildstream.build are fragmented and
confusing, partly because they're an attempt to use the same set of instructions
for both buildstream1 and buildstream2.
- Contents in the webpage tend to get out of sync

Propossed solution:
- We think installation instructions should be part of the documentation,
maintained from inside the buildstream repository. That way, they can be kept up
to date and accurate for the specific branch or tag that they are associated
with.
- Move installation instructions at https://buildstream.build back to the
documentation at https://docs.buildstream.build  [1], MR [2]
- Buildstream 1 already has installation instructions in the docs (
https://docs.buildstream.build/1.4.3/main_install.html). 
- Improve docs there as needed
- In parallel with this we would like to make some improvements to the website
to make it simpler and hence more maintenable (and if possible a bit more
attractive) [3]

Of course all this will be done through normal review process using MR's (like
[2]), so any can review the changes

What do you think? Does anyone have any reservations against above plan?

Cheers

[1] https://gitlab.com/BuildStream/buildstream/-/issues/1364 - Reintroduce
install instructions to buildstream docs
[2] https://gitlab.com/BuildStream/buildstream/-/merge_requests/1999 -
Reintroduce install instructions (MR)
[3] https://gitlab.com/BuildStream/website/-/issues/31 - Slim down the website

Reply via email to