Bug#849703: ITP: ansible-doc -- Documentation for Ansible

classic Classic list List threaded Threaded
14 messages Options
Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Toni Mueller-5
Package: wnpp
Severity: wishlist
Owner: Toni Mueller <[hidden email]>

* Package name    : ansible-doc
  Version         : 2.2.0.0-1
  Upstream Author : RedHat <[hidden email]>
* URL             : http://www.ansible.com/
* License         : GPL-3
  Programming Lang: HTML, JavaScript
  Description     : Documentation for Ansible

Currently, the Ansible package in Debian lacks proper offline
documentation. This package aims to supply the documentation in HTML
form offline, so one should not need to go to the aoupstream website to
read it.

Yours truly frequently suffers under bad network conditions, which make
reading the website infeasible or outright impossible, so I think the
package is useful.

I hope I can collaborate with the maintainer of the ansible package to
maintain this package.
 

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Harlan Lieberman-Berg-4
Toni Mueller <[hidden email]> writes:
> I hope I can collaborate with the maintainer of the ansible package to
> maintain this package.

For the record, the Ansible packaging team stands by to help however we
can.

Thanks, Toni!

Sincerely,
--
Harlan Lieberman-Berg
~hlieberman

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Evgeni Golov-2
In reply to this post by Toni Mueller-5
Hi Toni,

On Fri, Dec 30, 2016 at 12:58:02AM +0100, Toni Mueller wrote:

> Package: wnpp
> Severity: wishlist
> Owner: Toni Mueller <[hidden email]>
>
> * Package name    : ansible-doc
>   Version         : 2.2.0.0-1
>   Upstream Author : RedHat <[hidden email]>
> * URL             : http://www.ansible.com/
> * License         : GPL-3
>   Programming Lang: HTML, JavaScript
>   Description     : Documentation for Ansible
>
> Currently, the Ansible package in Debian lacks proper offline
> documentation. This package aims to supply the documentation in HTML
> form offline, so one should not need to go to the aoupstream website to
> read it.

Which source is this built from?
Do you basically want a mirror of https://docs.ansible.com/ansible/ in
a Debian package?

> Yours truly frequently suffers under bad network conditions, which make
> reading the website infeasible or outright impossible, so I think the
> package is useful.

If it is more than ansible-doc <module>, then it certainly is.
I just wonder whether it is sensible to built it from an own source,
and not from the ansible source itself.

> I hope I can collaborate with the maintainer of the ansible package to
> maintain this package.

CC'ed harlan, not sure if he is not drowning in -devel@ :)

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Toni Mueller-5


Hi Evgeni,

On Fri, Dec 30, 2016 at 10:44:50PM +0100, Evgeni Golov wrote:
> On Fri, Dec 30, 2016 at 12:58:02AM +0100, Toni Mueller wrote:
> > documentation. This package aims to supply the documentation in HTML
> > form offline, so one should not need to go to the aoupstream website to
> > read it.
>
> Which source is this built from?
> Do you basically want a mirror of https://docs.ansible.com/ansible/ in
> a Debian package?

I am building from a git clone of the ansible repository, and, more
specifically, from the tag v2.2.0.0-1.

> > Yours truly frequently suffers under bad network conditions, which make
> > reading the website infeasible or outright impossible, so I think the
> > package is useful.
>
> If it is more than ansible-doc <module>, then it certainly is.

My network conditions vary greatly, but too frequently, they are not
good enough to access anything on the Internet. Working on that, but
still, having a local copy of everything is very desirable from my POV.

> I just wonder whether it is sensible to built it from an own source,
> and not from the ansible source itself.

I found a very easy way to build everything from the ansible source, at
least for this tag.


Cheers,
--Toni++

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

W. Martin Borgert
On 2016-12-31 10:52, Toni Mueller wrote:
> I am building from a git clone of the ansible repository, and, more
> specifically, from the tag v2.2.0.0-1.

Then why not make an additional binary package from the same
source package? This way ansible and its documentation would
not get out of sync.

> My network conditions vary greatly, but too frequently, they are not
> good enough to access anything on the Internet. Working on that, but
> still, having a local copy of everything is very desirable from my POV.

Bad network conditions are not the only reason to want to able
to access manuals locally: No network at all, expensive network,
privacy concerns, custom search over the local copy ("grep").

I found it always an advantage of Debian, that we have -doc
packages for almost everything.

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Harlan Lieberman-Berg-4
"W. Martin Borgert" <[hidden email]> writes:
> Then why not make an additional binary package from the same
> source package? This way ansible and its documentation would
> not get out of sync.

Unfortunately, we don't build ansible off of the git repository, but
rather from the released tarballs.  (The version in upstream's git
requires much more extensive dfsg cleanup, and would until recently have
required the bundling of multiple upstream repositories together.)

It's been a while since we made the decision not to pull from upstream's
git; Toni, I'd be happy to work with you on seeing if it's doable now.

Sincerely,
--
Harlan Lieberman-Berg
~hlieberman

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Evgeni Golov-2
Ohai,

On Sat, Dec 31, 2016 at 01:07:44PM -0500, Harlan Lieberman-Berg wrote:
> "W. Martin Borgert" <[hidden email]> writes:
> > Then why not make an additional binary package from the same
> > source package? This way ansible and its documentation would
> > not get out of sync.
>
> Unfortunately, we don't build ansible off of the git repository, but
> rather from the released tarballs.  (The version in upstream's git
> requires much more extensive dfsg cleanup, and would until recently have
> required the bundling of multiple upstream repositories together.)

Actually, I think building from a release tarball is a good thing. This
ensures that every distro has the same Ansible.

