Add a more complex example

Đang mở
#1,998 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xác định dự án ví dụ hiện tại trong tài liệu BuildStream và xem xét cách dự án này trình bày việc tạo dự án, các lệnh và các loại phần tử. Xác định phạm vi của một ví dụ thực tế hơn, bao quát các junction của Freedesktop-sdk, các kho Git được mirror, overrides, Git CI/CD và gỡ lỗi. Được xem là hoàn tất khi tài liệu bao gồm và giải thích đầy đủ ví dụ phức tạp đó.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation

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
Ngôn ngữ chính
Python
Star
144
Fork
45
Merge trung bình
20 giờ 38 phút
Pull request đã merge (30 ngày)
6

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của apache/buildstream

Tất cả issue của apache/buildstream

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.