Re: feedback on release schedule rendered docs

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, Oct 9, 2018 at 10:44 PM Noah Watkins <nwatkins@xxxxxxxxxx> wrote:
>
> As part of the documentation enhancement effort we've encountered a
> need to access to ceph release information in a machine readable
> format.
>
> As a proof of concept we've converted the humongous release table
> (http://docs.ceph.com/docs/master/releases/schedule/) into a yaml file
> with a schema that is optimized for adding new releases, and use this
> a data source to render the html table and produce a json file used by
> the documentation project.
>
> There is still a lot that needs to be fixed up, but now would be a
> good time to comment on the schema, the general direction of the
> rendered HTML (e.g. we've rotated the table so it's tall instead of
> wide), and any additional information that might be beneficial to
> track.
>
> Release source:
>    https://github.com/ceph/ceph/blob/3a2a93351954585adbb912994d9d7ad306f35189/doc/releases/releases.yml
>
> Sample rendering:
>    http://docs.ceph.com/ceph-prs/24452/releases/schedule/

Neat!  I really like how the current releases are more prominent in
their own table now.  Maybe that table should be restricted to
releases that aren't already EOL (i.e. leave kraken out)?

I'm finding the timeline table hard to scan (alternating 2s and 3s in
the version column), maybe add a color blob column and arbitrarily
assign each release a colour?  Might just be me though, everyone's
visual processing is different.

John



[Index of Archives]     [CEPH Users]     [Ceph Large]     [Information on CEPH]     [Linux BTRFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux