You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@accumulo.apache.org by d resnik <dr...@yahoo.com.INVALID> on 2019/04/29 13:32:52 UTC
question about doc updates
I picked up a doc update ticket for audit logs.
https://github.com/apache/accumulo/issues/1136
It looks like 2.0 docs switched from html to markdown files. I am planning to just make updates to the 2.0 .md files.
Just want to make sure I am not missing something.
Thanks,
Don Resnik
Re: question about doc updates
Posted by d resnik <dr...@yahoo.com.INVALID>.
Chris,
Thanks for the info, I submitted a pull reset for the doc updates.
Don
On Monday, April 29, 2019, 10:20:15 PM EDT, Christopher <ct...@apache.org> wrote:
We used to have a manual that we shipped with the tarball. It was a
PDF, generated with LaTeX, and manually converted to HTML. We switched
to AsciiDoc format at some point (because LaTeX is unwieldy) which
supported HTML rendering directly from AsciiDoc. As of 2.0, we put the
manual directly in HTML on the website. But the site itself is
rendered markdown. We've never really had stuff in HTML directly... it
has always been generated in some form or another.
It's fine to update just the website 2.0 docs. One of the reasons for
just putting the docs on the site is that the docs don't necessarily
change significantly from version to version... so it's not
necessarily sensible to a different copy in each release. So, just
updating https://github.com/apache/accumulo-website is fine. We can
always backport to the AsciiDoc version for 1.9 if necessary.
Re: question about doc updates
Posted by Christopher <ct...@apache.org>.
We used to have a manual that we shipped with the tarball. It was a
PDF, generated with LaTeX, and manually converted to HTML. We switched
to AsciiDoc format at some point (because LaTeX is unwieldy) which
supported HTML rendering directly from AsciiDoc. As of 2.0, we put the
manual directly in HTML on the website. But the site itself is
rendered markdown. We've never really had stuff in HTML directly... it
has always been generated in some form or another.
It's fine to update just the website 2.0 docs. One of the reasons for
just putting the docs on the site is that the docs don't necessarily
change significantly from version to version... so it's not
necessarily sensible to a different copy in each release. So, just
updating https://github.com/apache/accumulo-website is fine. We can
always backport to the AsciiDoc version for 1.9 if necessary.