You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pdfbox.apache.org by Andreas Lehmkuehler <an...@lehmi.de> on 2020/05/23 10:02:40 UTC
Automatic website generation
Hi,
infra implemented some new features for github repos including some automatic
website building [1]. Should we use that for convenience?
WDYT?
Andreas
[1]
https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: dev-help@pdfbox.apache.org
Re: Automatic website generation
Posted by Maruan Sahyoun <sa...@fileaffairs.de>.
can look into that - I also thought about following the model Apache Camel has.
BR
Maruan
> Am 23.05.2020 um 12:03 schrieb Andreas Lehmkuehler <an...@lehmi.de>:
>
> Hi,
>
> infra implemented some new features for github repos including some automatic website building [1]. Should we use that for convenience?
>
> WDYT?
>
> Andreas
>
> [1] https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: dev-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: dev-help@pdfbox.apache.org
Re: Automatic website generation
Posted by Maruan Sahyoun <sa...@fileaffairs.de>.
>
> > Am 25.05.20 um 08:27 schrieb Maruan Sahyoun:
> > > OK - I've reviewed the docs and also look at some projects using automated website building (there aren't many yet).
> > Thanks for looking into this. It's not used that often yet as it is a quite new
> > feature.
> >
> > > The best example I've found is that from Apache Struts as this not only builds the website (including staging for PR based
> > > changes) but also includes the JavaDocs when a new release was done. Unfortunately this is setup in a way that the JavaDoc
> > > source ends up in the master branch. Currently we have older version of the JavaDoc available on our site too which imho would
> > > clutter the master branch.
> > >
> > > Please take a look at https://struts.apache.org/updating-website.html and let me know what you think.
> > >
> > > Which tasks of our current web site buidling would you like to see simplified? Maybe we can start from there.
> > I'd like to use the automatic website build including the staging area, so that
> > it's easy the apply changes without installing the jekyll locally.
>
> Would you see a similar approach as done by Struts
>
> /quote
> If you are a contributor, and the change is small you can push it directly to the master branch. In any other case please open a
> Pull Request. The Pull Request will be automatically build and deployed to the staging site.
>
> You can then review your changes before applying them to the master branch.
> /quote
>
> or a different workflow e.g. by switching to a staging branch - commit, automated build, review - and if valid apply the changes
> to master. Please note that there will be some time between committing and being able to review using the staging area so for
> many changes doing them locally with Jekylls hot building feature might give you a quicker turnaround.
>
> Another option would be to change from Jekyll to a maven based build - either using a plugin or by downloading the proper
> tooling. So one doesn't need to have a Jekyll install. As an example this is used by Apache Camel
> https://github.com/apache/camel-website/blob/master/pom.xml.
I've created https://issues.apache.org/jira/browse/PDFBOX-4848 so let's move the input/discussion there.
>
> BR
> Maruan
>
> > Andreas
> > > BR
> > > Maruan
> > >
> > > > Hi,
> > > >
> > > > infra implemented some new features for github repos including some automatic
> > > > website building [1]. Should we use that for convenience?
> > > >
> > > > WDYT?
> > > >
> > > > Andreas
> > > >
> > > > [1]
> > > > https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories
> > > >
> > > > ---------------------------------------------------------------------
> > > > To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> > > > For additional commands, e-mail: dev-help@pdfbox.apache.org
> > > >
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> > > For additional commands, e-mail: dev-help@pdfbox.apache.org
> > >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> > For additional commands, e-mail: dev-help@pdfbox.apache.org
> >
--
Maruan Sahyoun
FileAffairs GmbH
Josef-Schappe-Straße 21
40882 Ratingen
Tel: +49 (2102) 89497 88
Fax: +49 (2102) 89497 91
sahyoun@fileaffairs.de
www.fileaffairs.de
Geschäftsführer: Maruan Sahyoun
Handelsregister: AG Düsseldorf, HRB 53837
UST.-ID: DE248275827
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: dev-help@pdfbox.apache.org
Re: Automatic website generation
Posted by Maruan Sahyoun <sa...@fileaffairs.de>.
> Am 25.05.20 um 08:27 schrieb Maruan Sahyoun:
> > OK - I've reviewed the docs and also look at some projects using automated website building (there aren't many yet).
> Thanks for looking into this. It's not used that often yet as it is a quite new
> feature.
>
> > The best example I've found is that from Apache Struts as this not only builds the website (including staging for PR based
> > changes) but also includes the JavaDocs when a new release was done. Unfortunately this is setup in a way that the JavaDoc
> > source ends up in the master branch. Currently we have older version of the JavaDoc available on our site too which imho would
> > clutter the master branch.
> >
> > Please take a look at https://struts.apache.org/updating-website.html and let me know what you think.
> >
> > Which tasks of our current web site buidling would you like to see simplified? Maybe we can start from there.
> I'd like to use the automatic website build including the staging area, so that
> it's easy the apply changes without installing the jekyll locally.
Would you see a similar approach as done by Struts
/quote
If you are a contributor, and the change is small you can push it directly to the master branch. In any other case please open a
Pull Request. The Pull Request will be automatically build and deployed to the staging site.
You can then review your changes before applying them to the master branch.
/quote
or a different workflow e.g. by switching to a staging branch - commit, automated build, review - and if valid apply the changes
to master. Please note that there will be some time between committing and being able to review using the staging area so for
many changes doing them locally with Jekylls hot building feature might give you a quicker turnaround.
Another option would be to change from Jekyll to a maven based build - either using a plugin or by downloading the proper
tooling. So one doesn't need to have a Jekyll install. As an example this is used by Apache Camel
https://github.com/apache/camel-website/blob/master/pom.xml.
BR
Maruan
>
> Andreas
> > BR
> > Maruan
> >
> > > Hi,
> > >
> > > infra implemented some new features for github repos including some automatic
> > > website building [1]. Should we use that for convenience?
> > >
> > > WDYT?
> > >
> > > Andreas
> > >
> > > [1]
> > > https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> > > For additional commands, e-mail: dev-help@pdfbox.apache.org
> > >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> > For additional commands, e-mail: dev-help@pdfbox.apache.org
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: dev-help@pdfbox.apache.org
>
--
Maruan Sahyoun
FileAffairs GmbH
Josef-Schappe-Straße 21
40882 Ratingen
Tel: +49 (2102) 89497 88
Fax: +49 (2102) 89497 91
sahyoun@fileaffairs.de
www.fileaffairs.de
Geschäftsführer: Maruan Sahyoun
Handelsregister: AG Düsseldorf, HRB 53837
UST.-ID: DE248275827
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: dev-help@pdfbox.apache.org
Re: Automatic website generation
Posted by Andreas Lehmkuehler <an...@lehmi.de>.
Am 25.05.20 um 08:27 schrieb Maruan Sahyoun:
> OK - I've reviewed the docs and also look at some projects using automated website building (there aren't many yet).
Thanks for looking into this. It's not used that often yet as it is a quite new
feature.
> The best example I've found is that from Apache Struts as this not only builds the website (including staging for PR based
> changes) but also includes the JavaDocs when a new release was done. Unfortunately this is setup in a way that the JavaDoc
> source ends up in the master branch. Currently we have older version of the JavaDoc available on our site too which imho would
> clutter the master branch.
>
> Please take a look at https://struts.apache.org/updating-website.html and let me know what you think.
>
> Which tasks of our current web site buidling would you like to see simplified? Maybe we can start from there.
I'd like to use the automatic website build including the staging area, so that
it's easy the apply changes without installing the jekyll locally.
Andreas
> BR
> Maruan
>
>> Hi,
>>
>> infra implemented some new features for github repos including some automatic
>> website building [1]. Should we use that for convenience?
>>
>> WDYT?
>>
>> Andreas
>>
>> [1]
>> https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
>> For additional commands, e-mail: dev-help@pdfbox.apache.org
>>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: dev-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: dev-help@pdfbox.apache.org
Re: Automatic website generation
Posted by Maruan Sahyoun <sa...@fileaffairs.de>.
OK - I've reviewed the docs and also look at some projects using automated website building (there aren't many yet).
The best example I've found is that from Apache Struts as this not only builds the website (including staging for PR based
changes) but also includes the JavaDocs when a new release was done. Unfortunately this is setup in a way that the JavaDoc
source ends up in the master branch. Currently we have older version of the JavaDoc available on our site too which imho would
clutter the master branch.
Please take a look at https://struts.apache.org/updating-website.html and let me know what you think.
Which tasks of our current web site buidling would you like to see simplified? Maybe we can start from there.
BR
Maruan
> Hi,
>
> infra implemented some new features for github repos including some automatic
> website building [1]. Should we use that for convenience?
>
> WDYT?
>
> Andreas
>
> [1]
> https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: dev-help@pdfbox.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: dev-help@pdfbox.apache.org