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 Tue, 13 Feb 2018 15:44:18 GMT

-----------------------------------------------------------
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.

![Dropdown list of versions.](https://i.imgur.com/xvukEBGl.png)
Screenshot of the dropdown list of versions.

![404 Message](https://i.imgur.com/kqXNsxvl.png)
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


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