You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@karaf.apache.org by Andreas Pieber <an...@gmail.com> on 2011/02/11 08:28:39 UTC
Versions in documentation
I've just seen the following issue in our JIRA. The problem is that there is no
version 1.0.0, but rather ${karaf.version} :). How do we like to handle this
problem? Set ${project.version} vars into the docu and pre-process them or
rather use ${karaf.version} as text-tag making this situation clear?
kind regards,
andreas
On Thu, Feb 10, 2011 at 09:17:57PM +0000, jamie campbell (JIRA) wrote:
> page 56 of the pdf lists a dependency for org.apache.karaf.shell:org.apache.karaf.shell.console:1.0.0. There isn't one.
> ------------------------------------------------------------------------------------------------------------------------
>
> Key: KARAF-456
> URL: https://issues.apache.org/jira/browse/KARAF-456
> Project: Karaf
> Issue Type: Bug
> Components: documentation
> Affects Versions: 2.1.3
> Environment: ubuntu 10.04
> Reporter: jamie campbell
>
>
> in the pdf manual for 2.1.3, dependencies in "extending the console" lists
>
> <dependency>
> <groupId>org.apache.karaf.shell</groupId>
> <artifactId>org.apache.karaf.shell.console</artifactId>
> <version>1.0.0</version>
> </dependency>
>
> But the pom file shown above it in "Manual Creation" has no repositories ilsted, which means it will grab from default, and the default repository only has versions 2.0.0 ; 2.1.0 ; 2.1.1 ; 2.1.2 ; and 2.1.3 . Thus, the dependency is not found.
>
> --
> This message is automatically generated by JIRA.
> -
> For more information on JIRA, see: http://www.atlassian.com/software/jira
>
>
Re: Versions in documentation
Posted by Andreas Pieber <an...@gmail.com>.
ok, as I've expected :) I'll rename KARAF-456 and assign it to 2.x and 3.x
thanks and kind regards,
andreas
On Fri, Feb 11, 2011 at 08:38:46AM +0100, Guillaume Nodet wrote:
> This issue is for the old manual which isn't svn based, only
> confluence, so we can't really post-process it.
> For the new one, we could easily reuse maven to filter the sources
> before the html transformation I think.
>
> On Fri, Feb 11, 2011 at 08:28, Andreas Pieber <an...@gmail.com> wrote:
> > I've just seen the following issue in our JIRA. The problem is that there is no
> > version 1.0.0, but rather ${karaf.version} :). How do we like to handle this
> > problem? Set ${project.version} vars into the docu and pre-process them or
> > rather use ${karaf.version} as text-tag making this situation clear?
> >
> > kind regards,
> > andreas
> >
> > On Thu, Feb 10, 2011 at 09:17:57PM +0000, jamie campbell (JIRA) wrote:
> >> page 56 of the pdf lists a dependency for org.apache.karaf.shell:org.apache.karaf.shell.console:1.0.0. There isn't one.
> >> ------------------------------------------------------------------------------------------------------------------------
> >>
> >> Key: KARAF-456
> >> URL: https://issues.apache.org/jira/browse/KARAF-456
> >> Project: Karaf
> >> Issue Type: Bug
> >> Components: documentation
> >> Affects Versions: 2.1.3
> >> Environment: ubuntu 10.04
> >> Reporter: jamie campbell
> >>
> >>
> >> in the pdf manual for 2.1.3, dependencies in "extending the console" lists
> >>
> >> <dependency>
> >> <groupId>org.apache.karaf.shell</groupId>
> >> <artifactId>org.apache.karaf.shell.console</artifactId>
> >> <version>1.0.0</version>
> >> </dependency>
> >>
> >> But the pom file shown above it in "Manual Creation" has no repositories ilsted, which means it will grab from default, and the default repository only has versions 2.0.0 ; 2.1.0 ; 2.1.1 ; 2.1.2 ; and 2.1.3 . Thus, the dependency is not found.
> >>
> >> --
> >> This message is automatically generated by JIRA.
> >> -
> >> For more information on JIRA, see: http://www.atlassian.com/software/jira
> >>
> >>
> >
>
>
>
> --
> Cheers,
> Guillaume Nodet
> ------------------------
> Blog: http://gnodet.blogspot.com/
> ------------------------
> Open Source SOA
> http://fusesource.com
Re: Versions in documentation
Posted by Guillaume Nodet <gn...@gmail.com>.
This issue is for the old manual which isn't svn based, only
confluence, so we can't really post-process it.
For the new one, we could easily reuse maven to filter the sources
before the html transformation I think.
On Fri, Feb 11, 2011 at 08:28, Andreas Pieber <an...@gmail.com> wrote:
> I've just seen the following issue in our JIRA. The problem is that there is no
> version 1.0.0, but rather ${karaf.version} :). How do we like to handle this
> problem? Set ${project.version} vars into the docu and pre-process them or
> rather use ${karaf.version} as text-tag making this situation clear?
>
> kind regards,
> andreas
>
> On Thu, Feb 10, 2011 at 09:17:57PM +0000, jamie campbell (JIRA) wrote:
>> page 56 of the pdf lists a dependency for org.apache.karaf.shell:org.apache.karaf.shell.console:1.0.0. There isn't one.
>> ------------------------------------------------------------------------------------------------------------------------
>>
>> Key: KARAF-456
>> URL: https://issues.apache.org/jira/browse/KARAF-456
>> Project: Karaf
>> Issue Type: Bug
>> Components: documentation
>> Affects Versions: 2.1.3
>> Environment: ubuntu 10.04
>> Reporter: jamie campbell
>>
>>
>> in the pdf manual for 2.1.3, dependencies in "extending the console" lists
>>
>> <dependency>
>> <groupId>org.apache.karaf.shell</groupId>
>> <artifactId>org.apache.karaf.shell.console</artifactId>
>> <version>1.0.0</version>
>> </dependency>
>>
>> But the pom file shown above it in "Manual Creation" has no repositories ilsted, which means it will grab from default, and the default repository only has versions 2.0.0 ; 2.1.0 ; 2.1.1 ; 2.1.2 ; and 2.1.3 . Thus, the dependency is not found.
>>
>> --
>> This message is automatically generated by JIRA.
>> -
>> For more information on JIRA, see: http://www.atlassian.com/software/jira
>>
>>
>
--
Cheers,
Guillaume Nodet
------------------------
Blog: http://gnodet.blogspot.com/
------------------------
Open Source SOA
http://fusesource.com
Re: Versions in documentation
Posted by Jean-Baptiste Onofré <jb...@nanthrax.net>.
Ah oky :)
It's related to the "old" manual, it's not really possible to fix that :/
For the new one, maven resources filtering should do the job :)
Regards
JB
On 02/11/2011 08:36 AM, Andreas Pieber wrote:
> KARAF-456 mentioned the "problem" that no 1.0.0 version of
> org.apache.karaf.shell.console is available. Well, yes of cause, because this
> version is always alligned with the version of karaf you're using :)
>
> But, this situation occurs through the entire manual. The question now: how do
> we want to handle this? Can we replace variables during the build process of the
> documentation with the current apache-karaf version the documentation is
> building for, OR do we use a variable in the text we explain at the begining:
>
> e.g. please think each occurence of ${karaf.verison} as the karaf version number
> you're currently working with.
>
> kind regards,
> andreas
>
> p.s.: maybe we have already a solution for this I've missed; in this case please
> enlighten me :)
>
> On Fri, Feb 11, 2011 at 08:31:37AM +0100, Jean-Baptiste Onofré wrote:
>> I'm not sure to follow you.
>>
>> What do you mean ?
>>
>> Regards
>> JB
>>
>> On 02/11/2011 08:28 AM, Andreas Pieber wrote:
>>> I've just seen the following issue in our JIRA. The problem is that there is no
>>> version 1.0.0, but rather ${karaf.version} :). How do we like to handle this
>>> problem? Set ${project.version} vars into the docu and pre-process them or
>>> rather use ${karaf.version} as text-tag making this situation clear?
>>>
>>> kind regards,
>>> andreas
>>>
>>> On Thu, Feb 10, 2011 at 09:17:57PM +0000, jamie campbell (JIRA) wrote:
>>>> page 56 of the pdf lists a dependency for org.apache.karaf.shell:org.apache.karaf.shell.console:1.0.0. There isn't one.
>>>> ------------------------------------------------------------------------------------------------------------------------
>>>>
>>>> Key: KARAF-456
>>>> URL: https://issues.apache.org/jira/browse/KARAF-456
>>>> Project: Karaf
>>>> Issue Type: Bug
>>>> Components: documentation
>>>> Affects Versions: 2.1.3
>>>> Environment: ubuntu 10.04
>>>> Reporter: jamie campbell
>>>>
>>>>
>>>> in the pdf manual for 2.1.3, dependencies in "extending the console" lists
>>>>
>>>> <dependency>
>>>> <groupId>org.apache.karaf.shell</groupId>
>>>> <artifactId>org.apache.karaf.shell.console</artifactId>
>>>> <version>1.0.0</version>
>>>> </dependency>
>>>>
>>>> But the pom file shown above it in "Manual Creation" has no repositories ilsted, which means it will grab from default, and the default repository only has versions 2.0.0 ; 2.1.0 ; 2.1.1 ; 2.1.2 ; and 2.1.3 . Thus, the dependency is not found.
>>>>
>>>> --
>>>> This message is automatically generated by JIRA.
>>>> -
>>>> For more information on JIRA, see: http://www.atlassian.com/software/jira
>>>>
>>>>
Re: Versions in documentation
Posted by Andreas Pieber <an...@gmail.com>.
KARAF-456 mentioned the "problem" that no 1.0.0 version of
org.apache.karaf.shell.console is available. Well, yes of cause, because this
version is always alligned with the version of karaf you're using :)
But, this situation occurs through the entire manual. The question now: how do
we want to handle this? Can we replace variables during the build process of the
documentation with the current apache-karaf version the documentation is
building for, OR do we use a variable in the text we explain at the begining:
e.g. please think each occurence of ${karaf.verison} as the karaf version number
you're currently working with.
kind regards,
andreas
p.s.: maybe we have already a solution for this I've missed; in this case please
enlighten me :)
On Fri, Feb 11, 2011 at 08:31:37AM +0100, Jean-Baptiste Onofré wrote:
> I'm not sure to follow you.
>
> What do you mean ?
>
> Regards
> JB
>
> On 02/11/2011 08:28 AM, Andreas Pieber wrote:
> >I've just seen the following issue in our JIRA. The problem is that there is no
> >version 1.0.0, but rather ${karaf.version} :). How do we like to handle this
> >problem? Set ${project.version} vars into the docu and pre-process them or
> >rather use ${karaf.version} as text-tag making this situation clear?
> >
> >kind regards,
> >andreas
> >
> >On Thu, Feb 10, 2011 at 09:17:57PM +0000, jamie campbell (JIRA) wrote:
> >>page 56 of the pdf lists a dependency for org.apache.karaf.shell:org.apache.karaf.shell.console:1.0.0. There isn't one.
> >>------------------------------------------------------------------------------------------------------------------------
> >>
> >> Key: KARAF-456
> >> URL: https://issues.apache.org/jira/browse/KARAF-456
> >> Project: Karaf
> >> Issue Type: Bug
> >> Components: documentation
> >> Affects Versions: 2.1.3
> >> Environment: ubuntu 10.04
> >> Reporter: jamie campbell
> >>
> >>
> >>in the pdf manual for 2.1.3, dependencies in "extending the console" lists
> >>
> >><dependency>
> >><groupId>org.apache.karaf.shell</groupId>
> >><artifactId>org.apache.karaf.shell.console</artifactId>
> >><version>1.0.0</version>
> >></dependency>
> >>
> >>But the pom file shown above it in "Manual Creation" has no repositories ilsted, which means it will grab from default, and the default repository only has versions 2.0.0 ; 2.1.0 ; 2.1.1 ; 2.1.2 ; and 2.1.3 . Thus, the dependency is not found.
> >>
> >>--
> >>This message is automatically generated by JIRA.
> >>-
> >>For more information on JIRA, see: http://www.atlassian.com/software/jira
> >>
> >>
Re: Versions in documentation
Posted by Jean-Baptiste Onofré <jb...@nanthrax.net>.
I'm not sure to follow you.
What do you mean ?
Regards
JB
On 02/11/2011 08:28 AM, Andreas Pieber wrote:
> I've just seen the following issue in our JIRA. The problem is that there is no
> version 1.0.0, but rather ${karaf.version} :). How do we like to handle this
> problem? Set ${project.version} vars into the docu and pre-process them or
> rather use ${karaf.version} as text-tag making this situation clear?
>
> kind regards,
> andreas
>
> On Thu, Feb 10, 2011 at 09:17:57PM +0000, jamie campbell (JIRA) wrote:
>> page 56 of the pdf lists a dependency for org.apache.karaf.shell:org.apache.karaf.shell.console:1.0.0. There isn't one.
>> ------------------------------------------------------------------------------------------------------------------------
>>
>> Key: KARAF-456
>> URL: https://issues.apache.org/jira/browse/KARAF-456
>> Project: Karaf
>> Issue Type: Bug
>> Components: documentation
>> Affects Versions: 2.1.3
>> Environment: ubuntu 10.04
>> Reporter: jamie campbell
>>
>>
>> in the pdf manual for 2.1.3, dependencies in "extending the console" lists
>>
>> <dependency>
>> <groupId>org.apache.karaf.shell</groupId>
>> <artifactId>org.apache.karaf.shell.console</artifactId>
>> <version>1.0.0</version>
>> </dependency>
>>
>> But the pom file shown above it in "Manual Creation" has no repositories ilsted, which means it will grab from default, and the default repository only has versions 2.0.0 ; 2.1.0 ; 2.1.1 ; 2.1.2 ; and 2.1.3 . Thus, the dependency is not found.
>>
>> --
>> This message is automatically generated by JIRA.
>> -
>> For more information on JIRA, see: http://www.atlassian.com/software/jira
>>
>>