doc: move gitian building to external repo #11401

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:Mf1708-docGitianFedora changing 34 files +1 −481

MarcoFalke commented at 2:43 PM on September 25, 2017: member

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.

doc: move gitian building to external repo

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.

fa082b4ee0

MarcoFalke added the label Docs and Output on Sep 25, 2017
promag commented at 2:55 PM on September 25, 2017: member

Finally, fetching the source code of the current HEAD is less heavy, as many binary png files are moved out of the repo.

You mean downloading an archive?
MarcoFalke commented at 3:27 PM on September 25, 2017: member

Jup, or fetching with --depth specified, which will fetch a shallow copy.
fanquake commented at 12:59 AM on September 26, 2017: member

~~I'm not completely in favour of this, now the instructions to reproducibly build are no longer available with the code your downloading.~~

I also don't really agree that these are instructions that are "independent of any release cycles". I've occasionally gone back to a historic branch, knowing that the gitian build instructions in that branch will work with that code. Separating the instructions and keeping them updated to only build the latest version of the code means that'll no longer be the case (maybe that doesn't matter).

Regardless, you'll need to update the link under Building in the main readme (dead). You should also remove the partial gitian build instructions here (outdated).
meshcollider commented at 1:29 AM on September 26, 2017: contributor

@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
fanquake commented at 2:34 AM on September 26, 2017: member

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.
laanwj commented at 1:10 PM on September 26, 2017: member

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.

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?

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.
laanwj merged this on Sep 28, 2017
laanwj closed this on Sep 28, 2017
laanwj referenced this in commit 4202273ffa on Sep 28, 2017
laanwj referenced this in commit bbc901d3a6 on Sep 29, 2017
MarcoFalke deleted the branch on Sep 29, 2017
DrahtBot locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#11414 [docs] Remove partial gitian build instructions from descriptors dir.