Add narrative documentation on how we do binary deployment
Personne n'a encore pris cette issue.
- Langage dominant
- Aucune donnée de langage
- Étoiles
- 110
- Forks
- 17
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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](https://github.com/mapbox/cpp/blob/master/glossary.md#precompiled) (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](https://github.com/mapbox/cpp/blob/master/glossary.md#executable) (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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par glossary.md et les pages wiki existantes de node-pre-gyp consacrées à External-libraries et FAQ. Suivez le flux documenté depuis le code source C++ jusqu’à la distribution des binaires en passant par les node addons, en couvrant mason et node-pre-gyp, puis intégrez dans ce dépôt l’ancienne documentation pertinente avec des liens vers le glossaire et les documents associés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- cpp, nodejs
- Domaine
- build-system, documentation, release
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100