> It's been a while since we made the decision not to pull from upstream's
> git; Toni, I'd be happy to work with you on seeing if it's doable now.

How about we talk to upstream to actually include the docs in the tarballs?
That should not be that hard.

Then we can build and ship them and everyone wins?

Evgeni

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Evgeni Golov-2
On Sun, Jan 01, 2017 at 05:38:50PM +0100, Evgeni Golov wrote:

> Ohai,
>
> On Sat, Dec 31, 2016 at 01:07:44PM -0500, Harlan Lieberman-Berg wrote:
> > "W. Martin Borgert" <[hidden email]> writes:
> > > Then why not make an additional binary package from the same
> > > source package? This way ansible and its documentation would
> > > not get out of sync.
> >
> > Unfortunately, we don't build ansible off of the git repository, but
> > rather from the released tarballs.  (The version in upstream's git
> > requires much more extensive dfsg cleanup, and would until recently have
> > required the bundling of multiple upstream repositories together.)
>
> Actually, I think building from a release tarball is a good thing. This
> ensures that every distro has the same Ansible.
>
> > It's been a while since we made the decision not to pull from upstream's
> > git; Toni, I'd be happy to work with you on seeing if it's doable now.
>
> How about we talk to upstream to actually include the docs in the tarballs?
> That should not be that hard.
>
> Then we can build and ship them and everyone wins?

Let's continue here:
https://github.com/ansible/ansible/issues/19769

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Toni Mueller-5
In reply to this post by Harlan Lieberman-Berg-4


Hi!

A happy new year, everyone!

On Sat, Dec 31, 2016 at 01:07:44PM -0500, Harlan Lieberman-Berg wrote:
> Unfortunately, we don't build ansible off of the git repository, but
> rather from the released tarballs.

I found them only on PyPI. Did you find them elsewhere?

> It's been a while since we made the decision not to pull from upstream's
> git; Toni, I'd be happy to work with you on seeing if it's doable now.

Let's get the -doc package into stretch first if it's not too late
already.


Cheers,
--Toni++

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Harlan Lieberman-Berg-4
Toni Mueller <[hidden email]> writes:
> I found them only on PyPI. Did you find them elsewhere?

We get them from releases.ansible.com.  Are the docs in the tarballs in
PyPi?

--
Harlan Lieberman-Berg
~hlieberman

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Evgeni Golov-2
In reply to this post by Toni Mueller-5
Hey,

On Wed, Jan 04, 2017 at 01:04:12AM +0100, Toni Mueller wrote:
> On Sat, Dec 31, 2016 at 01:07:44PM -0500, Harlan Lieberman-Berg wrote:
> > Unfortunately, we don't build ansible off of the git repository, but
> > rather from the released tarballs.
>
> I found them only on PyPI. Did you find them elsewhere?

http://releases.ansible.com/ansible/

> > It's been a while since we made the decision not to pull from upstream's
> > git; Toni, I'd be happy to work with you on seeing if it's doable now.
>
> Let's get the -doc package into stretch first if it's not too late
> already.

I fear that is too late :(
It would have to be in stretch (not sid) tomorrow, which is not possible
given a 10day migration period.

Regards
Evgeni

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Toni Mueller-5
In reply to this post by Harlan Lieberman-Berg-4
On Tue, Jan 03, 2017 at 09:14:59PM -0500, Harlan Lieberman-Berg wrote:
> Toni Mueller <[hidden email]> writes:
> > I found them only on PyPI. Did you find them elsewhere?
>
> We get them from releases.ansible.com.  Are the docs in the tarballs in
> PyPi?

Nope, there are only man pages.


Cheers,
--Toni++

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Toni Mueller-5
In reply to this post by Harlan Lieberman-Berg-4

Hi Harlan,

On Sat, Dec 31, 2016 at 01:07:44PM -0500, Harlan Lieberman-Berg wrote:
> It's been a while since we made the decision not to pull from upstream's
> git; Toni, I'd be happy to work with you on seeing if it's doable now.

I think I have a suitable package now, being as cheap as possible, but
it's off your git tree, which I took from

  https://anonscm.debian.org/git/collab-maint/ansible.git
 
I had to change some things, though:

 * retrofit the docsite directory
 * adjust debian/control
 * adjust debian/rules

It's for 2.4.1, and it's lintian clean. My changes build both packages.

How can I best upload this stuff without disrupting yours, and without
creating an entirely new repository?

TIA!


Cheers,
--Toni++

Reply | Threaded
Open this post in threaded view
|

Bug#849703: ITP: ansible-doc -- Documentation for Ansible

Evgeni Golov-2
Hi Toni,

On Wed, Nov 15, 2017 at 06:10:45PM +0800, Toni Mueller wrote:

> On Sat, Dec 31, 2016 at 01:07:44PM -0500, Harlan Lieberman-Berg wrote:
> > It's been a while since we made the decision not to pull from upstream's
> > git; Toni, I'd be happy to work with you on seeing if it's doable now.
>
> I think I have a suitable package now, being as cheap as possible, but
> it's off your git tree, which I took from
>
>   https://anonscm.debian.org/git/collab-maint/ansible.git
>  
> I had to change some things, though:
>
>  * retrofit the docsite directory
>  * adjust debian/control
>  * adjust debian/rules
>
> It's for 2.4.1, and it's lintian clean. My changes build both packages.
>
> How can I best upload this stuff without disrupting yours, and without
> creating an entirely new repository?

Just push your stuff to a branch "toni/doc" or something, and we'll have a look?
You should have push access to collab-maint anyways.

Evgeni