mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Tim Anderegg <timothy.ander...@gmail.com>
Subject Re: Review Request 52064: Support for multiple versions of docs.
Date Mon, 19 Sep 2016 20:43:43 GMT

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

(Updated Sept. 19, 2016, 8:43 p.m.)


Review request for mesos and Vinod Kone.


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


Repository: mesos


Description (updated)
-------

Support for multiple versions of docs.  The approach I took was to use the "git" ruby library
to iterate over each tagged version of Mesos, and generate the documentation.  This uses the
"releases.yml" file to determine which versions should build documentation.  The same is done
for images, since they may change between versions.  A select box was added to the website's
breadcrumbs bar that allows the user to easily switch between documentation versions.  If
a page is reached that doesn't exist in an older version of the documentation, the user is
notified and redirect to the main page for that version.


Diffs
-----

  site/Gemfile 4dcd0a5ad452085e6e3bb152a6547575636cd807 
  site/Gemfile.lock 1393246f06631155bb052669a86e431778e891bf 
  site/Rakefile 01356891c29f9e69fa0f7813cf87e7662eda400b 
  site/build.sh 11f15e15621c4d3db1472e88911787b9b3100f97 
  site/config.rb 9e6738fccc48365e16221188269c1ed40772eca7 
  site/data/releases.yml 1e9bb8555d266658baaf37c4b608eebeb0d14da8 
  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/


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


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message