summaryrefslogtreecommitdiff
path: root/doc/source/main_using.rst
Commit message (Collapse)AuthorAgeFilesLines
* doc/examples/composition: Adding user guide about split-rules and compose ↵Tristan Van Berkom2020-04-171-0/+1
| | | | elements
* doc: Refactoring junction documentationTristan Van Berkom2020-04-171-2/+2
| | | | | | | | | | | | Renamed the "Advanced topics" section to "Combining projects", and splitting up the junctions section into two separate documents, one which describes the simplest junction example and another which explains how to use workspaces in conjunction with junctions. This commit also makes some minor changes the examples, correcting some grammatical errors, improving links and formatting, also rewording a `note::` in order to clarify that it would be unusual to junction a project that is in a subdirectory.
* docs: Update configuring cache serverraoul/1024-artifact-docsRaoul Hidalgo Charman2019-05-311-1/+1
| | | | | | | | Now that we have both artifact and source caches the documentation is updated to reflect that. Some sections headings/links etc. have been expanded and changed. Part of #1025
* CONTRIBUTING.rst: Added more guidelines about documenting the user guideTristan Van Berkom2018-10-141-0/+2
|
* doc: updates considering website being live nowTiago Gomes2018-10-121-0/+1
| | | | | | | | | * Add a link to the website on the main page. * Remove install instructions as they are now on the website. * Remove Resources section as that information can be found at the website, and also looks bad. * Move artifact server setup from the no longer existing Install section to the Using section.
* tutorials: Add workspaces tutorialPhil Dawson2018-08-011-0/+1
| | | | This is part of the work towards issue #437
* using_advanced_features.rst: Added fileJames Ennis2018-07-301-0/+1
|
* doc/source/main_using.rst: Updating headline for this page.Tristan Van Berkom2018-06-251-1/+3
| | | | | The purpose of this page has changed with time, better to clarify this in the headline of the page.
* doc: Adding part 1 of the getting started tutorialTristan Van Berkom2018-06-161-0/+1
| | | | | | | | | | | | | | | | | | | | | o doc/Makefile: Added new directory to collect rst files from o doc/examples/first-project: Added the "first-project" example project. o doc/source/sessions/first-project-*.html: Added the generated snippets o doc/source/using_tutorial.rst: Added the new main tutorial page o doc/source/tutorial/first-project.rst: Added part 1 of the tutorial here o tests/examples/first-project.py: Added test for the example project This is largely based on an example by Javier Jardón, which was submitted at https://gitlab.com/BuildStream/buildstream/merge_requests/323 Fixes #103
* doc: Overhaul of page names and titlesTristan Van Berkom2018-06-131-5/+5
| | | | | | | | | | | | | | | | o Giving main pages simple word titles This makes the main page: * About * Installing * Using * Reference * Contributing o Now named all rst files with their parent page name as a prefix. o Also changed some titles to make overall consistent titles.
* doc: Removed some unused link targetsTristan Van Berkom2018-06-091-3/+0
|
* doc/source/main_using.rst: Reversed ToC hereTristan Van Berkom2018-06-091-2/+2
| | | | | | Seems that the "commands" is taking a lot of space such that we can't see the other sections here easily, that is alright if "commands" remains at the end.
* doc: Add first example, building on a flatpak SDKalbfan2018-05-161-0/+1
| | | | | | | | This adds: o A ToC area for adding examples o The instructive example page for the first example o The example project under doc/examples o The corresponding integration test in tests/examples
* main_core.rst: Change title and moved authoring, sandboxing and cachekeys ↵James Ennis2018-04-171-2/+1
| | | | documentation here
* config.rst: Renamed to user_config.rst and anchors changedJames Ennis2018-04-171-1/+1
|
* invoking.rst: renamed to commands.rst (anchors also changed)James Ennis2018-04-171-1/+1
|
* main_authoring.rst: move to using buildstreamJames Ennis2018-04-171-4/+2
|
* docs: Remove orphan tag from all pagesJavier Jardón2018-03-281-1/+0
| | | | | | This is not needed anymore as all documented are part of the index This is a part of the fix for #246
* source/main_using.rst: Use toctree instead normal listJavier Jardón2018-03-281-3/+5
| | | | | | So index appear in left menu This is a part of the fix for #246
* Documentation: Restructured toplevel documentationdocs-reorganizationTristan Van Berkom2018-01-171-0/+16
This is intended to make things easier to find for the various types of people searching for stuff. o The installation instructions remain on the main page. o Three main separate pages have been created - Using BuildStream - Authoring BuildStream projects - Core API reference, for plugin authors o The "Authoring projects" section swallows the previous plugin index; so one can find the plugin one is looking for on the same page as the rest of the format docs o The plugin authoring section has been swallowed by the core API reference section, with a note that this is useful especially for plugin authors.
View Lorry Controller Status