summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Docs: Correct URLs in artifact cache exampleJim MacArthur2018-11-271-2/+2
| | | | | The port number must come after the hostname and before the path. The path is ignored by CASCache anyway, so including it is misleading.
* Documentation: Update to show new config optionsJim MacArthur2018-11-271-3/+17
|
* Docs: Add remote execution architecture documentation.Jim MacArthur2018-11-264-0/+533
|
* Workspace CLI updateWilliam Salmon2018-11-212-3/+3
| | | | | | | This is to update the workspace CLI to as agreed on the mailing list https://mail.gnome.org/archives/buildstream-list/2018-September/msg00046.html This patch also introduces the default workspace directory.
* using_config.rst: Add documentation to showing how to impose quotas on the ↵James Ennis2018-11-081-0/+38
| | | | | | local cache This patch partially resolves #700
* using_configuring_artifact_server.rst: Remove examples and redirect to user ↵James Ennis2018-11-071-47/+7
| | | | config/project config
* format_project.rst: Update instructions regarding how we declare remote ↵James Ennis2018-11-071-5/+20
| | | | caches in project.conf
* using_config.rst: Update our instructions for how we declare caches in user ↵James Ennis2018-11-072-15/+54
| | | | config
* doc: Moved cachekey and sandboxing writings into the architecture sectionTristan Van Berkom2018-10-294-2/+2
|
* doc: Adding new architecture document about how the scheduler works.Tristan Van Berkom2018-10-2910-0/+2126
|
* doc: Adding new architecture document about highlevel program flowTristan Van Berkom2018-10-294-0/+1831
|
* doc: Adding new architecture document describing the dependency modelTristan Van Berkom2018-10-298-0/+904
|
* doc: Adding new architecture document describing the data modelTristan Van Berkom2018-10-2912-0/+1437
|
* doc: Adding new architecture document with initial "Overview of modules" sectionTristan Van Berkom2018-10-295-0/+2078
|
* doc/source/format_intro.rst: Adding link anchor for include directivesTristan Van Berkom2018-10-291-0/+3
|
* doc/source/conf.py: Added `images` directory for statically included filesTristan Van Berkom2018-10-291-1/+1
|
* docs: Add more information to "managing the cache with systemmd" sectionJames Ennis2018-10-261-3/+36
|
* using_configuring_artifact_server.rst: Fix lines that are too longJames Ennis2018-10-261-3/+9
|
* using_configuring_artifact_server.rst: Fix incorrect reference to bst push ↵jennis/patch_remote_cache_docsJames Ennis2018-10-251-1/+1
| | | | (with link)
* docs: Add helpful notes to artifact server configuration instructionsJames Ennis2018-10-251-0/+14
|
* Change URL to the Alpine tarballValentin David2018-10-175-5/+5
|
* Fix spelling of it's and itsRichard Dale2018-10-1610-13/+13
|
* bst2html.py: Name the second argument to avoid an errorjmac/doc-argument-fixJim MacArthur2018-10-161-1/+1
|
* CONTRIBUTING.rst: Added more guidelines about documenting the user guideTristan Van Berkom2018-10-143-0/+8
|
* doc/source/index.rst: Moved references to the website below the simple ToC.Tristan Van Berkom2018-10-121-3/+2
|
* doc/source/additional_docker.rst: Fix link to refer to websiteTristan Van Berkom2018-10-121-4/+3
| | | | | The docker guide, which is part of the install guide, has moved to the website.
* doc: updates considering website being live nowTiago Gomes2018-10-1210-480/+6
| | | | | | | | | * 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.
* doc/source/core_framework.rst: Include the foundation types in the API docs.Tristan Van Berkom2018-10-121-0/+1
|
* doc: Add new document about Docker integrationsChandan Singh2018-10-092-0/+54
| | | | | | | | | | | | | | | | | | Add a new section under "Additional writings" section about how BuildStream integrates with Docker. At present, this section includes only two sections: - "Run BuildStream inside Docker", that refers to existing instructions for doing so - "Generate Docker images", that adds instructions for using the newly added `contrib/bst-docker-import` script In future, this document can be extended to include the following things: - Importing Docker sources via `docker` source plugin - if/when the Docker source plguin is moved from bst-external to BuildStream proper - A Docker sandbox, if/when that is added
* update HACKING referencesAdam Jones2018-09-174-3/+3
|
* source/install_source.rst: pip plugin depends on host pipJavier Jardón2018-09-131-0/+1
|
* docs: document protected variablesTiago Gomes2018-09-101-0/+22
| | | | | And remove then from the defaults as they are dynamically set by BuildStream.
* format_project.rst: Document remote-execution optionJim MacArthur2018-09-071-0/+18
| | | | https://gitlab.com/BuildStream/buildstream/issues/454
* Improve documentation for artifact cache installationBen Brewer2018-09-041-5/+8
| | | | | | | Remove ambiguity about systemd service files being separate. Add URL for more information about systemd service files. Add note about public keys being mandatory for self-signed certs. Make cert/key file naming consistent throughout document.
* doc: Adding the release badges to the install page and the semantic ↵Tristan Van Berkom2018-08-294-4/+65
| | | | | | versioning page This is a part of #528
* doc: Adding badges.py release badge generatorTristan Van Berkom2018-08-293-4/+179
| | | | | | | | This adds a step to the docs generation Makefile to generate release.svg and snapshot.svg badges, modelled after the gitlab badges. This also adds the generated badges directory in docs to .gitignore
* Fix E741 warningsjjardon/pycodestyle_fixesJavier Jardón2018-08-281-2/+2
|
* Fix E305 warningsJavier Jardón2018-08-281-0/+1
|
* doc/source/conf.py: Fix E402 warningJavier Jardón2018-08-281-2/+2
|
* doc/source/conf.py: Fix E201, E202 warningsJavier Jardón2018-08-281-1/+1
|
* doc/source/main_install.rst: Clarify that BuildStream cannot be run on WindowsTristan Van Berkom2018-08-271-4/+6
| | | | | | | | The previous wording was misleading and caused one to think you can run BuildStream on Windows, this commit fixes that and rewords the main section heading to be a bit more abstract. Fixes issue #608
* doc/bst2html.py: Fix deprecation warningJavier Jardón2018-08-261-1/+1
| | | | | | | | This fixes the following: " /home/jjardon/buildstream/buildstream/doc/bst2html.py:32: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working from collections import Mapping "
* doc/source/install_source.rst: Explain about release tag in git install ↵Tristan Van Berkom2018-08-252-0/+17
| | | | | | | | instructions. This obsoletes Laurence's explanation in merge request !657, and is a part of the initiative of issue #528 to clarify which versions users should be installing.
* Add section about current releasesTristan Van Berkom2018-08-252-0/+19
| | | | | | | | This is not ideal as the releases are hardcoded, but I think is better than nothing until we got a solution to automate this This commit was originally by Javier Jardón <jjardon@gnome.org> from merge request !661, and then later reworked into an install guide refactor.
* doc/source/install_source.rst: Splitting up install instructionsTristan Van Berkom2018-08-253-255/+281
| | | | | | | Instead of having all of this on one page, we now have a much simpler page for installing on distros where BuildStream is packaged and a separate page for installing distro specific system dependencies and installing from source code (either from PyPI or git).
* doc/source/main_install.rst: Move the main install link target hereTristan Van Berkom2018-08-252-1/+4
| | | | | This is referred to from the artifact install guide, and was previously pointing directly to the source install guide.
* doc/source/main_install.rst: Use one level depth toctreeTristan Van Berkom2018-08-251-1/+1
| | | | | This main section is just a choice of subsections, lets make this more clear with a single level depth toctree.
* doc/source/developing/workspaces.rst: Some whitespace fixesTristan Van Berkom2018-08-251-3/+2
| | | | | Some whitespace changes to follow the style regarding empty lines between sections.
* workspaces.rst: fix note which is not rendering correctlyPhil Dawson2018-08-251-0/+1
|
* workspaces.rst: Move terminal sessions to doc/source/sessions-stored/Phil Dawson2018-08-258-0/+0
|