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 Wed, 28 Sep 2016 21:21:37 GMT


> On Sept. 28, 2016, 3:55 a.m., haosdent huang wrote:
> > site/Rakefile, lines 67-71
> > <https://reviews.apache.org/r/52064/diff/1/?file=1503005#file1503005line67>
> >
> >     How about we only continue when tags in `["0.26.0", "0.26.."]`?

This list of versions that don't have documentation in their repos shouldn't ever change.
 If we filtered affirmatively by the versions that do have documentation, it would have to
be updated each time a new version is added.  So the current approach here seems easier to
maintain, but I'm certainly open to suggestion!


> On Sept. 28, 2016, 3:55 a.m., haosdent huang wrote:
> > site/build.sh, line 24
> > <https://reviews.apache.org/r/52064/diff/1/?file=1503006#file1503006line24>
> >
> >     I think we no need to change this file, right?

Not sure why this is showing up in the diff, will attempt to remove it.


> On Sept. 28, 2016, 3:55 a.m., haosdent huang wrote:
> > site/source/layouts/basic.erb, line 79
> > <https://reviews.apache.org/r/52064/diff/1/?file=1503010#file1503010line79>
> >
> >     We need to make sure the style of verson selection here to match the breadcrumb
above.
> >     
> >     ```
> >     <div class="dropdown">
> >     </div>
> >     ```
> >     
> >     Another options are
> >     
> >     * we put it in the left panel. Like what tensorflow document do. https://www.tensorflow.org/versions/r0.10/get_started/index.html
> >     * we list all available version in a separate page. Like what spark document
do. http://spark.apache.org/documentation.html

I originally had the version in the left panel, but it seemed a bit awkwardly placed there,
and it seemed to me putting it in the breadcrumbs was more natural (in Tensorflow's it makes
sense, as the left panel is a navigation menu).  I think it's best to have the version dropdown
accessible on each page rather than a separate page, as that is more convenient for users.
 I'll try cleaning up the style to match and we can see how that looks.


> On Sept. 28, 2016, 3:55 a.m., haosdent huang wrote:
> > site/source/layouts/documentation.erb, lines 15-19
> > <https://reviews.apache.org/r/52064/diff/1/?file=1503011#file1503011line15>
> >
> >     Any reason that we add a back button instead of using the back button of browser?

This was because I often ran into the case that, when switching doc versions, I hit the browser's
back button which returned me to the last version I was on instead of the new version.  The
"back" link is there to quickly return to the main documentation page for whatever version
the user is currently viewing, and to discourage the use of the browser back button in this
case.  I could update the text to "Return to Documentation Home" or something along those
lines, or I could just remove it as this is probably an edge case anyways.


- Tim


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


On Sept. 19, 2016, 8:43 p.m., Tim Anderegg wrote:
> 
> -----------------------------------------------------------
> 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
> -------
> 
> 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