You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@activemq.apache.org by Justin Bertram <jb...@apache.org> on 2023/02/06 17:57:35 UTC
[DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Currently as part of the release process for Artemis we build docs in these
formats:
- HTML
- PDF
- EPUB
- MOBI
I think we should only build docs in HTML and stop building them in PDF,
EPUB, & MOBI. Building the extra formats adds a surprising overhead to the
release process, and I don't think they are useful enough to warrant the
effort.
Thoughts?
Justin
P.S. This started out on the dev list, but I moved it to the users list to
get a feel for what users think about these docs.
Re: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by Simon Lundström <si...@su.se.INVALID>.
When learning a new system or keeping docs as a reference I often use
ebooks (epub, mobi) esp. for refreshers on vacations or such when I
don't wanna sit by a computer for a long time.
But as long as you have a "single page HTML" (e.g. like
<https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/>)
it's not a problem to convert it to any other format IME.
BR,
- Simon
On Mon, 2023-02-06 at 18:57:35 +0100, Justin Bertram wrote:
> Currently as part of the release process for Artemis we build docs in these
> formats:
> - HTML
> - PDF
> - EPUB
> - MOBI
>
> I think we should only build docs in HTML and stop building them in PDF,
> EPUB, & MOBI. Building the extra formats adds a surprising overhead to the
> release process, and I don't think they are useful enough to warrant the
> effort.
>
> Thoughts?
>
>
> Justin
>
> P.S. This started out on the dev list, but I moved it to the users list to
> get a feel for what users think about these docs.
Re: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by Clebert Suconic <cl...@gmail.com>.
well...just IMO. if we have to provide an offline version, I would
stick with PDF.
On Tue, Feb 7, 2023 at 11:42 AM Justin Bertram <jb...@apache.org> wrote:
>
> If we can find a way to create a single HTML doc I think that would
> suffice. I've been looking through the honkit docs, but I haven't found
> that option so far.
>
>
> Justin
>
> On Tue, Feb 7, 2023 at 7:40 AM Clebert Suconic <cl...@gmail.com>
> wrote:
>
> > Ok. I guess that’s enough to keep it then.
> >
> > On Tue, Feb 7, 2023 at 7:03 AM Dondorp, Erwin
> > <er...@cgi.com.invalid>
> > wrote:
> >
> > > > Thoughts?
> > > I keep all my system documentation also on an e-reader.
> > > Any compatible single-file edition of the documentation can be used
> > there.
> > > But I use it rarely and would not mind doing my own conversion.
> > > Would be nice when documentation for the conversion-procedures is still
> > > available.
> > >
> > > e.
> > >
> > > -----Original Message-----
> > > From: Justin Bertram <jb...@apache.org>
> > > Sent: maandag 6 februari 2023 18:58
> > > To: users@activemq.apache.org
> > > Subject: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
> > >
> > >
> > > EXTERNAL SENDER: Do not click any links or open any attachments unless
> > > you trust the sender and know the content is safe.
> > > EXPÉDITEUR EXTERNE: Ne cliquez sur aucun lien et n’ouvrez aucune pièce
> > > jointe à moins qu’ils ne proviennent d’un expéditeur fiable, ou que vous
> > > ayez l'assurance que le contenu provient d'une source sûre.
> > >
> > > Currently as part of the release process for Artemis we build docs in
> > these
> > > formats:
> > > - HTML
> > > - PDF
> > > - EPUB
> > > - MOBI
> > >
> > > I think we should only build docs in HTML and stop building them in PDF,
> > > EPUB, & MOBI. Building the extra formats adds a surprising overhead to
> > the
> > > release process, and I don't think they are useful enough to warrant the
> > > effort.
> > >
> > > Thoughts?
> > >
> > >
> > > Justin
> > >
> > > P.S. This started out on the dev list, but I moved it to the users list
> > to
> > > get a feel for what users think about these docs.
> > >
> > --
> > Clebert Suconic
> >
--
Clebert Suconic
Re: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by Justin Bertram <jb...@apache.org>.
If we can find a way to create a single HTML doc I think that would
suffice. I've been looking through the honkit docs, but I haven't found
that option so far.
Justin
On Tue, Feb 7, 2023 at 7:40 AM Clebert Suconic <cl...@gmail.com>
wrote:
> Ok. I guess that’s enough to keep it then.
>
> On Tue, Feb 7, 2023 at 7:03 AM Dondorp, Erwin
> <er...@cgi.com.invalid>
> wrote:
>
> > > Thoughts?
> > I keep all my system documentation also on an e-reader.
> > Any compatible single-file edition of the documentation can be used
> there.
> > But I use it rarely and would not mind doing my own conversion.
> > Would be nice when documentation for the conversion-procedures is still
> > available.
> >
> > e.
> >
> > -----Original Message-----
> > From: Justin Bertram <jb...@apache.org>
> > Sent: maandag 6 februari 2023 18:58
> > To: users@activemq.apache.org
> > Subject: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
> >
> >
> > EXTERNAL SENDER: Do not click any links or open any attachments unless
> > you trust the sender and know the content is safe.
> > EXPÉDITEUR EXTERNE: Ne cliquez sur aucun lien et n’ouvrez aucune pièce
> > jointe à moins qu’ils ne proviennent d’un expéditeur fiable, ou que vous
> > ayez l'assurance que le contenu provient d'une source sûre.
> >
> > Currently as part of the release process for Artemis we build docs in
> these
> > formats:
> > - HTML
> > - PDF
> > - EPUB
> > - MOBI
> >
> > I think we should only build docs in HTML and stop building them in PDF,
> > EPUB, & MOBI. Building the extra formats adds a surprising overhead to
> the
> > release process, and I don't think they are useful enough to warrant the
> > effort.
> >
> > Thoughts?
> >
> >
> > Justin
> >
> > P.S. This started out on the dev list, but I moved it to the users list
> to
> > get a feel for what users think about these docs.
> >
> --
> Clebert Suconic
>
Re: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by Clebert Suconic <cl...@gmail.com>.
I didn't mean to settle the thread... if anyone still thinks we should
remove them, please speak up!
On Tue, Feb 7, 2023 at 8:39 AM Clebert Suconic
<cl...@gmail.com> wrote:
>
> Ok. I guess that’s enough to keep it then.
>
> On Tue, Feb 7, 2023 at 7:03 AM Dondorp, Erwin <er...@cgi.com.invalid> wrote:
>>
>> > Thoughts?
>> I keep all my system documentation also on an e-reader.
>> Any compatible single-file edition of the documentation can be used there.
>> But I use it rarely and would not mind doing my own conversion.
>> Would be nice when documentation for the conversion-procedures is still available.
>>
>> e.
>>
>> -----Original Message-----
>> From: Justin Bertram <jb...@apache.org>
>> Sent: maandag 6 februari 2023 18:58
>> To: users@activemq.apache.org
>> Subject: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
>>
>>
>> EXTERNAL SENDER: Do not click any links or open any attachments unless you trust the sender and know the content is safe.
>> EXPÉDITEUR EXTERNE: Ne cliquez sur aucun lien et n’ouvrez aucune pièce jointe à moins qu’ils ne proviennent d’un expéditeur fiable, ou que vous ayez l'assurance que le contenu provient d'une source sûre.
>>
>> Currently as part of the release process for Artemis we build docs in these
>> formats:
>> - HTML
>> - PDF
>> - EPUB
>> - MOBI
>>
>> I think we should only build docs in HTML and stop building them in PDF, EPUB, & MOBI. Building the extra formats adds a surprising overhead to the release process, and I don't think they are useful enough to warrant the effort.
>>
>> Thoughts?
>>
>>
>> Justin
>>
>> P.S. This started out on the dev list, but I moved it to the users list to get a feel for what users think about these docs.
>
> --
> Clebert Suconic
--
Clebert Suconic
Re: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by Clebert Suconic <cl...@gmail.com>.
Ok. I guess that’s enough to keep it then.
On Tue, Feb 7, 2023 at 7:03 AM Dondorp, Erwin <er...@cgi.com.invalid>
wrote:
> > Thoughts?
> I keep all my system documentation also on an e-reader.
> Any compatible single-file edition of the documentation can be used there.
> But I use it rarely and would not mind doing my own conversion.
> Would be nice when documentation for the conversion-procedures is still
> available.
>
> e.
>
> -----Original Message-----
> From: Justin Bertram <jb...@apache.org>
> Sent: maandag 6 februari 2023 18:58
> To: users@activemq.apache.org
> Subject: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
>
>
> EXTERNAL SENDER: Do not click any links or open any attachments unless
> you trust the sender and know the content is safe.
> EXPÉDITEUR EXTERNE: Ne cliquez sur aucun lien et n’ouvrez aucune pièce
> jointe à moins qu’ils ne proviennent d’un expéditeur fiable, ou que vous
> ayez l'assurance que le contenu provient d'une source sûre.
>
> Currently as part of the release process for Artemis we build docs in these
> formats:
> - HTML
> - PDF
> - EPUB
> - MOBI
>
> I think we should only build docs in HTML and stop building them in PDF,
> EPUB, & MOBI. Building the extra formats adds a surprising overhead to the
> release process, and I don't think they are useful enough to warrant the
> effort.
>
> Thoughts?
>
>
> Justin
>
> P.S. This started out on the dev list, but I moved it to the users list to
> get a feel for what users think about these docs.
>
--
Clebert Suconic
RE: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by "Dondorp, Erwin" <er...@cgi.com.INVALID>.
> Thoughts?
I keep all my system documentation also on an e-reader.
Any compatible single-file edition of the documentation can be used there.
But I use it rarely and would not mind doing my own conversion.
Would be nice when documentation for the conversion-procedures is still available.
e.
-----Original Message-----
From: Justin Bertram <jb...@apache.org>
Sent: maandag 6 februari 2023 18:58
To: users@activemq.apache.org
Subject: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
EXTERNAL SENDER: Do not click any links or open any attachments unless you trust the sender and know the content is safe.
EXPÉDITEUR EXTERNE: Ne cliquez sur aucun lien et n’ouvrez aucune pièce jointe à moins qu’ils ne proviennent d’un expéditeur fiable, ou que vous ayez l'assurance que le contenu provient d'une source sûre.
Currently as part of the release process for Artemis we build docs in these
formats:
- HTML
- PDF
- EPUB
- MOBI
I think we should only build docs in HTML and stop building them in PDF, EPUB, & MOBI. Building the extra formats adds a surprising overhead to the release process, and I don't think they are useful enough to warrant the effort.
Thoughts?
Justin
P.S. This started out on the dev list, but I moved it to the users list to get a feel for what users think about these docs.
Re: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by Clebert Suconic <cl...@gmail.com>.
Someone could make arguments on keeping the PDF or the other formats as an
offline way to read it or for easier searching.
But the world is so connected now that I think in these days it’s not as
cool as it was when we first did years ago.
Having said that if people were actually using it I would put an effort to
keeping it. But right now it feels a waste of time.
An easy way to answer this would be by checking web site traffic. Does
anyone know how to access that ?
On Mon, Feb 6, 2023 at 7:21 PM Christopher Shannon <
christopher.l.shannon@gmail.com> wrote:
> I would think the HTML pages for Artemis/5.x are really the only versions
> used but I am curious to see if any users here chime in and say otherwise.
> HTML is pretty nice as you can just link to the latest docs and is standard
> for most projects. I don't know of too many other Open source projects that
> distribute docs other than through HTML on the web page or through Github
> and markdown, etc.
>
> On Mon, Feb 6, 2023 at 2:31 PM Clebert Suconic <cl...@gmail.com>
> wrote:
>
> > I wonder if anyone is using those formats?
> >
> >
> >
> > On Mon, Feb 6, 2023 at 12:58 PM Justin Bertram <jb...@apache.org>
> > wrote:
> > >
> > > Currently as part of the release process for Artemis we build docs in
> > these
> > > formats:
> > > - HTML
> > > - PDF
> > > - EPUB
> > > - MOBI
> > >
> > > I think we should only build docs in HTML and stop building them in
> PDF,
> > > EPUB, & MOBI. Building the extra formats adds a surprising overhead to
> > the
> > > release process, and I don't think they are useful enough to warrant
> the
> > > effort.
> > >
> > > Thoughts?
> > >
> > >
> > > Justin
> > >
> > > P.S. This started out on the dev list, but I moved it to the users list
> > to
> > > get a feel for what users think about these docs.
> >
> >
> >
> > --
> > Clebert Suconic
> >
>
--
Clebert Suconic
Re: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by Christopher Shannon <ch...@gmail.com>.
I would think the HTML pages for Artemis/5.x are really the only versions
used but I am curious to see if any users here chime in and say otherwise.
HTML is pretty nice as you can just link to the latest docs and is standard
for most projects. I don't know of too many other Open source projects that
distribute docs other than through HTML on the web page or through Github
and markdown, etc.
On Mon, Feb 6, 2023 at 2:31 PM Clebert Suconic <cl...@gmail.com>
wrote:
> I wonder if anyone is using those formats?
>
>
>
> On Mon, Feb 6, 2023 at 12:58 PM Justin Bertram <jb...@apache.org>
> wrote:
> >
> > Currently as part of the release process for Artemis we build docs in
> these
> > formats:
> > - HTML
> > - PDF
> > - EPUB
> > - MOBI
> >
> > I think we should only build docs in HTML and stop building them in PDF,
> > EPUB, & MOBI. Building the extra formats adds a surprising overhead to
> the
> > release process, and I don't think they are useful enough to warrant the
> > effort.
> >
> > Thoughts?
> >
> >
> > Justin
> >
> > P.S. This started out on the dev list, but I moved it to the users list
> to
> > get a feel for what users think about these docs.
>
>
>
> --
> Clebert Suconic
>
Re: [DISCUSS] discontinue PDF, EPUB, & MOBI docs for Artemis
Posted by Clebert Suconic <cl...@gmail.com>.
I wonder if anyone is using those formats?
On Mon, Feb 6, 2023 at 12:58 PM Justin Bertram <jb...@apache.org> wrote:
>
> Currently as part of the release process for Artemis we build docs in these
> formats:
> - HTML
> - PDF
> - EPUB
> - MOBI
>
> I think we should only build docs in HTML and stop building them in PDF,
> EPUB, & MOBI. Building the extra formats adds a surprising overhead to the
> release process, and I don't think they are useful enough to warrant the
> effort.
>
> Thoughts?
>
>
> Justin
>
> P.S. This started out on the dev list, but I moved it to the users list to
> get a feel for what users think about these docs.
--
Clebert Suconic