Add architectural diagram to main repository #128
Conversation
|
An admin of this repository (@lanthaler) should enable Travis here: https://travis-ci.org/profile/HydraCG |
|
|
||
| ## Overview | ||
|
|
||
|  |
There was a problem hiding this comment.
This should probably be updated
There was a problem hiding this comment.
Yes, but first we need to make sure the CI works.
|
Here's how the diagram currently looks like |
.travis.yml
Outdated
| before_install: | ||
| # Install LaTeX (for architecture diagram) | ||
| - sudo apt-get -qq update | ||
| - sudo apt-get install -y --no-install-recommends texlive-fonts-recommended texlive-latex-extra texlive-fonts-extra texlive-latex-recommended texlive-extra-utils latex-xcolor pgf |
There was a problem hiding this comment.
Can't we use the Travis APT Addon to install dependencies declaratively instead of requiring sudo and doing it through a script?
There was a problem hiding this comment.
Thanks, done in 8932d91.
| # Checkout the gh-pages branch | ||
| REPO_PATH=$PWD | ||
| pushd $HOME | ||
| git clone --quiet --branch=gh-pages https://${GH_TOKEN}@github.com/$REPO_NAME gh-pages 2>&1 > /dev/null |
There was a problem hiding this comment.
Why not use the docs folder approach instead of the (imho) hacky gh-pages branch approach?
There was a problem hiding this comment.
To not mess up the main branch. master only contains source; gh-pages contains compiled code.
I'd contest "hacky" BTW; this is a very reasonable approach used in several repositories.
There was a problem hiding this comment.
What I mean about "hacky" is that this is a weird use of Git. But I agree that it might be a good idea to have compiled code away from master.
There was a problem hiding this comment.
What I mean about "hacky" is that this is a weird use of Git.
Not really. GitHub decided to offer gh-pages as a branch whose contents are exposed through HTTP. So this script simply commits to that branch in order to publish a document over HTTP.
It's a well-known procedure and Travis even has a hook for it (which is slightly different than what I want).
There was a problem hiding this comment.
I'm not questioning everyone's use of the gh-pages feature as it is an important functionality offered by GitHub. What I'm questioning is how the feature is implemented by GitHub, as I consider having a completely clean branch not related to any other branches in the same repository in any way whatsoever (source code management wise, which is what Git is for).
I think GitHub has implemented web site hosting as a hack and is also why I believe the new docs folder functionality has been added. Either way, this is way off topic and not something I feel is very important to agree on within this PR. Over some 🍻 sometime, perhaps? 😄
|
Merging this as agreed on today's telecon: http://www.hydra-cg.com/minutes/2017-07-10/#topic-3 |
This pull requests adds the source code to the architectural diagram to the main repository, together with the Travis code to build it.
Once merged to the master branch, the diagram will be compiled on every commit and placed into the
gh-pagesbranch.