You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@mesos.apache.org by Tim Anderegg <ti...@gmail.com> on 2017/05/04 21:26:56 UTC
Re: Review Request 52064: Support for multiple versions of docs.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/
-----------------------------------------------------------
(Updated May 4, 2017, 9:26 p.m.)
Review request for mesos, haosdent huang and Vinod Kone.
Bugs: MESOS-3011
https://issues.apache.org/jira/browse/MESOS-3011
Repository: mesos
Description
-------
Support for multiple versions of docs.
Diffs
-----
site/Dockerfile 8ba0be0c28e924f7a2b89e6e5a3237deb3751a41
site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
site/build.sh 11f15e15621c4d3db1472e88911787b9b3100f97
site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
site/data/releases.yml 755300aa83a1017362129bad256381d10c815609
site/source/assets/css/main.css 83596ddbd833e36b60bdbbd487ebd464b3874119
site/source/assets/js/versions.js PRE-CREATION
site/source/layouts/basic.erb 7464e40b619e883daad93c72c3fbdbfbdda8f152
site/source/layouts/documentation.erb a91f916a5fb7348b2702c272e7a2059bdf628c66
site/source/layouts/gettingstarted.erb PRE-CREATION
Diff: https://reviews.apache.org/r/52064/diff/2/
Testing
-------
Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
Thanks,
Tim Anderegg
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Mesos Reviewbot <re...@mesos.apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review174121
-----------------------------------------------------------
Patch looks great!
Reviews applied: [52064]
Passed command: export OS='ubuntu:14.04' BUILDTOOL='autotools' COMPILER='gcc' CONFIGURATION='--verbose' ENVIRONMENT='GLOG_v=1 MESOS_VERBOSE=1'; ./support/docker-build.sh
- Mesos Reviewbot
On May 5, 2017, 9:23 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated May 5, 2017, 9:23 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
> site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
> site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
> site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
> site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
>
>
> Diff: https://reviews.apache.org/r/52064/diff/5/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Mesos Reviewbot Windows <re...@mesos.apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review185249
-----------------------------------------------------------
FAIL: Failed to apply the current review.
Failed command: `python.exe .\support\apply-reviews.py -n -r 52064`
All the build artifacts available at: http://dcos-win.westus.cloudapp.azure.com/mesos-build/review/52064
Relevant logs:
- [apply-review-52064-stdout.log](http://dcos-win.westus.cloudapp.azure.com/mesos-build/review/52064/logs/apply-review-52064-stdout.log):
```error: patch failed: site/Gemfile:8
error: site/Gemfile: patch does not apply
error: patch failed: site/Gemfile.lock:1
error: site/Gemfile.lock: patch does not apply
error: patch failed: site/data/releases.yml:112
error: site/data/releases.yml: patch does not apply
```
- Mesos Reviewbot Windows
On May 5, 2017, 9:23 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated May 5, 2017, 9:23 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
> site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
> site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
> site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
> site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
>
>
> Diff: https://reviews.apache.org/r/52064/diff/5/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
> On Feb. 9, 2018, 6:02 p.m., Benjamin Bannier wrote:
> > I am wondering whether it wouldn't be simpler to have the site setup just generate output for the currently checked-out version and dump that into some version-specific output folder. We could then have some CI setup execute this for the different tags or branches we care about. This wouldn't only simplify the site setup, but probably also deal better with e.g., changed requirements to the base system (e.g., needed to build binaries generating the endpoint documentation) which are currently not managed in the rake file.
> >
> > One difficulty with that approach would be to determine under what branch we are actually working on. My guess is that we wouldn't want to update to documentation of 1.3.0 until we have tagged a 1.3.0 version, so we'd likely build documentation for the n-latest tags. The `HEAD` of `master` is more tricky as it would change more frequently and not directly have a release tag as parent (these live on release branches) making it harder to work with say `git-describe`. Maybe we could parse this from source, e.g., `MESOS_VERSION` in `include/mesos/version.hpp`.
> >
> > The other difficulty might be that we might move a lot of site-generation setup out of the repo into e.g., Jenkins config. There are probably ways to work around that, but I haven't thought that through.
I'm not familiar with how Jenkins is configured and used here, but your approach could be simpler depending on how complex the CI build setup is. This patch would remain mostly the same, except lines 68-89 of the Rakefile could be removed and the git dependency would no longer be necessary. The version could then be fed in by Jenkins, which would probably be easier/simpler than trying to programmatically determine the version. Right now "master" just translates to "latest" in the patch as-is.
I saw putting everything in the Rakefile as the most straightforward approach, since it allows the correct versions to generate docs for to be determined programmatically, avoiding the difficulty you mentioned above. However, it does require generating all documentation for all versions on each build, and significant changes to the build process or documentation process down the road might make it difficult to maintain a backwards-compatible approach (e.g. I currently disable doc generation for the oldest dozen tags or so which don't have the same documentation setup, or any documentation at all).
- Tim
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review197173
-----------------------------------------------------------
On Feb. 9, 2018, 1:46 a.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 9, 2018, 1:46 a.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml e3edc308a5429585b3fc3f05564d695ba3217035
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/6/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Benjamin Mahler <bm...@apache.org>.
> On Feb. 9, 2018, 6:02 p.m., Benjamin Bannier wrote:
> > I am wondering whether it wouldn't be simpler to have the site setup just generate output for the currently checked-out version and dump that into some version-specific output folder. We could then have some CI setup execute this for the different tags or branches we care about. This wouldn't only simplify the site setup, but probably also deal better with e.g., changed requirements to the base system (e.g., needed to build binaries generating the endpoint documentation) which are currently not managed in the rake file.
> >
> > One difficulty with that approach would be to determine under what branch we are actually working on. My guess is that we wouldn't want to update to documentation of 1.3.0 until we have tagged a 1.3.0 version, so we'd likely build documentation for the n-latest tags. The `HEAD` of `master` is more tricky as it would change more frequently and not directly have a release tag as parent (these live on release branches) making it harder to work with say `git-describe`. Maybe we could parse this from source, e.g., `MESOS_VERSION` in `include/mesos/version.hpp`.
> >
> > The other difficulty might be that we might move a lot of site-generation setup out of the repo into e.g., Jenkins config. There are probably ways to work around that, but I haven't thought that through.
>
> Tim Anderegg wrote:
> I'm not familiar with how Jenkins is configured and used here, but your approach could be simpler depending on how complex the CI build setup is. This patch would remain mostly the same, except lines 68-89 of the Rakefile could be removed and the git dependency would no longer be necessary. The version could then be fed in by Jenkins, which would probably be easier/simpler than trying to programmatically determine the version. Right now "master" just translates to "latest" in the patch as-is.
>
> I saw putting everything in the Rakefile as the most straightforward approach, since it allows the correct versions to generate docs for to be determined programmatically, avoiding the difficulty you mentioned above. However, it does require generating all documentation for all versions on each build, and significant changes to the build process or documentation process down the road might make it difficult to maintain a backwards-compatible approach (e.g. I currently disable doc generation for the oldest dozen tags or so which don't have the same documentation setup, or any documentation at all).
I tend to prefer the approach Benjamin's suggested above since the documentation generation will be versioned alongside the documentation, so that we don't have to deal with backwards compatibility of documentation generation on HEAD.
- Benjamin
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review197173
-----------------------------------------------------------
On Feb. 9, 2018, 1:46 a.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 9, 2018, 1:46 a.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml e3edc308a5429585b3fc3f05564d695ba3217035
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/6/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Benjamin Bannier <be...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review197173
-----------------------------------------------------------
I am wondering whether it wouldn't be simpler to have the site setup just generate output for the currently checked-out version and dump that into some version-specific output folder. We could then have some CI setup execute this for the different tags or branches we care about. This wouldn't only simplify the site setup, but probably also deal better with e.g., changed requirements to the base system (e.g., needed to build binaries generating the endpoint documentation) which are currently not managed in the rake file.
One difficulty with that approach would be to determine under what branch we are actually working on. My guess is that we wouldn't want to update to documentation of 1.3.0 until we have tagged a 1.3.0 version, so we'd likely build documentation for the n-latest tags. The `HEAD` of `master` is more tricky as it would change more frequently and not directly have a release tag as parent (these live on release branches) making it harder to work with say `git-describe`. Maybe we could parse this from source, e.g., `MESOS_VERSION` in `include/mesos/version.hpp`.
The other difficulty might be that we might move a lot of site-generation setup out of the repo into e.g., Jenkins config. There are probably ways to work around that, but I haven't thought that through.
- Benjamin Bannier
On Feb. 9, 2018, 2:46 a.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 9, 2018, 2:46 a.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml e3edc308a5429585b3fc3f05564d695ba3217035
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/6/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Mesos Reviewbot Windows <re...@mesos.apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review197144
-----------------------------------------------------------
FAIL: Failed to apply the current review.
Failed command: `python.exe .\support\apply-reviews.py -n -r 52064`
All the build artifacts available at: http://dcos-win.westus.cloudapp.azure.com/mesos-build/review/52064
Relevant logs:
- [apply-review-52064-stdout.log](http://dcos-win.westus.cloudapp.azure.com/mesos-build/review/52064/logs/apply-review-52064-stdout.log):
```
error: patch failed: site/data/releases.yml:154
error: site/data/releases.yml: patch does not apply
```
- Mesos Reviewbot Windows
On Feb. 9, 2018, 1:46 a.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 9, 2018, 1:46 a.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml e3edc308a5429585b3fc3f05564d695ba3217035
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/6/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Mesos Reviewbot Windows <re...@mesos.apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review197418
-----------------------------------------------------------
PASS: Mesos patch 52064 was successfully built and tested.
Reviews applied: `['52064']`
All the build artifacts available at: http://dcos-win.westus.cloudapp.azure.com/mesos-build/review/52064
- Mesos Reviewbot Windows
On Feb. 13, 2018, 7:44 a.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 13, 2018, 7:44 a.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> This patch updates the website build process to allow for documentation to be generated for all versions of Mesos, based on the existing Git tags. Additionally, the website is updated with a dropdown list of the available versions of documentation. If a user changes versions and the old version does not have the current page, a notice will be displayed and the user redirected to the home page for the desired version.
>
> This is a temporary measure to "catchup" the documentation for the website by generating docs for all previous versions. Going forward, as each new version of Mesos is released the documentation will be generated for that version only.
>
> 
> Screenshot of the dropdown list of versions.
>
> 
> Screenshot of the message displayed if a page does not exist for the selected version.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml 56fd0fc7f5e34873c9b088778d77f9a6718a5933
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/7/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
> On Feb. 24, 2018, 12:50 a.m., Benjamin Mahler wrote:
> > Vinod and I went over this, a couple of issues:
> >
> > * The [endpoint documentation](http://mesos.apache.org/documentation/latest/endpoints/) is only being generated for latest (see https://github.com/apache/mesos/blob/master/support/mesos-website/build.sh), this needs to be generated for each version.
> > * The C++ and Java API documentation is only being generated for latest (not sure how easy this is to fix, maybe if you also tackle this do so in a seperate patch). Also note that home.md linked directly to "/api/latest/c++" and "/api/latest/java" which means that the old versions would send users to latest c++ and java docs.
> > * We had a hard time figuring why some of the code changes were needed or what they were doing (e.g. some of the new regexes, or why the version selector drop-down has an empty value for the first entry), some comments would be helpful for the reader.
> >
> > We were thinking the following approach would be good alternative:
> >
> > * In order to ensure that we generate the HTTP help endpoint documentation correctly for each version, the [build.sh](https://github.com/apache/mesos/blob/master/support/mesos-website/build.sh) script would loop over each 1.x.y tag (excluding -rc#'s) and checkout the tag into a sub-directory. Within this sub-directory, we would build mesos and generate the help endpoints documentation. This sub-directory would probably be named directly as the version (e.g. "1.0.0", "1.4.1", etc).
> > * Note that for efficiency reasons (it's very expensive to build mesos for so many tags), the build.sh script would skip a tag if it finds that the publish directory already exists for the version in the mesos-site repository.
> > * The Rakefile would be updated to look at each version checkout subdirectory, and would generate the docs using the documentation folder within that specific version subdirectory.
> > * Not sure if the releases YAML still needs the docs tag, it seems so since it's used in the javascript. This would at least need to be updated so that everything before 1.0.0 is "false".
> > * Is it possible to put the version selector on the right side of the blue banner?
Sounds good. I had initially avoided the C++ and Java API documentation since it would take a very long time to generate, as you mention, but I'm happy to tackle that as well. Limiting to 1.0.0+ will alleviate that a bit.
For the regex, the first change was just a simplification since the two lines were redundant once I updated the code to use "{{ version }}" instead of "latest" (I will verify that however, in case I am remembering incorrectly). The second change was to account for older versions of the Mesos code where "latest" was hardcoded into the HTML templates themselves, which would mess up the links. That one is already commented, but I will go through and add comments wherever there may be ambiguity. Since we are now doing only 1.0.0+, this work around can probably be removed.
For the version selector, happy to move it and remove the empty option, since the value should always be the currently displayed version of the documentation. I'm also not sure why I did that, it was a while ago...
For the docs tag, we could either keep it or if we want the logic to just be "all versions from 1.0.0 onwards", that can be hard coded into the build.sh and the HTML template, and we could remove the docs tag. Let me know what you prefer.
For the updated approach, just to make sure I'm clear:
1) In build.sh, iterate over all tags and checkout the code into a folder with the tag name, (perhaps in $WORKSPACE/mesos/_build/x.y.z/) if the primary $WORKSPACE/mesos/site/publish/documentation/x.y.z folder doesn't already exist.
2) Then the Rakefile (from $WORKSPACE/mesos, i.e. the HEAD version) is used to build the docs for each version folder into the primary $WORKSPACE/mesos/site/publish/documentation/x.y.z folder, as before, but only if it doesn't already exist.
A few questions:
1) I'm assuming that this build occurs in a Jenkins job that retains its workspace between runs, which is why we are checking whether or not the folder exists? Or is the mesos-website publish folder the only thing that persists between runs? Just want to make sure my conception of the build environment is correct, if the later is true question 2 can be ignored.
2) Should the script remove the checked-out code after the build runs for each version that needed it? Otherwise over time many copies of the Mesos code would persist (one for each tagged version), which would be GB's in size.
Thanks! I should be able to find time to do this over the next week or so.
Tim
- Tim
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review198236
-----------------------------------------------------------
On Feb. 13, 2018, 3:44 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 13, 2018, 3:44 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> This patch updates the website build process to allow for documentation to be generated for all versions of Mesos, based on the existing Git tags. Additionally, the website is updated with a dropdown list of the available versions of documentation. If a user changes versions and the old version does not have the current page, a notice will be displayed and the user redirected to the home page for the desired version.
>
> This is a temporary measure to "catchup" the documentation for the website by generating docs for all previous versions. Going forward, as each new version of Mesos is released the documentation will be generated for that version only.
>
> 
> Screenshot of the dropdown list of versions.
>
> 
> Screenshot of the message displayed if a page does not exist for the selected version.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml 56fd0fc7f5e34873c9b088778d77f9a6718a5933
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/7/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Benjamin Mahler <bm...@apache.org>.
> On Feb. 24, 2018, 12:50 a.m., Benjamin Mahler wrote:
> > Vinod and I went over this, a couple of issues:
> >
> > * The [endpoint documentation](http://mesos.apache.org/documentation/latest/endpoints/) is only being generated for latest (see https://github.com/apache/mesos/blob/master/support/mesos-website/build.sh), this needs to be generated for each version.
> > * The C++ and Java API documentation is only being generated for latest (not sure how easy this is to fix, maybe if you also tackle this do so in a seperate patch). Also note that home.md linked directly to "/api/latest/c++" and "/api/latest/java" which means that the old versions would send users to latest c++ and java docs.
> > * We had a hard time figuring why some of the code changes were needed or what they were doing (e.g. some of the new regexes, or why the version selector drop-down has an empty value for the first entry), some comments would be helpful for the reader.
> >
> > We were thinking the following approach would be good alternative:
> >
> > * In order to ensure that we generate the HTTP help endpoint documentation correctly for each version, the [build.sh](https://github.com/apache/mesos/blob/master/support/mesos-website/build.sh) script would loop over each 1.x.y tag (excluding -rc#'s) and checkout the tag into a sub-directory. Within this sub-directory, we would build mesos and generate the help endpoints documentation. This sub-directory would probably be named directly as the version (e.g. "1.0.0", "1.4.1", etc).
> > * Note that for efficiency reasons (it's very expensive to build mesos for so many tags), the build.sh script would skip a tag if it finds that the publish directory already exists for the version in the mesos-site repository.
> > * The Rakefile would be updated to look at each version checkout subdirectory, and would generate the docs using the documentation folder within that specific version subdirectory.
> > * Not sure if the releases YAML still needs the docs tag, it seems so since it's used in the javascript. This would at least need to be updated so that everything before 1.0.0 is "false".
> > * Is it possible to put the version selector on the right side of the blue banner?
>
> Tim Anderegg wrote:
> Sounds good. I had initially avoided the C++ and Java API documentation since it would take a very long time to generate, as you mention, but I'm happy to tackle that as well. Limiting to 1.0.0+ will alleviate that a bit.
>
> For the regex, the first change was just a simplification since the two lines were redundant once I updated the code to use "{{ version }}" instead of "latest" (I will verify that however, in case I am remembering incorrectly). The second change was to account for older versions of the Mesos code where "latest" was hardcoded into the HTML templates themselves, which would mess up the links. That one is already commented, but I will go through and add comments wherever there may be ambiguity. Since we are now doing only 1.0.0+, this work around can probably be removed.
>
> For the version selector, happy to move it and remove the empty option, since the value should always be the currently displayed version of the documentation. I'm also not sure why I did that, it was a while ago...
>
> For the docs tag, we could either keep it or if we want the logic to just be "all versions from 1.0.0 onwards", that can be hard coded into the build.sh and the HTML template, and we could remove the docs tag. Let me know what you prefer.
>
> For the updated approach, just to make sure I'm clear:
>
> 1) In build.sh, iterate over all tags and checkout the code into a folder with the tag name, (perhaps in $WORKSPACE/mesos/_build/x.y.z/) if the primary $WORKSPACE/mesos/site/publish/documentation/x.y.z folder doesn't already exist.
> 2) Then the Rakefile (from $WORKSPACE/mesos, i.e. the HEAD version) is used to build the docs for each version folder into the primary $WORKSPACE/mesos/site/publish/documentation/x.y.z folder, as before, but only if it doesn't already exist.
>
> A few questions:
>
> 1) I'm assuming that this build occurs in a Jenkins job that retains its workspace between runs, which is why we are checking whether or not the folder exists? Or is the mesos-website publish folder the only thing that persists between runs? Just want to make sure my conception of the build environment is correct, if the later is true question 2 can be ignored.
> 2) Should the script remove the checked-out code after the build runs for each version that needed it? Otherwise over time many copies of the Mesos code would persist (one for each tagged version), which would be GB's in size.
>
> Thanks! I should be able to find time to do this over the next week or so.
>
> Tim
> For the docs tag, we could either keep it or if we want the logic to just be "all versions from 1.0.0 onwards", that can be hard coded into the build.sh and the HTML template, and we could remove the docs tag. Let me know what you prefer.
Both sound ok to me, the advantage of the docs tag in the YAML seems to be that we have some more control to disable specific releases if there ever were some issues (e.g. we did a bad .patch release with screwed up documentation, but it was missed during the VOTE).
> 1) I'm assuming that this build occurs in a Jenkins job that retains its workspace between runs, which is why we are checking whether or not the folder exists? Or is the mesos-website publish folder the only thing that persists between runs? Just want to make sure my conception of the build environment is correct, if the later is true question 2 can be ignored.
I believe the CI bot will start with a fresh working space each time. The directory that gets "persisted" is only the folder within the mesos-site "publish" directory as you said.
> Thanks! I should be able to find time to do this over the next week or so.
Awesome! Let us know if that changes or if you want any more discussion :)
- Benjamin
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review198236
-----------------------------------------------------------
On Feb. 13, 2018, 3:44 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 13, 2018, 3:44 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> This patch updates the website build process to allow for documentation to be generated for all versions of Mesos, based on the existing Git tags. Additionally, the website is updated with a dropdown list of the available versions of documentation. If a user changes versions and the old version does not have the current page, a notice will be displayed and the user redirected to the home page for the desired version.
>
> This is a temporary measure to "catchup" the documentation for the website by generating docs for all previous versions. Going forward, as each new version of Mesos is released the documentation will be generated for that version only.
>
> 
> Screenshot of the dropdown list of versions.
>
> 
> Screenshot of the message displayed if a page does not exist for the selected version.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml 56fd0fc7f5e34873c9b088778d77f9a6718a5933
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/7/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Benjamin Mahler <bm...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review198236
-----------------------------------------------------------
Vinod and I went over this, a couple of issues:
* The [endpoint documentation](http://mesos.apache.org/documentation/latest/endpoints/) is only being generated for latest (see https://github.com/apache/mesos/blob/master/support/mesos-website/build.sh), this needs to be generated for each version.
* The C++ and Java API documentation is only being generated for latest (not sure how easy this is to fix, maybe if you also tackle this do so in a seperate patch). Also note that home.md linked directly to "/api/latest/c++" and "/api/latest/java" which means that the old versions would send users to latest c++ and java docs.
* We had a hard time figuring why some of the code changes were needed or what they were doing (e.g. some of the new regexes, or why the version selector drop-down has an empty value for the first entry), some comments would be helpful for the reader.
We were thinking the following approach would be good alternative:
* In order to ensure that we generate the HTTP help endpoint documentation correctly for each version, the [build.sh](https://github.com/apache/mesos/blob/master/support/mesos-website/build.sh) script would loop over each 1.x.y tag (excluding -rc#'s) and checkout the tag into a sub-directory. Within this sub-directory, we would build mesos and generate the help endpoints documentation. This sub-directory would probably be named directly as the version (e.g. "1.0.0", "1.4.1", etc).
* Note that for efficiency reasons (it's very expensive to build mesos for so many tags), the build.sh script would skip a tag if it finds that the publish directory already exists for the version in the mesos-site repository.
* The Rakefile would be updated to look at each version checkout subdirectory, and would generate the docs using the documentation folder within that specific version subdirectory.
* Not sure if the releases YAML still needs the docs tag, it seems so since it's used in the javascript. This would at least need to be updated so that everything before 1.0.0 is "false".
* Is it possible to put the version selector on the right side of the blue banner?
- Benjamin Mahler
On Feb. 13, 2018, 3:44 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 13, 2018, 3:44 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> This patch updates the website build process to allow for documentation to be generated for all versions of Mesos, based on the existing Git tags. Additionally, the website is updated with a dropdown list of the available versions of documentation. If a user changes versions and the old version does not have the current page, a notice will be displayed and the user redirected to the home page for the desired version.
>
> This is a temporary measure to "catchup" the documentation for the website by generating docs for all previous versions. Going forward, as each new version of Mesos is released the documentation will be generated for that version only.
>
> 
> Screenshot of the dropdown list of versions.
>
> 
> Screenshot of the message displayed if a page does not exist for the selected version.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml 56fd0fc7f5e34873c9b088778d77f9a6718a5933
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/7/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Mesos Reviewbot <re...@mesos.apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review197432
-----------------------------------------------------------
Patch looks great!
Reviews applied: [52064]
Passed command: export OS='ubuntu:14.04' BUILDTOOL='autotools' COMPILER='gcc' CONFIGURATION='--verbose --disable-libtool-wrappers' ENVIRONMENT='GLOG_v=1 MESOS_VERBOSE=1'; ./support/docker-build.sh
- Mesos Reviewbot
On Feb. 13, 2018, 3:44 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 13, 2018, 3:44 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> This patch updates the website build process to allow for documentation to be generated for all versions of Mesos, based on the existing Git tags. Additionally, the website is updated with a dropdown list of the available versions of documentation. If a user changes versions and the old version does not have the current page, a notice will be displayed and the user redirected to the home page for the desired version.
>
> This is a temporary measure to "catchup" the documentation for the website by generating docs for all previous versions. Going forward, as each new version of Mesos is released the documentation will be generated for that version only.
>
> 
> Screenshot of the dropdown list of versions.
>
> 
> Screenshot of the message displayed if a page does not exist for the selected version.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml 56fd0fc7f5e34873c9b088778d77f9a6718a5933
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/7/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/
-----------------------------------------------------------
(Updated Feb. 13, 2018, 3:44 p.m.)
Review request for mesos, haosdent huang and Vinod Kone.
Changes
-------
Rebased and added more detailed description with screenshots.
Bugs: MESOS-3011
https://issues.apache.org/jira/browse/MESOS-3011
Repository: mesos
Description (updated)
-------
This patch updates the website build process to allow for documentation to be generated for all versions of Mesos, based on the existing Git tags. Additionally, the website is updated with a dropdown list of the available versions of documentation. If a user changes versions and the old version does not have the current page, a notice will be displayed and the user redirected to the home page for the desired version.
This is a temporary measure to "catchup" the documentation for the website by generating docs for all previous versions. Going forward, as each new version of Mesos is released the documentation will be generated for that version only.
Screenshot of the dropdown list of versions.
Screenshot of the message displayed if a page does not exist for the selected version.
Diffs (updated)
-----
site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
site/data/releases.yml 56fd0fc7f5e34873c9b088778d77f9a6718a5933
site/source/assets/js/versions.js PRE-CREATION
site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
Diff: https://reviews.apache.org/r/52064/diff/7/
Changes: https://reviews.apache.org/r/52064/diff/6-7/
Testing
-------
Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
Thanks,
Tim Anderegg
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Mesos Reviewbot <re...@mesos.apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review197165
-----------------------------------------------------------
Bad patch!
Reviews applied: [52064]
Failed command: python support/apply-reviews.py -n -r 52064
Error:
2018-02-09 15:06:42 URL:https://reviews.apache.org/r/52064/diff/raw/ [13073/13073] -> "52064.patch" [1]
error: patch failed: site/data/releases.yml:154
error: site/data/releases.yml: patch does not apply
Full log: https://builds.apache.org/job/Mesos-Reviewbot/21583/console
- Mesos Reviewbot
On Feb. 9, 2018, 1:46 a.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated Feb. 9, 2018, 1:46 a.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
> site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
> site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
> site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
> site/data/releases.yml e3edc308a5429585b3fc3f05564d695ba3217035
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
>
>
> Diff: https://reviews.apache.org/r/52064/diff/6/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/
-----------------------------------------------------------
(Updated Feb. 9, 2018, 1:46 a.m.)
Review request for mesos, haosdent huang and Vinod Kone.
Changes
-------
Rebased against latest
Bugs: MESOS-3011
https://issues.apache.org/jira/browse/MESOS-3011
Repository: mesos
Description
-------
Support for multiple versions of docs.
Diffs (updated)
-----
site/Gemfile 877fe914a9787c140848fdf9958571fec5fa58ff
site/Gemfile.lock 909f3f3badeaa47c80929e243ce36307766edee4
site/Rakefile 31ef6ffe225ce7ddc573054058af1070b9e96b09
site/config.rb 04bc7aa1e0ac61ce5d89fd53d32f265532996913
site/data/releases.yml e3edc308a5429585b3fc3f05564d695ba3217035
site/source/assets/js/versions.js PRE-CREATION
site/source/layouts/basic.erb 8a07488940f3793d6fdd291dbe896e098f321c96
Diff: https://reviews.apache.org/r/52064/diff/6/
Changes: https://reviews.apache.org/r/52064/diff/5-6/
Testing
-------
Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
Thanks,
Tim Anderegg
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
> On May 9, 2017, 4:30 p.m., haosdent huang wrote:
> > Hi, @tim Thanks a lot for your update. I am still reading you patch and have not finished. Could return my comments if it works at my side. Thanks a lot for your contributions.
Thanks @haosdent, please let me know if you have any questions or need clarification on anything!
- Tim
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review174335
-----------------------------------------------------------
On May 5, 2017, 9:23 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated May 5, 2017, 9:23 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
> site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
> site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
> site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
> site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
>
>
> Diff: https://reviews.apache.org/r/52064/diff/5/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Vinod Kone <vi...@gmail.com>.
> On May 9, 2017, 4:30 p.m., haosdent huang wrote:
> > Hi, @tim Thanks a lot for your update. I am still reading you patch and have not finished. Could return my comments if it works at my side. Thanks a lot for your contributions.
>
> Tim Anderegg wrote:
> Thanks @haosdent, please let me know if you have any questions or need clarification on anything!
Any further updates on this? @haosdent can you commit this now?
- Vinod
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review174335
-----------------------------------------------------------
On May 5, 2017, 9:23 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated May 5, 2017, 9:23 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
> site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
> site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
> site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
> site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
>
>
> Diff: https://reviews.apache.org/r/52064/diff/5/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Vinod Kone <vi...@apache.org>.
Great. I'll be there too!
On Tue, Sep 12, 2017 at 11:59 AM, Tim Anderegg <ti...@gmail.com>
wrote:
>
>
> > On May 9, 2017, 4:30 p.m., haosdent huang wrote:
> > > Hi, @tim Thanks a lot for your update. I am still reading you patch
> and have not finished. Could return my comments if it works at my side.
> Thanks a lot for your contributions.
> >
> > Tim Anderegg wrote:
> > Thanks @haosdent, please let me know if you have any questions or
> need clarification on anything!
> >
> > Vinod Kone wrote:
> > Any further updates on this? @haosdent can you commit this now?
>
> @haosdent @vinodkone This probably at least needs a rebase, but
> functionally speaking everything should be in working order. I'll be at
> the hackathon at MesosCon tomorrow, if folks want to work on closing this
> out!
>
>
> - Tim
>
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/#review174335
> -----------------------------------------------------------
>
>
> On May 5, 2017, 9:23 p.m., Tim Anderegg wrote:
> >
> > -----------------------------------------------------------
> > This is an automatically generated e-mail. To reply, visit:
> > https://reviews.apache.org/r/52064/
> > -----------------------------------------------------------
> >
> > (Updated May 5, 2017, 9:23 p.m.)
> >
> >
> > Review request for mesos, haosdent huang and Vinod Kone.
> >
> >
> > Bugs: MESOS-3011
> > https://issues.apache.org/jira/browse/MESOS-3011
> >
> >
> > Repository: mesos
> >
> >
> > Description
> > -------
> >
> > Support for multiple versions of docs.
> >
> >
> > Diffs
> > -----
> >
> > site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
> > site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
> > site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
> > site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
> > site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
> > site/source/assets/js/versions.js PRE-CREATION
> > site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
> >
> >
> > Diff: https://reviews.apache.org/r/52064/diff/5/
> >
> >
> > Testing
> > -------
> >
> > Testing was done manually to verify that the documentation was built for
> each version of Mesos that is supported (some older versions do not have
> compatible documentation).
> >
> >
> > Thanks,
> >
> > Tim Anderegg
> >
> >
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
> On May 9, 2017, 4:30 p.m., haosdent huang wrote:
> > Hi, @tim Thanks a lot for your update. I am still reading you patch and have not finished. Could return my comments if it works at my side. Thanks a lot for your contributions.
>
> Tim Anderegg wrote:
> Thanks @haosdent, please let me know if you have any questions or need clarification on anything!
>
> Vinod Kone wrote:
> Any further updates on this? @haosdent can you commit this now?
@haosdent @vinodkone This probably at least needs a rebase, but functionally speaking everything should be in working order. I'll be at the hackathon at MesosCon tomorrow, if folks want to work on closing this out!
- Tim
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review174335
-----------------------------------------------------------
On May 5, 2017, 9:23 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated May 5, 2017, 9:23 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
> site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
> site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
> site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
> site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
>
>
> Diff: https://reviews.apache.org/r/52064/diff/5/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by haosdent huang <ha...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/#review174335
-----------------------------------------------------------
Hi, @tim Thanks a lot for your update. I am still reading you patch and have not finished. Could return my comments if it works at my side. Thanks a lot for your contributions.
- haosdent huang
On May 5, 2017, 9:23 p.m., Tim Anderegg wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/52064/
> -----------------------------------------------------------
>
> (Updated May 5, 2017, 9:23 p.m.)
>
>
> Review request for mesos, haosdent huang and Vinod Kone.
>
>
> Bugs: MESOS-3011
> https://issues.apache.org/jira/browse/MESOS-3011
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Support for multiple versions of docs.
>
>
> Diffs
> -----
>
> site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
> site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
> site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
> site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
> site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
> site/source/assets/js/versions.js PRE-CREATION
> site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
>
>
> Diff: https://reviews.apache.org/r/52064/diff/5/
>
>
> Testing
> -------
>
> Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
>
>
> Thanks,
>
> Tim Anderegg
>
>
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/
-----------------------------------------------------------
(Updated May 5, 2017, 9:23 p.m.)
Review request for mesos, haosdent huang and Vinod Kone.
Changes
-------
Removed file that only had whitespace changes.
Bugs: MESOS-3011
https://issues.apache.org/jira/browse/MESOS-3011
Repository: mesos
Description
-------
Support for multiple versions of docs.
Diffs (updated)
-----
site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
site/source/assets/js/versions.js PRE-CREATION
site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
Diff: https://reviews.apache.org/r/52064/diff/5/
Changes: https://reviews.apache.org/r/52064/diff/4-5/
Testing
-------
Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
Thanks,
Tim Anderegg
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/
-----------------------------------------------------------
(Updated May 5, 2017, 9:20 p.m.)
Review request for mesos, haosdent huang and Vinod Kone.
Changes
-------
Got rid of build.sh phantom change for real this time.
Bugs: MESOS-3011
https://issues.apache.org/jira/browse/MESOS-3011
Repository: mesos
Description
-------
Support for multiple versions of docs.
Diffs (updated)
-----
site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
site/source/assets/js/versions.js PRE-CREATION
site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
site/source/layouts/documentation.erb a91f916a5fb7348b2702c272e7a2059bdf628c66
Diff: https://reviews.apache.org/r/52064/diff/4/
Changes: https://reviews.apache.org/r/52064/diff/3-4/
Testing
-------
Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
Thanks,
Tim Anderegg
Re: Review Request 52064: Support for multiple versions of docs.
Posted by Tim Anderegg <ti...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/52064/
-----------------------------------------------------------
(Updated May 5, 2017, 9:16 p.m.)
Review request for mesos, haosdent huang and Vinod Kone.
Changes
-------
OK, I believe I have addressed all issues here, I also simplified the code a bit to use releases.yml as the source of versions to generate docs for, rather than the git tags themselves, and made the "docs:" key optional in that file. It only needs to be present if the given version should not have documentation generated for it, in which case it is set as "docs: false". This also removes the need for the version check within the Rakefile itself. Please let me know if any additional changes are needed.
Bugs: MESOS-3011
https://issues.apache.org/jira/browse/MESOS-3011
Repository: mesos
Description
-------
Support for multiple versions of docs.
Diffs (updated)
-----
site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807
site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf
site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b
site/build.sh 11f15e15621c4d3db1472e88911787b9b3100f97
site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7
site/data/releases.yml 8bdc3ff11a821f5e1be04ac871c05b16403a82ac
site/source/assets/js/versions.js PRE-CREATION
site/source/layouts/basic.erb 3bf1f55d7d8feafd3caaa7902755404f7e45bae6
site/source/layouts/documentation.erb a91f916a5fb7348b2702c272e7a2059bdf628c66
Diff: https://reviews.apache.org/r/52064/diff/3/
Changes: https://reviews.apache.org/r/52064/diff/2-3/
Testing
-------
Testing was done manually to verify that the documentation was built for each version of Mesos that is supported (some older versions do not have compatible documentation).
Thanks,
Tim Anderegg