mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Joseph Wu" <jos...@mesosphere.io>
Subject Re: Review Request 38570: Change documentation image links to absolute paths.
Date Wed, 14 Oct 2015 16:53:26 GMT


> On Oct. 6, 2015, 2:29 p.m., Ben Mahler wrote:
> > docs/external-containerizer.md, line 92
> > <https://reviews.apache.org/r/38570/diff/3/?file=1091914#file1091914line92>
> >
> >     How will this work when we add multiple versions of documents to the website?
Now this hardcodes "latest" as the version?
> 
> Joseph Wu wrote:
>     I'm not sure.
>     
>     From what I've seen of the website generation code, we currently wipe out older versions
of the docs during generation.  We'd first have to change the site's Rakefile (and probably
the release process) to keep older versions.
>     
>     After that, we'd still have to deal with the problem of relative URLs and trailing
slashes:
>     http://stackoverflow.com/questions/5457885/relative-urls-and-trailing-slashes
>     
>     Perhaps we could change the markdown parser to replace image links with a versioned
absolute path.  (I'm not sure what that would entail.)
>     
>     OR
>     
>     We could change all the image links to relative links (i.e. `images/ec_launch_seqdiag.png`)
and remove trailing slashes from all documentation links.  (Maybe add redirects from trailing
slash pages to non-trailing slash pages.)
>     
>     
>     What do you think?
> 
> Niklas Nielsen wrote:
>     BenM: ping ^^
> 
> Ben Mahler wrote:
>     Removing the trailing slashes on documentation links sounds good to me. Also, why
did you remove raw=true, was it a no-op, or?
> 
> Joseph Wu wrote:
>     I'll sync with Dave L. or Jake F. about the trailing slashes.
>     
>     The `raw=true` isn't necessary anymore (I believe).  In the past, I think it was
necessary for images to show up on the Github previews, but now images show with or without
the `raw=true`.
>     (For example, the newer docs with images do not have `raw=true`, but they show up
on the previews).
> 
> Niklas Nielsen wrote:
>     @joseph; any update?

I'm going to discard this while we (Dave + Jake + I) figure out the changes to the website.
Most likely, we'll want to keep the existing relative paths.


- Joseph


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


On Oct. 6, 2015, 9:45 a.m., Joseph Wu wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/38570/
> -----------------------------------------------------------
> 
> (Updated Oct. 6, 2015, 9:45 a.m.)
> 
> 
> Review request for mesos, Adam B, Dave Lester, Artem Harutyunyan, Kapil Arya, and Vinod
Kone.
> 
> 
> Bugs: MESOS-3183
>     https://issues.apache.org/jira/browse/MESOS-3183
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> Also removes extraneous `?raw=true` from the links.
> 
> 
> Diffs
> -----
> 
>   docs/external-containerizer.md 96932189b74dce1ae28e0bd73d5543d1afaffb0b 
>   docs/fetcher-cache-internals.md e8a68d1230420d1afca61f92c1ab6be12a70dbf2 
>   docs/maintenance.md a5831ffa092a9ea6decbe2e640bae637c759a308 
>   docs/networking-for-mesos-managed-containers.md 33568a8233523ff3805f962371c94346e608208b

>   docs/oversubscription.md 5a31b1ff7f003307817732a71f3b0a7c7d60cd24 
> 
> Diff: https://reviews.apache.org/r/38570/diff/
> 
> 
> Testing
> -------
> 
> Patched `Rakefile` to include images in the website (See JIRA for the patch).
> Then rendered with: https://github.com/mesosphere/mesos-website-container
> 
> Confirmed that images show up on the modified docs.
> 
> 
> Thanks,
> 
> Joseph Wu
> 
>


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