Add narrative documentation on how we do binary deployment
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 45/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ệ
- cpp, nodejs
- Lĩnh vực
- build-system, documentation, release
Hướng nghiên cứu
Bắt đầu với glossary.md và các trang wiki node-pre-gyp hiện có về External-libraries và FAQ. Theo dõi quy trình được ghi chép từ mã nguồn C++ qua node addons đến việc phân phối binary, bao quát mason và node-pre-gyp, sau đó tích hợp tài liệu cũ liên quan vào repository này cùng với các liên kết đến bảng thuật ngữ và tài liệu liên quan.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Now that our https://github.com/mapbox/cpp/blob/master/glossary.md is fairly complete, it is a good time to add new, narrative docs that tie together glossary terms.
In particular, there is a need for a binary deployment doc that explains the flow from C++ source code -> node addons -> binary distribution.
Here is a first stab at listing things to cover in this doc:
We use mason for:
- distributing pre-compiled (aka binary) static libraries for C/C++ code. And in rare cases shared libraries.
- distributing source code of header-only libraries
- distributing binaries of executables (aka command line programs).
We use node-pre-gyp for:
- Binary deployment of node C++ addons
- When those node C++ addons have external C/C++ dependencies we use mason to pull packages for them
- Soon we'll open source https://github.com/mapbox/mason-js which will make these more seamless (no need for the mason bash scripts)
TODO:
- integrate old node-pre-gyp docs into this repo and modify them to link to the glossary and this repo where appropriate. E.g. https://github.com/mapbox/node-pre-gyp/wiki/External-libraries, https://github.com/mapbox/node-pre-gyp/wiki/FAQ
- Ngôn ngữ chính
- Không có dữ liệu ngôn ngữ
- Star
- 110
- Fork
- 17
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của mapbox/cpp
-
glossary
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 68/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 25/100
-
Docs on ABIs Đang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 30/100
-
clang-tidy v. -Weffc++ Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 30/100
-
docs/learning-resources.md blank Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
Issue tương tự
-
type/automation type/tech-debt
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
priority: p3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
googleapis/librarian#7636 ·
-
Bug v3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
-
Update gh-dash to 4.26.0 Đang mởpackage-update
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
oSoWoSo/vOid_Community_repOsitory#147 · 1 bình luận ·
-
Builders
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100