Hi all,
In plc4x we have a groovy script calculating all sorts of different versions
based on the current version. These are automatically used in the site. So most
of the places we don't need to update these versions.
Perhaps that's something for you too?
Chris
________________________________
Von: Dominik Riemer <rie...@fzi.de>
Gesendet: Freitag, 13. Dezember 2019 11:43:50
An: dev@streampipes.apache.org <dev@streampipes.apache.org>
Betreff: Re: [DISCUSS] Version number in documentation
Hi,
from my point of view, it should be as simple as possible for users. This means
that we don‘t expect them to know how to replace variables.
So IMO, we should create a wiki page with a pre-release checklist and an item
that remembers us to update the version numbers in the documentation (and
where).
I haven‘t checked in a while Docusaurus support for environment variables,
maybe there is also another option by now that allows us to automate this
process.
Dominik
> Am 13.12.2019 um 11:27 schrieb Philipp Zehnder <zehn...@apache.org>:
>
> Hi all,
>
> we received a pull request for our documentation with some minor changes. One
> of them was an update of the version number of StreamPipes in the maven
> archetype commands.
>
> Now the question came up whether we should use the current version number in
> the command (or the documentation in general) [Example 1] or a template
> [Example 2]
>
> The advantages of Example 1 are that developers can just copy and past it,
> which makes it easier to use. But since the version numbers have to be
> updated on each release it is harder to maintain.
> Also when we forget to update it developers might get strange errors since
> their backend version and processor version might not be compatible.
> Example 2 is easier to maintain, but developers have to change it every time
> they use it.
>
> What do you think? What do you prefer or are there any alternative ideas?
>
> Example 1:
> mvn archetype:generate \
> -DarchetypeGroupId=org.streampipes \
> -DarchetypeArtifactId=streampipes-archetype-pe-processors-jvm \
> -DarchetypeVersion=0.65.0
>
> Example 2:
> mvn archetype:generate \
> -DarchetypeGroupId=org.streampipes \
> -DarchetypeArtifactId=streampipes-archetype-pe-processors-jvm \
> -DarchetypeVersion={sp.version}
>
> Cheers,
> Philipp
