You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@logging.apache.org by Volkan Yazıcı <vo...@gmail.com> on 2020/09/01 13:54:25 UTC
GitHub Pages (Was: Your project website)
Ralph, regarding your "after a discussion on Slack with infra I determined
that using GitHub pages isn’t what we want to do." remark... I am curious
to know about the details. Can we use GitHub pages in some way? Or why one
should prefer one over another?
On Mon, Aug 31, 2020 at 7:21 AM Ralph Goers <ra...@dslextreme.com>
wrote:
> Another follow-up. After a discussion on Slack with infra I determined
> that using GitHub pages isn’t what we want to do. I then modified the site
> to work with the normal “pub/sub” that infra supports via the .asf.yaml
> files. The documentation for that says it supports having sub-projects be
> hosted in separate repos so I followed those instructions. Unfortunately,
> those sites are not deploying. I have opened
> https://issues.apache.org/jira/browse/INFRA-20792 <
> https://issues.apache.org/jira/browse/INFRA-20792> to try to get this
> addressed but have not gotten a response to this yet nor to the questions I
> asked on Slack. Not surprising since it was a Sunday afternoon.
>
> I have not documented the process yet since I am not sure I did everything
> correctly.
>
> FWIW, I plan to hold off starting the log4j release process until this is
> resolve since trying to commit a new Log4j web site using svn has been
> taking at least 30 minutes. My experience in committing the preview site to
> my personal GitHub site has shown that it is significantly faster.
>
> Ralph
>
> > On Aug 30, 2020, at 11:29 AM, Ralph Goers <ra...@dslextreme.com>
> wrote:
> >
> > I have created the logging site in git at
> https://github.com/apache/logging-site <
> https://github.com/apache/logging-site>. I used jbake to generate the
> CMS portion of the site. It is pretty easy. All you have to do is
> >
> > cd sources
> > Make the required changes
> > mvn install
> >
> > You will then have a viewable site in the /docs directory and can view
> it by opening docs/index.html in the browser.
> >
> > I created a .asf.yaml file with the intention of having a preview site
> on the asf-staging branch and the live site at master. However, the
> instructions for the staging site seem to imply using pypubsub where I am
> attempting to use GitHub Pages for the live site. These seem to conflict as
> GitHub pages wants the site in the /docs directory while pypubsub seems to
> imply it needs to be in the root directory.
> >
> > I am able to get a site up at https://apache.github.io/logging-site <
> https://apache.github.io/logging-site> but it is not being reflected at
> https://logging.apache.org <https://logging.apache.org/>.
> >
> > At this point without clearer instructions from infra I am not sure
> where to go to make the site live.
> >
> > I have started a confluence page to document managing the site but it
> seems much easier than using the CMS.
> >
> > Ralph
> >
> >
> >
> >> On Aug 5, 2020, at 5:30 AM, Andrew Wetmore <an...@apache.org> wrote:
> >>
> >> Hi:
> >>
> >> I am part of the Infrastructure team, and am writing to ask whether your
> >> project is still using the Apache CMS for your project website. As you
> >> know, the CMS is reaching end-of-life, and we need projects to move
> their
> >> websites onto a different option within the next few weeks.
> >>
> >> There are several alternatives available, including those listed on this
> >> page [1] on managing project websites. Infra is assembling a Wiki page
> [2]
> >> on migrating a website from the CMS, and is looking forward to helping
> >> projects with this transition.
> >>
> >> Please let me know whether your site is still on the Apache CMS and, if
> so,
> >> who will be the project point-of-contact with Infra for the migration.
> >>
> >> Thank you!
> >>
> >>
> >>
> >>
> >> [1] https://infra.apache.org/project-site.html
> >>
> >> [2]
> >>
> https://cwiki.apache.org/confluence/display/INFRA/Migrate+your+project+website+from+the+Apache+CMS
> >>
> >>
> >>
> >> --
> >> Andrew Wetmore
> >> Technical Writer-Editor
> >> Infra
> >> *Apache Software Foundation*
> >> andreww@apache.org
> >>
> >> <
> https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
> >
> >> Virus-free.
> >> www.avast.com
> >> <
> https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
> >
> >> <#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
> >
>
>
Re: GitHub Pages (Was: Your project website)
Posted by Christopher <ct...@apache.org>.
For what it's worth, GitHub Pages is simply a Jekyll-based site. If
you want something convenient like that, I highly recommend doing
something like Apache Accumulo and Apache Fluo did, to take advantage
of the ASF infrastructure, rather than rely on GitHub Pages to
generate the Jekyll.
See the Jekyll configuration at:
https://github.com/apache/fluo-website/blob/main/.asf.yaml
See the publishing instructions at:
https://github.com/apache/fluo-website#publishing
And, the rest of the content of that repo is the Jekyll-based site.
(Accumulo's site is basically the same setup, but depends on Jekyll
gem directly, rather than transitively via the GitHub Pages gem, and
added some custom ruby plugins to make writing links to issues easier
in our docs.)
On Tue, Sep 1, 2020 at 11:58 AM Ralph Goers <ra...@dslextreme.com> wrote:
>
> Apache doesn’t support using GitHub pages for the live site. They do allow it to be used for the staging site, but the details of how they work aren’t the same. To define a GitHub Pages site you have to specify
>
> github:
> ghp_branch: master
> ghp_path: /docs
>
> where the ghp_path has to be either null or “/docs”. The ASF support requires that the site be at the root, “/output”, or “/content”. We do not want to generate our site to a subdirectory so using GitHub Pages would require a different directory layout than the ASF site. Also, the web site would be generated under apache.github.io/ <http://apache.github.io/> while the staging site generated by the ASF is at logging.staged.apache.com <http://logging.staged.apache.com/>. Having an apache.org <http://apache.org/> staging site might be a bit easier to remember than a github.io <http://github.io/> site.
>
> Ralph
>
> > On Sep 1, 2020, at 8:08 AM, Matt Sicker <bo...@gmail.com> wrote:
> >
> > Part of it is because Apache offers an equivalent service for
> > publishing sites to apache.org directly rather than to github.io.
> >
> > On Tue, 1 Sep 2020 at 09:21, Volkan Yazıcı <vo...@gmail.com> wrote:
> >>
> >> Ralph, regarding your "after a discussion on Slack with infra I determined
> >> that using GitHub pages isn’t what we want to do." remark... I am curious
> >> to know about the details. Can we use GitHub pages in some way? Or why one
> >> should prefer one over another?
> >>
> >> On Mon, Aug 31, 2020 at 7:21 AM Ralph Goers <ra...@dslextreme.com>
> >> wrote:
> >>
> >>> Another follow-up. After a discussion on Slack with infra I determined
> >>> that using GitHub pages isn’t what we want to do. I then modified the site
> >>> to work with the normal “pub/sub” that infra supports via the .asf.yaml
> >>> files. The documentation for that says it supports having sub-projects be
> >>> hosted in separate repos so I followed those instructions. Unfortunately,
> >>> those sites are not deploying. I have opened
> >>> https://issues.apache.org/jira/browse/INFRA-20792 <
> >>> https://issues.apache.org/jira/browse/INFRA-20792> to try to get this
> >>> addressed but have not gotten a response to this yet nor to the questions I
> >>> asked on Slack. Not surprising since it was a Sunday afternoon.
> >>>
> >>> I have not documented the process yet since I am not sure I did everything
> >>> correctly.
> >>>
> >>> FWIW, I plan to hold off starting the log4j release process until this is
> >>> resolve since trying to commit a new Log4j web site using svn has been
> >>> taking at least 30 minutes. My experience in committing the preview site to
> >>> my personal GitHub site has shown that it is significantly faster.
> >>>
> >>> Ralph
> >>>
> >>>> On Aug 30, 2020, at 11:29 AM, Ralph Goers <ra...@dslextreme.com>
> >>> wrote:
> >>>>
> >>>> I have created the logging site in git at
> >>> https://github.com/apache/logging-site <
> >>> https://github.com/apache/logging-site>. I used jbake to generate the
> >>> CMS portion of the site. It is pretty easy. All you have to do is
> >>>>
> >>>> cd sources
> >>>> Make the required changes
> >>>> mvn install
> >>>>
> >>>> You will then have a viewable site in the /docs directory and can view
> >>> it by opening docs/index.html in the browser.
> >>>>
> >>>> I created a .asf.yaml file with the intention of having a preview site
> >>> on the asf-staging branch and the live site at master. However, the
> >>> instructions for the staging site seem to imply using pypubsub where I am
> >>> attempting to use GitHub Pages for the live site. These seem to conflict as
> >>> GitHub pages wants the site in the /docs directory while pypubsub seems to
> >>> imply it needs to be in the root directory.
> >>>>
> >>>> I am able to get a site up at https://apache.github.io/logging-site <
> >>> https://apache.github.io/logging-site> but it is not being reflected at
> >>> https://logging.apache.org <https://logging.apache.org/>.
> >>>>
> >>>> At this point without clearer instructions from infra I am not sure
> >>> where to go to make the site live.
> >>>>
> >>>> I have started a confluence page to document managing the site but it
> >>> seems much easier than using the CMS.
> >>>>
> >>>> Ralph
> >>>>
> >>>>
> >>>>
> >>>>> On Aug 5, 2020, at 5:30 AM, Andrew Wetmore <an...@apache.org> wrote:
> >>>>>
> >>>>> Hi:
> >>>>>
> >>>>> I am part of the Infrastructure team, and am writing to ask whether your
> >>>>> project is still using the Apache CMS for your project website. As you
> >>>>> know, the CMS is reaching end-of-life, and we need projects to move
> >>> their
> >>>>> websites onto a different option within the next few weeks.
> >>>>>
> >>>>> There are several alternatives available, including those listed on this
> >>>>> page [1] on managing project websites. Infra is assembling a Wiki page
> >>> [2]
> >>>>> on migrating a website from the CMS, and is looking forward to helping
> >>>>> projects with this transition.
> >>>>>
> >>>>> Please let me know whether your site is still on the Apache CMS and, if
> >>> so,
> >>>>> who will be the project point-of-contact with Infra for the migration.
> >>>>>
> >>>>> Thank you!
> >>>>>
> >>>>>
> >>>>>
> >>>>>
> >>>>> [1] https://infra.apache.org/project-site.html
> >>>>>
> >>>>> [2]
> >>>>>
> >>> https://cwiki.apache.org/confluence/display/INFRA/Migrate+your+project+website+from+the+Apache+CMS
> >>>>>
> >>>>>
> >>>>>
> >>>>> --
> >>>>> Andrew Wetmore
> >>>>> Technical Writer-Editor
> >>>>> Infra
> >>>>> *Apache Software Foundation*
> >>>>> andreww@apache.org
> >>>>>
> >>>>> <
> >>> https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
> >>>>
> >>>>> Virus-free.
> >>>>> www.avast.com
> >>>>> <
> >>> https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
> >>>>
> >>>>> <#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
> >>>>
> >>>
> >>>
> >
> >
> >
> > --
> > Matt Sicker <bo...@gmail.com>
> >
>
Re: GitHub Pages (Was: Your project website)
Posted by Ralph Goers <ra...@dslextreme.com>.
Apache doesn’t support using GitHub pages for the live site. They do allow it to be used for the staging site, but the details of how they work aren’t the same. To define a GitHub Pages site you have to specify
github:
ghp_branch: master
ghp_path: /docs
where the ghp_path has to be either null or “/docs”. The ASF support requires that the site be at the root, “/output”, or “/content”. We do not want to generate our site to a subdirectory so using GitHub Pages would require a different directory layout than the ASF site. Also, the web site would be generated under apache.github.io/ <http://apache.github.io/> while the staging site generated by the ASF is at logging.staged.apache.com <http://logging.staged.apache.com/>. Having an apache.org <http://apache.org/> staging site might be a bit easier to remember than a github.io <http://github.io/> site.
Ralph
> On Sep 1, 2020, at 8:08 AM, Matt Sicker <bo...@gmail.com> wrote:
>
> Part of it is because Apache offers an equivalent service for
> publishing sites to apache.org directly rather than to github.io.
>
> On Tue, 1 Sep 2020 at 09:21, Volkan Yazıcı <vo...@gmail.com> wrote:
>>
>> Ralph, regarding your "after a discussion on Slack with infra I determined
>> that using GitHub pages isn’t what we want to do." remark... I am curious
>> to know about the details. Can we use GitHub pages in some way? Or why one
>> should prefer one over another?
>>
>> On Mon, Aug 31, 2020 at 7:21 AM Ralph Goers <ra...@dslextreme.com>
>> wrote:
>>
>>> Another follow-up. After a discussion on Slack with infra I determined
>>> that using GitHub pages isn’t what we want to do. I then modified the site
>>> to work with the normal “pub/sub” that infra supports via the .asf.yaml
>>> files. The documentation for that says it supports having sub-projects be
>>> hosted in separate repos so I followed those instructions. Unfortunately,
>>> those sites are not deploying. I have opened
>>> https://issues.apache.org/jira/browse/INFRA-20792 <
>>> https://issues.apache.org/jira/browse/INFRA-20792> to try to get this
>>> addressed but have not gotten a response to this yet nor to the questions I
>>> asked on Slack. Not surprising since it was a Sunday afternoon.
>>>
>>> I have not documented the process yet since I am not sure I did everything
>>> correctly.
>>>
>>> FWIW, I plan to hold off starting the log4j release process until this is
>>> resolve since trying to commit a new Log4j web site using svn has been
>>> taking at least 30 minutes. My experience in committing the preview site to
>>> my personal GitHub site has shown that it is significantly faster.
>>>
>>> Ralph
>>>
>>>> On Aug 30, 2020, at 11:29 AM, Ralph Goers <ra...@dslextreme.com>
>>> wrote:
>>>>
>>>> I have created the logging site in git at
>>> https://github.com/apache/logging-site <
>>> https://github.com/apache/logging-site>. I used jbake to generate the
>>> CMS portion of the site. It is pretty easy. All you have to do is
>>>>
>>>> cd sources
>>>> Make the required changes
>>>> mvn install
>>>>
>>>> You will then have a viewable site in the /docs directory and can view
>>> it by opening docs/index.html in the browser.
>>>>
>>>> I created a .asf.yaml file with the intention of having a preview site
>>> on the asf-staging branch and the live site at master. However, the
>>> instructions for the staging site seem to imply using pypubsub where I am
>>> attempting to use GitHub Pages for the live site. These seem to conflict as
>>> GitHub pages wants the site in the /docs directory while pypubsub seems to
>>> imply it needs to be in the root directory.
>>>>
>>>> I am able to get a site up at https://apache.github.io/logging-site <
>>> https://apache.github.io/logging-site> but it is not being reflected at
>>> https://logging.apache.org <https://logging.apache.org/>.
>>>>
>>>> At this point without clearer instructions from infra I am not sure
>>> where to go to make the site live.
>>>>
>>>> I have started a confluence page to document managing the site but it
>>> seems much easier than using the CMS.
>>>>
>>>> Ralph
>>>>
>>>>
>>>>
>>>>> On Aug 5, 2020, at 5:30 AM, Andrew Wetmore <an...@apache.org> wrote:
>>>>>
>>>>> Hi:
>>>>>
>>>>> I am part of the Infrastructure team, and am writing to ask whether your
>>>>> project is still using the Apache CMS for your project website. As you
>>>>> know, the CMS is reaching end-of-life, and we need projects to move
>>> their
>>>>> websites onto a different option within the next few weeks.
>>>>>
>>>>> There are several alternatives available, including those listed on this
>>>>> page [1] on managing project websites. Infra is assembling a Wiki page
>>> [2]
>>>>> on migrating a website from the CMS, and is looking forward to helping
>>>>> projects with this transition.
>>>>>
>>>>> Please let me know whether your site is still on the Apache CMS and, if
>>> so,
>>>>> who will be the project point-of-contact with Infra for the migration.
>>>>>
>>>>> Thank you!
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> [1] https://infra.apache.org/project-site.html
>>>>>
>>>>> [2]
>>>>>
>>> https://cwiki.apache.org/confluence/display/INFRA/Migrate+your+project+website+from+the+Apache+CMS
>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> Andrew Wetmore
>>>>> Technical Writer-Editor
>>>>> Infra
>>>>> *Apache Software Foundation*
>>>>> andreww@apache.org
>>>>>
>>>>> <
>>> https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
>>>>
>>>>> Virus-free.
>>>>> www.avast.com
>>>>> <
>>> https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
>>>>
>>>>> <#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
>>>>
>>>
>>>
>
>
>
> --
> Matt Sicker <bo...@gmail.com>
>
Re: GitHub Pages (Was: Your project website)
Posted by Matt Sicker <bo...@gmail.com>.
Part of it is because Apache offers an equivalent service for
publishing sites to apache.org directly rather than to github.io.
On Tue, 1 Sep 2020 at 09:21, Volkan Yazıcı <vo...@gmail.com> wrote:
>
> Ralph, regarding your "after a discussion on Slack with infra I determined
> that using GitHub pages isn’t what we want to do." remark... I am curious
> to know about the details. Can we use GitHub pages in some way? Or why one
> should prefer one over another?
>
> On Mon, Aug 31, 2020 at 7:21 AM Ralph Goers <ra...@dslextreme.com>
> wrote:
>
> > Another follow-up. After a discussion on Slack with infra I determined
> > that using GitHub pages isn’t what we want to do. I then modified the site
> > to work with the normal “pub/sub” that infra supports via the .asf.yaml
> > files. The documentation for that says it supports having sub-projects be
> > hosted in separate repos so I followed those instructions. Unfortunately,
> > those sites are not deploying. I have opened
> > https://issues.apache.org/jira/browse/INFRA-20792 <
> > https://issues.apache.org/jira/browse/INFRA-20792> to try to get this
> > addressed but have not gotten a response to this yet nor to the questions I
> > asked on Slack. Not surprising since it was a Sunday afternoon.
> >
> > I have not documented the process yet since I am not sure I did everything
> > correctly.
> >
> > FWIW, I plan to hold off starting the log4j release process until this is
> > resolve since trying to commit a new Log4j web site using svn has been
> > taking at least 30 minutes. My experience in committing the preview site to
> > my personal GitHub site has shown that it is significantly faster.
> >
> > Ralph
> >
> > > On Aug 30, 2020, at 11:29 AM, Ralph Goers <ra...@dslextreme.com>
> > wrote:
> > >
> > > I have created the logging site in git at
> > https://github.com/apache/logging-site <
> > https://github.com/apache/logging-site>. I used jbake to generate the
> > CMS portion of the site. It is pretty easy. All you have to do is
> > >
> > > cd sources
> > > Make the required changes
> > > mvn install
> > >
> > > You will then have a viewable site in the /docs directory and can view
> > it by opening docs/index.html in the browser.
> > >
> > > I created a .asf.yaml file with the intention of having a preview site
> > on the asf-staging branch and the live site at master. However, the
> > instructions for the staging site seem to imply using pypubsub where I am
> > attempting to use GitHub Pages for the live site. These seem to conflict as
> > GitHub pages wants the site in the /docs directory while pypubsub seems to
> > imply it needs to be in the root directory.
> > >
> > > I am able to get a site up at https://apache.github.io/logging-site <
> > https://apache.github.io/logging-site> but it is not being reflected at
> > https://logging.apache.org <https://logging.apache.org/>.
> > >
> > > At this point without clearer instructions from infra I am not sure
> > where to go to make the site live.
> > >
> > > I have started a confluence page to document managing the site but it
> > seems much easier than using the CMS.
> > >
> > > Ralph
> > >
> > >
> > >
> > >> On Aug 5, 2020, at 5:30 AM, Andrew Wetmore <an...@apache.org> wrote:
> > >>
> > >> Hi:
> > >>
> > >> I am part of the Infrastructure team, and am writing to ask whether your
> > >> project is still using the Apache CMS for your project website. As you
> > >> know, the CMS is reaching end-of-life, and we need projects to move
> > their
> > >> websites onto a different option within the next few weeks.
> > >>
> > >> There are several alternatives available, including those listed on this
> > >> page [1] on managing project websites. Infra is assembling a Wiki page
> > [2]
> > >> on migrating a website from the CMS, and is looking forward to helping
> > >> projects with this transition.
> > >>
> > >> Please let me know whether your site is still on the Apache CMS and, if
> > so,
> > >> who will be the project point-of-contact with Infra for the migration.
> > >>
> > >> Thank you!
> > >>
> > >>
> > >>
> > >>
> > >> [1] https://infra.apache.org/project-site.html
> > >>
> > >> [2]
> > >>
> > https://cwiki.apache.org/confluence/display/INFRA/Migrate+your+project+website+from+the+Apache+CMS
> > >>
> > >>
> > >>
> > >> --
> > >> Andrew Wetmore
> > >> Technical Writer-Editor
> > >> Infra
> > >> *Apache Software Foundation*
> > >> andreww@apache.org
> > >>
> > >> <
> > https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
> > >
> > >> Virus-free.
> > >> www.avast.com
> > >> <
> > https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
> > >
> > >> <#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
> > >
> >
> >
--
Matt Sicker <bo...@gmail.com>