Re: Review Request 43221: Updated Rakefile to support subdirectories in /docs folder.

[Ben Mahler]

---
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43221/#review117970
---


Ship it!





site/Rakefile (lines 31 - 34)


Some whitespace and typo touchups needed here.


- Ben Mahler


On Feb. 5, 2016, 3:27 a.m., Kevin Klues wrote:
> 
> ---
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/43221/
> ---
> 
> (Updated Feb. 5, 2016, 3:27 a.m.)
> 
> 
> Review request for mesos, Ben Mahler, Greg Mann, and Neil Conway.
> 
> 
> Bugs: MESOS-3831
> https://issues.apache.org/jira/browse/MESOS-3831
> 
> 
> Repository: mesos
> 
> 
> Description
> ---
> 
> Previously, the Rakefile for generating the mesos documentation
> website didn't support subdirectories containing markdown in the /docs
> folder. Specifically, no subdirectores were cpoied from the /docs
> folder into the site/documentation/latest folder for the website.
> Moreover, the regex used to patch relative links for the markdown
> files was incomplete. It didn't support subfolders contaning a
> top level index.md file (e.g. mydirectory/index.md). Also, due to a
> limitation in middleman, it didn't support .md files named (e.g.
> state.json.md). Middlman would generate an *html* file called
> state.json from this instead of generating the standard
> state.json/index.html like it does for other .md files.
> 
> This commit updates the Rakefile to support these features properly.
> 
> 
> Diffs
> -
> 
>   site/Rakefile 0ce4b7975f95ab6930f0b2674191930df9ab5b20 
> 
> Diff: https://reviews.apache.org/r/43221/diff/
> 
> 
> Testing
> ---
> 
> 
> Thanks,
> 
> Kevin Klues
> 
>

Re: Review Request 43221: Updated Rakefile to support subdirectories in /docs folder.

[Kevin Klues]

---
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43221/
---

(Updated Feb. 5, 2016, 3:27 a.m.)


Review request for mesos, Ben Mahler, Greg Mann, and Neil Conway.


Changes
---

Updated based on bmahler's comments.


Bugs: MESOS-3831
https://issues.apache.org/jira/browse/MESOS-3831


Repository: mesos


Description
---

Previously, the Rakefile for generating the mesos documentation
website didn't support subdirectories containing markdown in the /docs
folder. Specifically, no subdirectores were cpoied from the /docs
folder into the site/documentation/latest folder for the website.
Moreover, the regex used to patch relative links for the markdown
files was incomplete. It didn't support subfolders contaning a
top level index.md file (e.g. mydirectory/index.md). Also, due to a
limitation in middleman, it didn't support .md files named (e.g.
state.json.md). Middlman would generate an *html* file called
state.json from this instead of generating the standard
state.json/index.html like it does for other .md files.

This commit updates the Rakefile to support these features properly.


Diffs (updated)
-

  site/Rakefile 0ce4b7975f95ab6930f0b2674191930df9ab5b20 

Diff: https://reviews.apache.org/r/43221/diff/


Testing
---


Thanks,

Kevin Klues

Re: Review Request 43221: Updated Rakefile to support subdirectories in /docs folder.

[Ben Mahler]

---
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/43221/#review117948
---




site/Rakefile (lines 30 - 37)


Mind documenting the reason we had to do this, for posterity? I certainly 
will not remember :)



site/Rakefile (line 34)


Do we need the `-p` here on mkdir?



site/Rakefile (line 42)


Could we put the slash in the regex instead of in the variable?



site/Rakefile (lines 44 - 46)


Not yours, but could we add a TODO here to move away from regexes and do a 
programmatic set of steps to perform the replacement? That will be way easier 
to reason about, this regex has become nasty.


- Ben Mahler


On Feb. 4, 2016, 8:38 p.m., Kevin Klues wrote:
> 
> ---
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/43221/
> ---
> 
> (Updated Feb. 4, 2016, 8:38 p.m.)
> 
> 
> Review request for mesos, Ben Mahler, Greg Mann, and Neil Conway.
> 
> 
> Bugs: MESOS-3831
> https://issues.apache.org/jira/browse/MESOS-3831
> 
> 
> Repository: mesos
> 
> 
> Description
> ---
> 
> Previously, the Rakefile for generating the mesos documentation
> website didn't support subdirectories containing markdown in the /docs
> folder. Specifically, no subdirectores were cpoied from the /docs
> folder into the site/documentation/latest folder for the website.
> Moreover, the regex used to patch relative links for the markdown
> files was incomplete. It didn't support subfolders contaning a
> top level index.md file (e.g. mydirectory/index.md). Also, due to a
> limitation in middleman, it didn't support .md files named (e.g.
> state.json.md). Middlman would generate an *html* file called
> state.json from this instead of generating the standard
> state.json/index.html like it does for other .md files.
> 
> This commit updates the Rakefile to support these features properly.
> 
> 
> Diffs
> -
> 
>   site/Rakefile 0ce4b7975f95ab6930f0b2674191930df9ab5b20 
> 
> Diff: https://reviews.apache.org/r/43221/diff/
> 
> 
> Testing
> ---
> 
> 
> Thanks,
> 
> Kevin Klues
> 
>