Add a more complex example
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by locating the current example project in the BuildStream documentation and reviewing how it presents project creation, commands, and element types. Define the scope of a more realistic example covering Freedesktop-sdk junctions, mirrored Git repositories, overrides, Git CI/CD, and debugging. Done means the documentation includes and explains that complete complex example.
Written by the indexing model from the issue text.
Description
Background
The current example project in the documentation is a good example of how to start a new project and it demos important things such as creating a new project, using various commands, and using various element types. However the project doesn't bridge the gap between a basic hobby project and using Buildstream in a realistic manner.
Problem Description
Specific areas I believe that I believe are particularly missed out on are:
- Junctions are poorly explained.
- The interaction between Junctions and mirrors is not well demoed.
- Overrides are barely touched upon.
- Mirrors are mentioned, but the example is far off actual usage.
Definition of Done
Therefore I think adding a complex example into the Buildstream docs which goes through:
- Junctioning from Freedesktop-sdk
- Building a complex item from a mirrored git-repo
- This should include good examples of Overrides
- This should include good examples of git CI/CD usage
- This should include good examples of Debugging
- Dominant language
- Python
- Stars
- 144
- Forks
- 45
- Avg merge
- 20h 38m
- Merged PRs (30d)
- 6
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/buildstream
-
logging
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
apache/buildstream#2150 · 3 comments ·
-
question
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
apache/buildstream#2143 · 2 comments · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
apache/buildstream#2194 ·
-
Modification time of an element with an open workspace propagates into consumer element's sandbox Openbug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
apache/buildstream#2186 · 2 comments · 2 reactions ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
apache/buildstream#2184 · 1 comment ·
All issues in apache/buildstream
Similar issues
-
triage/confirmed
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
agentscope-ai/agentscope#2775 ·
-
comp/desktop P3 type/bug
Difficulty 1/5 Under an hour Newbie friendliness 92/100
NousResearch/hermes-agent#118866 ·
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 90/100
apache/cloudstack#14222 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100