Re: [ClusterLabs] Pacemaker documentation license clarification

[Ferenc Wagner]

Ken Gaillot  writes:

> Currently, the brand is specified in each book's publican.cfg (which is
> generated by configure, and can be edited by "make www-cli"). It works,
> so realistically it's a low priority to improve it, given everything
> else on the plate.

Well, it's not pretty to say the least, but I don't think I have to
touch that part.

> You're welcome to submit a pull request to change it to use the local
> brand directory.

Done, it's part of https://github.com/ClusterLabs/pacemaker/pull/876.
That pull request contains three independent patches, feel free to
cherry pick only part of it if you find anything objectionable.

> Be sure to consider that each book comes in multiple formats (and
> potentially translations, though they're out of date at this point,
> which is a whole separate discussion worth raising at some point), and
> add anything generated to .gitignore.

I think this minimal change won't cause problems with other format or
translations.  I forgot about gitignoring the xsl symlink though; I can
add that after the initial review.
-- 
Regards,
Feri.

___
Users mailing list: Users@clusterlabs.org
http://clusterlabs.org/mailman/listinfo/users

Project Home: http://www.clusterlabs.org
Getting started: http://www.clusterlabs.org/doc/Cluster_from_Scratch.pdf
Bugs: http://bugs.clusterlabs.org

Re: [ClusterLabs] Pacemaker documentation license clarification

[Ken Gaillot]

On 12/13/2015 06:56 PM, Ferenc Wagner wrote:
> Ken Gaillot  writes:
> 
>> On 12/11/2015 10:07 AM, Ferenc Wagner wrote:
>>
>>> [...] the "Legal Notice"
>>> section of the generated Publican documentation (for example
>>> Pacemaker_Explained/desktop/en-US/index.html) says that the material may
>>> only be distributed under GFDL-1.2+.
>>
>> This is an artifact of how you're building the documentation. Easy to
>> miss given the makefile complexity :)
> 
> Especially that I did not study the doc makefiles at all, just issued
> make.
> 
>> If you look at the generated versions on clusterlabs.org, they have the
>> correct license (CC-BY-SA)
> 
> That's great.
> 
>> However if you do not "make brand" before building the documentation,
>> you will get the publican defaults.
> 
> Wouldn't --with-brand=clusterlabs also be needed?  Anyway, I can't
> really do this because of the sudo step.  But specifying --brand_dir
> helps indeed.  Is there any reason not to use the clusterlabs brand
> automatically all the time, without installation?  It goes like this:

Currently, the brand is specified in each book's publican.cfg (which is
generated by configure, and can be edited by "make www-cli"). It works,
so realistically it's a low priority to improve it, given everything
else on the plate.

You're welcome to submit a pull request to change it to use the local
brand directory. Be sure to consider that each book comes in multiple
formats (and potentially translations, though they're out of date at
this point, which is a whole separate discussion worth raising at some
point), and add anything generated to .gitignore.

