accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Christopher <ctubb...@apache.org>
Subject Re: [DISCUSS] Move user manual source to Accumulo website repo
Date Tue, 25 Apr 2017 20:17:12 GMT
I added another con to the JIRA:

* Harder to provide offline docs (especially as a single file).

I don't know if that matters to anybody (it doesn't to me or the users I
support). It's also possible to clone the `accumulo-website` repo as a
workaround.

On Tue, Apr 25, 2017 at 3:57 PM Josh Elser <josh.elser@gmail.com> wrote:

> copy-pasting from the JIRA issue because I was looking for these in-thread:
>
> <snip>
> Pros
> * Easier to link between pages and external Javadocs
> * Documentation can be broken up into distinct pages which is easier to
> read and better for SEO.
> * Easier to update documentation after releases. Only one commit necessary.
> * Jekyll+Markdown is more customizable and becoming more of a standard
> than asciidoc.
> * Documentation changes that affect multiple releases can be made with
> one PR.
>
> Cons
> * Documentation will no longer ship with tarball
> * Developers cannot update code and docs in one PR
> </snip>
>
> Mike Walch wrote:
> > For 2.0, I would like convert user manual source from asciidoc to
> markdown
> > and move it to the accumulo-website to be served using Jekyll.  While I
> > will put these changes up for review, I would like to see if anyone has
> any
> > major objections or suggestions before I start work on it (I do not want
> to
> > spend a lot of time doing a tedious conversion if someone is going to -1
> > the change). Below is the issue if you want to comment in JIRA:
> >
> > https://issues.apache.org/jira/browse/ACCUMULO-4630
> >
>

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