Re: Documentation: update and future improvements

[Sander Striker <s striker striker nl>]

Hi,

On Fri, Jun 22, 2018 at 1:02 PM Agustín Benito Bethencourt via Buildstream-list <buildstream-list gnome org> wrote:

Hi,

 

On Friday, 22 June 2018 19:50:57 JST Laurence Urhegyi via Buildstream-list wrote:

> Hi,

>

> After some MRs have landed this week, we now have pretty solid documentation

> for newcomers to the project. See here:

>

> https://buildstream.gitlab.io/buildstream/

>

> I think we now need to focus on improving the documentation for the more

> advanced features of the the tool, and so I have opened the following ticket

> to capture this:

>

> https://gitlab.com/BuildStream/buildstream/issues/437

>

> I've suggested a way to structure this, which is essentially having

> tutorials to show the different use cases that BuildStream caters for,

> which get more complex as the reader goes through them:

>

> * Building a project

> * Developing a project

> * Working with Buildstream in a team

> * Advanced Projects

I think that makes sense.  I'd also like us to think about the single page quickstart working with an existing project. 

 

> Any feedback on this is welcome, as I think it's important to keep going

> with the docs and land these improvements as soon as we can, ideally before

> GUADEC, of course.

 

We will discuss it at GUADEC, yes.

 

I think we should focus as use case in those who want to implement Continuous Delivery pipelines. The idea is positioning BuildStream as a modern tool targetting modern delivery practices.

I am not quite sure what that means concretely.  I want to ensure we keep developers in mind as the most important audience, when it comes to usage documentation.

One way of doing it is creating the usage examples assuming the tool is used in such environment. Even if some readers are not there yet, we will create a clear mindset that you can get there with BuildStream.

 

The example could be designed to work as standalone examples too.

Cheers,

Sander

 

>

> Thanks,

> Laurence

>

>

> _______________________________________________

> Buildstream-list mailing list

> Buildstream-list gnome org

> https://mail.gnome.org/mailman/listinfo/buildstream-list

 

 

--

Agustín Benito Bethencourt

Principal Consultant

Codethink Ltd

We respect your privacy. See https://www.codethink.co.uk/privacy.html

_______________________________________________
Buildstream-list mailing list
Buildstream-list gnome org
https://mail.gnome.org/mailman/listinfo/buildstream-list

--

Cheers,

Sander