[BuildStream] Contents: update

[Agustín Benito Bethencourt <agustin benito codethink co uk>]

Hi,

this mail summarise the work done and where we are at in the contents front.

## Background

* On week 35 Tiago started working on the technical aspects of the website. 
* I did some previous work on designing the content structure and creating the tickets and templates for the 
different web pages we planned to publish.
   * The current design documents sent to this list are out of date since the design has been changed.
* On week 36 (mostly), some engineers jumped on creating contents for the website. We have been dedicating 
effort since then.
* The  repository where you can find the work done is called website[1].

## The current state

* The technical work on the website is considered done except two similar points which are described below.
   * You can follow the work done in this regard in the ticket #9[2]
   * The Let's Encrypt certificate will need to be renewed[3]. 

I would like to thank Tiago for his effort in this regard. Others helped.

* The following pages are considered done for now, which means that are suitable to be improved but are good 
enough to use them.
   * Front page
   * Community page: project page
   * About: landing page
   * Install: installation guide. This page has been split.
   * Releases: download page.
      * It would be interesting to find out if we can use the extended markdown gitlab feature related with 
naming hashes in the table. We could significantly reduce the width of the table and include a link to 
instructions to install the version, including notes to clarify that PyPI is the default installation method.
   * FAQ
   * buildstream-1.2-is-out: release announcement

* The following pages needs to be finished in order to consider this first phase done:
   * Feature page[4]:
      * We lack some content. I sent a mail[5] about it.
      *  Jürg will provide a description of the CAS server feature.
   * Known issues[6]:
       * In order to decide if the page belongs to the web or will be moved to the Gitlab wiki, we need to 
know if it is possible to have a live status view of the tickets on the web, as we have on the gitlab wiki, 
for instance. This task is in progress.
       * Create the content, based on the bug tickets we have.

Tiago, Josh, Tristan Maat and myself have agreed to put the effort to reach to the end of this initial phase. 

* The following content are good to have before we consider this phase done, otherwise we will create them in 
the coming weeks:
   * BuildStream In Detail[7]
      * Detailed description of the tool, including a description of the key features and a block diagram, as 
well as references and links to the examples.
      * This is the place to make a reference about BuildGrid and freedesktop-sdk.
      * We will need the involvement of more engineers to finish this, specially those who participated in 
the development of key features.
   * Glossary[8] 
      * basic glossary targeting those unaware of BuildStream and those who being aware of BuildStream we 
want to turn them into BuildStream users.
      * Those more technical concepts used in the documentation belong to the documentation.

Please check the outcome of the work in progress here: http://www.buildstream.build

[1] https://gitlab.com/BuildStream/website
[2] https://gitlab.com/BuildStream/website/issues/9
[3] https://gitlab.com/BuildStream/website/issues/10
[4] https://gitlab.com/BuildStream/website/issues/1
[5] https://mail.gnome.org/archives/buildstream-list/2018-September/msg00027.html
[6] https://gitlab.com/BuildStream/website/issues/4
[7] https://gitlab.com/BuildStream/website/issues/5
[8] https://gitlab.com/BuildStream/website/issues/6

Best Regards
-- 
Agustín Benito Bethencourt
Principal Consultant
Codethink Ltd
We respect your privacy.   See https://www.codethink.co.uk/privacy.html