> --- a/doc/Makefile.am
> +++ b/doc/Makefile.am
> @@ -73,16 +73,20 @@ EXTRA_DIST= $(docbook:%=%.xml)
>  %.html: %.txt
>   $(AM_V_ASCII)$(ASCIIDOC) --unsafe --backend=xhtml11 $<
>  
> +# publican-clusterlabs/xsl/html-single.xsl imports that of Publican
> +# through this link during the build
> +../xsl:
> + ln -s /usr/share/publican/xsl "$@"
>  
>  CFS_TXT=$(wildcard Clusters_from_Scratch/en-US/*.txt)
>  CFS_XML=$(CFS_TXT:%.txt=%.xml)
>  
>  # We have to hardcode the book name
>  # With '%' the test for 'newness' fails
> -Clusters_from_Scratch.build: $(PNGS) $(wildcard 
> Clusters_from_Scratch/en-US/*.xml) $(CFS_XML)
> +Clusters_from_Scratch.build: $(PNGS) $(wildcard 
> Clusters_from_Scratch/en-US/*.xml) $(CFS_XML) ../xsl
>   $(PCMK_V) @echo Building $(@:%.build=%) because of $?
>   rm -rf $(@:%.build=%)/publish/*
> - $(AM_V_PUB)cd $(@:%.build=%) && RPM_BUILD_DIR="" $(PUBLICAN) build 
> --publish --langs=$(DOCBOOK_LANGS) --formats=$(DOCBOOK_FORMATS) $(PCMK_quiet)
> + $(AM_V_PUB)cd $(@:%.build=%) && RPM_BUILD_DIR="" $(PUBLICAN) build 
> --publish --langs=$(DOCBOOK_LANGS) --formats=$(DOCBOOK_FORMATS) $(PCMK_quiet) 
> --brand_dir=../publican-clusterlabs
>   rm -rf $(@:%.build=%)/tmp
>   touch $@
> 
> [...]
> 


___
Users mailing list: Users@clusterlabs.org
http://clusterlabs.org/mailman/listinfo/users

Project Home: http://www.clusterlabs.org
Getting started: http://www.clusterlabs.org/doc/Cluster_from_Scratch.pdf
Bugs: http://bugs.clusterlabs.org

Re: [ClusterLabs] Pacemaker documentation license clarification

[Ferenc Wagner]

Ken Gaillot  writes:

> On 12/11/2015 10:07 AM, Ferenc Wagner wrote:
> 
>> [...] the "Legal Notice"
>> section of the generated Publican documentation (for example
>> Pacemaker_Explained/desktop/en-US/index.html) says that the material may
>> only be distributed under GFDL-1.2+.
>
> This is an artifact of how you're building the documentation. Easy to
> miss given the makefile complexity :)

Especially that I did not study the doc makefiles at all, just issued
make.

> If you look at the generated versions on clusterlabs.org, they have the
> correct license (CC-BY-SA)

That's great.

> However if you do not "make brand" before building the documentation,
> you will get the publican defaults.

Wouldn't --with-brand=clusterlabs also be needed?  Anyway, I can't
really do this because of the sudo step.  But specifying --brand_dir
helps indeed.  Is there any reason not to use the clusterlabs brand
automatically all the time, without installation?  It goes like this:

--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -73,16 +73,20 @@ EXTRA_DIST  = $(docbook:%=%.xml)
 %.html: %.txt
$(AM_V_ASCII)$(ASCIIDOC) --unsafe --backend=xhtml11 $<
 
+# publican-clusterlabs/xsl/html-single.xsl imports that of Publican
+# through this link during the build
+../xsl:
+   ln -s /usr/share/publican/xsl "$@"
 
 CFS_TXT=$(wildcard Clusters_from_Scratch/en-US/*.txt)
 CFS_XML=$(CFS_TXT:%.txt=%.xml)
 
 # We have to hardcode the book name
 # With '%' the test for 'newness' fails
-Clusters_from_Scratch.build: $(PNGS) $(wildcard 
Clusters_from_Scratch/en-US/*.xml) $(CFS_XML)
+Clusters_from_Scratch.build: $(PNGS) $(wildcard 
Clusters_from_Scratch/en-US/*.xml) $(CFS_XML) ../xsl
$(PCMK_V) @echo Building $(@:%.build=%) because of $?
rm -rf $(@:%.build=%)/publish/*
-   $(AM_V_PUB)cd $(@:%.build=%) && RPM_BUILD_DIR="" $(PUBLICAN) build 
--publish --langs=$(DOCBOOK_LANGS) --formats=$(DOCBOOK_FORMATS) $(PCMK_quiet)
+   $(AM_V_PUB)cd $(@:%.build=%) && RPM_BUILD_DIR="" $(PUBLICAN) build 
--publish --langs=$(DOCBOOK_LANGS) --formats=$(DOCBOOK_FORMATS) $(PCMK_quiet) 
--brand_dir=../publican-clusterlabs
rm -rf $(@:%.build=%)/tmp
touch $@

[...]
-- 
Thanks,
Feri.

___
Users mailing list: Users@clusterlabs.org
http://clusterlabs.org/mailman/listinfo/users

Project Home: http://www.clusterlabs.org
Getting started: http://www.clusterlabs.org/doc/Cluster_from_Scratch.pdf
Bugs: http://bugs.clusterlabs.org

Re: [ClusterLabs] Pacemaker documentation license clarification

[Ken Gaillot]

On 12/11/2015 10:07 AM, Ferenc Wagner wrote:
> Hi,
> 
> We're packaging Pacemaker for Debian and this requires a clear picture
> of all licenses relevant to the package.  The software part is clearly
> under GPL-2+ and LGPL-2+, which is fine.  However, the "Legal Notice"
> section of the generated Publican documentation (for example
> Pacemaker_Explained/desktop/en-US/index.html) says that the material may
> only be distributed under GFDL-1.2+.  Since there are no invariant
> sections, this would be workable (if inconvenient), but I suspect that
> this difference might be unintended, just the implicit Publican default
> surfacing in the lack of explicit configuration.
> 
> Could the authors (preferably the primary author, Andrew Beekhof) please
> give a definitive statement about the intended license of the
> Clusters_from_Scratch, Pacemaker_Explained and Pacemaker_Remote books?

This is an artifact of how you're building the documentation. Easy to
miss given the makefile complexity :)

If you look at the generated versions on clusterlabs.org, they have the
correct license (CC-BY-SA), e.g.:

http://clusterlabs.org/doc/en-US/Pacemaker/1.1-pcs/html/Pacemaker_Explained/index.html

However if you do not "make brand" before building the documentation,
you will get the publican defaults.

___
Users mailing list: Users@clusterlabs.org
http://clusterlabs.org/mailman/listinfo/users

Project Home: http://www.clusterlabs.org
Getting started: http://www.clusterlabs.org/doc/Cluster_from_Scratch.pdf
Bugs: http://bugs.clusterlabs.org