Re: How does maven-site publishing work?
Hervé, thanks you very very much for this piece of information. Truly valuable. I will discuss this with dev@hc.a.o and let you know. You can join the discussion if your like because you are the expert here. Michael Am 2020-10-22 um 09:21 schrieb Hervé BOUTEMY: Hi Michael, I did the majority of the setup. Seen by infra, our site is using svnpubsub, which is the key for us to publish 100 independant component sites without checkout out the whole aggregated site. (no, gitpubsub is not the best option in our case) We basically use maven-site-plugin to generate html, then commit it to svn (for svnpubsub) with maven-scm-publish-plugin: you can for example publish maven-site with "mvn site-deploy" from your machine, same for every component documentation. Next step is CI integration, to avoid requiring everybody to build maven-site on his machine: infra provides a Jenkins agent for that, see our job [1] The last step for easy use is to provide the "edit" icon in the skin's breadcrumb like added a few years ago [2] More details can be found at [3]. But the setup is not that complex: it's just maven-site, svnpubsub, a normal CI job, and a few ideas to ease navigation Don't hesitate to ping me and tell me where to involve if I can be of any help. Regards, Hervé [1] https://ci-builds.apache.org/job/Maven/job/maven-box/job/maven-site/job/ master/ [2] https://maven.apache.org/ [3] https://maven.apache.org/developers/website/index.html Le lundi 19 octobre 2020, 20:38:38 CEST Michael Osipov a écrit : Folks, we at the HttpComponents TLP we'd like use the same approach as maven-site does. We'd ilke to automatate as much as possible, means: push to repo should trigger a a push to the website. I can see that svnpubub is obviously used in the POM. But the question is, where is the trigger performing the actual step? Who knows best? See discussion [1] Thanks, Michael [1] https://www.mail-archive.com/dev@hc.apache.org/msg27650.html - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org
Re: How does maven-site publishing work?
Am 2020-10-19 um 21:46 schrieb David Jencks: I strongly recommend using the most up to date infra site support which involves a git repo with an asf.yaml file indicating that it’s your website. Push to the git repo and as if by magic your website appears. See https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features Thanks, that's a starter. I’m also strongly in favor of using asciidoc rather than markdown and using Antora, however that’s a separate issue. Completely off topic for this thread, but…. how hard would it be for the maven site plugin to generate asciidoc? I also share this opion because there isn't one Markdown, there are many. Asciidoc is already working if your have the appropriate dependency in your POM. I also would like to avoid any other external tools which will introduce even more complexity. On Oct 19, 2020, at 11:38 AM, Michael Osipov wrote: Folks, we at the HttpComponents TLP we'd like use the same approach as maven-site does. We'd ilke to automatate as much as possible, means: push to repo should trigger a a push to the website. I can see that svnpubub is obviously used in the POM. But the question is, where is the trigger performing the actual step? Who knows best? See discussion [1] Thanks, Michael [1] https://www.mail-archive.com/dev@hc.apache.org/msg27650.html - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org
Re: How does maven-site publishing work?
Hi Michael, I did the majority of the setup. Seen by infra, our site is using svnpubsub, which is the key for us to publish 100 independant component sites without checkout out the whole aggregated site. (no, gitpubsub is not the best option in our case) We basically use maven-site-plugin to generate html, then commit it to svn (for svnpubsub) with maven-scm-publish-plugin: you can for example publish maven-site with "mvn site-deploy" from your machine, same for every component documentation. Next step is CI integration, to avoid requiring everybody to build maven-site on his machine: infra provides a Jenkins agent for that, see our job [1] The last step for easy use is to provide the "edit" icon in the skin's breadcrumb like added a few years ago [2] More details can be found at [3]. But the setup is not that complex: it's just maven-site, svnpubsub, a normal CI job, and a few ideas to ease navigation Don't hesitate to ping me and tell me where to involve if I can be of any help. Regards, Hervé [1] https://ci-builds.apache.org/job/Maven/job/maven-box/job/maven-site/job/ master/ [2] https://maven.apache.org/ [3] https://maven.apache.org/developers/website/index.html Le lundi 19 octobre 2020, 20:38:38 CEST Michael Osipov a écrit : > Folks, > > we at the HttpComponents TLP we'd like use the same approach as > maven-site does. We'd ilke to automatate as much as possible, means: > push to repo should trigger a a push to the website. I can see that > svnpubub is obviously used in the POM. But the question is, where is the > trigger performing the actual step? Who knows best? > > See discussion [1] > > Thanks, > > Michael > > [1] https://www.mail-archive.com/dev@hc.apache.org/msg27650.html > > - > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org > For additional commands, e-mail: dev-h...@maven.apache.org - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org
Re: How does maven-site publishing work?
I strongly recommend using the most up to date infra site support which involves a git repo with an asf.yaml file indicating that it’s your website. Push to the git repo and as if by magic your website appears. See https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features I’m also strongly in favor of using asciidoc rather than markdown and using Antora, however that’s a separate issue. Completely off topic for this thread, but…. how hard would it be for the maven site plugin to generate asciidoc? David Jencks > On Oct 19, 2020, at 11:38 AM, Michael Osipov wrote: > > Folks, > > we at the HttpComponents TLP we'd like use the same approach as maven-site > does. We'd ilke to automatate as much as possible, means: push to repo should > trigger a a push to the website. I can see that svnpubub is obviously used in > the POM. But the question is, where is the trigger performing the actual > step? Who knows best? > > See discussion [1] > > Thanks, > > Michael > > [1] https://www.mail-archive.com/dev@hc.apache.org/msg27650.html > > - > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org > For additional commands, e-mail: dev-h...@maven.apache.org > - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org
