TokTok / website

The TokTok website
https://toktok.ltd/
GNU General Public License v3.0
10 stars 54 forks source link

Moved travis commands into make file for local development #34

Closed cebe closed 7 years ago

cebe commented 7 years ago

This will allow using the same commands as run by travis via the Makefile for local development.


This change is Reviewable

robinlinden commented 7 years ago

Reviewed 4 of 11 files at r1. Review status: 4 of 8 files reviewed at latest revision, 3 unresolved discussions.


README.md, line 9 at r1 (raw file):

To work on the website you need the following things:

- Jekyll and mdl via ruby gems: `gem install jekyll mdl` (mdl is optinal, for linting the markdown)

s/optinal/optional


README.md, line 10 at r1 (raw file):


- Jekyll and mdl via ruby gems: `gem install jekyll mdl` (mdl is optinal, for linting the markdown)
- pandoc, e.g. via `apt-get install pandoc` or <http://pandoc.org/installing.html>

May want to include cabal install pandoc since cabal is included in the Haskell platform and basically the Haskell version of ruby gems.


README.md, line 22 at r1 (raw file):

- `make spec`: download and parse the spec with pandoc (included in `all`)
- `make lint`: run markdown linter `mdl`
- `make check`: runs linkchecker

s/runs/run


Comments from Reviewable

iphydf commented 7 years ago

Reviewed 11 of 11 files at r1. Review status: all files reviewed at latest revision, 4 unresolved discussions, some commit checks failed.


Makefile, line 23 at r1 (raw file):

changelog: toktok/changelog/c-toxcore.md
toktok/changelog/c-toxcore.md:
  cp $@.dist $@

Clearly c-toxcore.md depends on c-toxcore.md.dist. Please add this dependency. You can then use $< here.

Theoretically you could even do:

toktok/%/c-toxcore.md: toktok/%/c-toxcore.md.dist
        cp $< $@
        curl https://git-critique.herokuapp.com/hello/$* >> $@

Up to you if you want to do that.


Comments from Reviewable

cebe commented 7 years ago

Review status: all files reviewed at latest revision, 4 unresolved discussions, some commit checks failed.


Makefile, line 23 at r1 (raw file):

Previously, iphydf wrote…
Clearly c-toxcore.md depends on c-toxcore.md.dist. Please add this dependency. You can then use `$<` here. Theoretically you could even do: ```make toktok/%/c-toxcore.md: toktok/%/c-toxcore.md.dist cp $< $@ curl https://git-critique.herokuapp.com/hello/$* >> $@ ``` Up to you if you want to do that.

Done.


README.md, line 9 at r1 (raw file):

Previously, robinlinden (Robin Lindén) wrote…
s/optinal/optional

Done.


README.md, line 10 at r1 (raw file):

Previously, robinlinden (Robin Lindén) wrote…
May want to include `cabal install pandoc` since cabal is included in the Haskell platform and basically the Haskell version of ruby gems.

Done.


README.md, line 22 at r1 (raw file):

Previously, robinlinden (Robin Lindén) wrote…
s/runs/run

Done.


Comments from Reviewable

iphydf commented 7 years ago

Reviewed 3 of 3 files at r2. Review status: all files reviewed at latest revision, 3 unresolved discussions, some commit checks failed.


README.md, line 10 at r1 (raw file):

Previously, cebe (Carsten Brandt) wrote…
Done.

cabal install pandoc will take half an hour, while the apt-get version takes 1 minute. Perhaps note that we need at least version ..something.. (I don't actually know, but I know that 1.12 (Ubuntu trusty) works and 1.9 (Ubuntu precise) doesn't).


Comments from Reviewable

cebe commented 7 years ago

Review status: all files reviewed at latest revision, 3 unresolved discussions, some commit checks failed.


README.md, line 10 at r1 (raw file):

Previously, iphydf wrote…
`cabal install pandoc` will take half an hour, while the apt-get version takes 1 minute. Perhaps note that we need at least version ..something.. (I don't actually know, but I know that 1.12 (Ubuntu trusty) works and 1.9 (Ubuntu precise) doesn't).

so better remove it again?


Comments from Reviewable

iphydf commented 7 years ago
:lgtm_strong:

Reviewed 1 of 1 files at r3. Review status: all files reviewed at latest revision, 3 unresolved discussions, some commit checks failed.


Comments from Reviewable

iphydf commented 7 years ago

Review status: all files reviewed at latest revision, 4 unresolved discussions, some commit checks failed.


Makefile, line 28 at r3 (raw file):


spec: toktok/spec.md
toktok/spec.md: hs-toxcore

Perhaps make it depend on hs-toxcore $(shell find hs-toxcore -name "*.lhs" 2> /dev/null). This way, once hs-toxcore is cloned, it will depend on the doc files inside. The 2> /dev/null avoids displaying the error of hs-toxcore not existing the first time.


Comments from Reviewable

cebe commented 7 years ago

Review status: all files reviewed at latest revision, 4 unresolved discussions, some commit checks failed.


Makefile, line 28 at r3 (raw file):

Previously, iphydf wrote…
Perhaps make it depend on `hs-toxcore $(shell find hs-toxcore -name "*.lhs" 2> /dev/null)`. This way, once hs-toxcore is cloned, it will depend on the doc files inside. The `2> /dev/null` avoids displaying the error of hs-toxcore not existing the first time.

Done.


README.md, line 10 at r1 (raw file):

Previously, cebe (Carsten Brandt) wrote…
so better remove it again?

Done.


Comments from Reviewable

robinlinden commented 7 years ago
:lgtm_strong:

Reviewed 6 of 11 files at r1, 1 of 3 files at r2, 1 of 1 files at r3, 1 of 1 files at r4. Review status: all files reviewed at latest revision, 2 unresolved discussions, some commit checks failed.


Comments from Reviewable

iphydf commented 7 years ago

Reviewed 1 of 1 files at r4. Review status: all files reviewed at latest revision, all discussions resolved, some commit checks failed.


Comments from Reviewable