New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: move gitian building to external repo #11401
Conversation
This reduces the overhead in the git repo due to binary blobs of the png files. Also, the documentation can be updated independent of any tags and release cycles.
You mean downloading an archive? |
Jup, or fetching with |
Regardless, you'll need to update the link under Building in the main readme (dead). |
@fanquake note that the instructions for gitian building are still in the release-process.md, only the instructions to set up the gitian building VM is moving |
Right, I guess I always thought of them as being the same thing. In that case, this PR should be updating some docs somewhere here to point to the new home of the guide, maybe in release-process? Otherwise anyone reading that doc gets no indication there is a whole other setup process involved. As well as changes above. |
utACK I agree that having a documentation repository for "heavy" guides like this is a good idea. This also this means not having to carry the images, and most importantly updates to the images in the future.
The file itself contains a link to the new location. Possibly this could be extended to places that link the file, which would save a step, though I have no strong opinion about that. |
fa082b4 doc: move gitian building to external repo (MarcoFalke) Pull request description: The guide was moved to [the Bitcoin Core documentation repository](https://github.com/bitcoin-core/docs/blob/master/gitian-building.md). It now includes not only instructions to run on a debian host, but also on any recent fedora host. This is an ongoing effort to reduce the fraction caused by incoming pull requests to docs (usually fixups, typo fixes, version bumps). This is especially important for documentation that is independent of any release cycles and should thus be up-to-date regardless of a tag on a non-master branch. Finally, fetching a shallow copy of the source is less heavy, as many binary png files are moved out of the repo. Tree-SHA512: c88a11667826d44f90af41e50f9e8d5b3132ae83b278597f13be694872212e7eff99fd877feec0308e00259c69fd4e0ebaf3ff5ab45e08a1e41336aa505bb72b
The guide was moved to the Bitcoin Core documentation repository.
It now includes not only instructions to run on a debian host, but also on
any recent fedora host.
This is an ongoing effort to reduce the fraction caused by incoming
pull requests to docs (usually fixups, typo fixes, version bumps).
This is especially important for documentation that is independent
of any release cycles and should thus be up-to-date regardless
of a tag on a non-master branch.
Finally, fetching a shallow copy of the source is less heavy,
as many binary png files are moved out of the repo.