You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@drill.apache.org by James Turton <ja...@somecomputer.xyz.INVALID> on 2021/08/27 10:43:42 UTC
Re: Fwd: [NOTICE] Git web site publishing to be done via .asf.yaml
only as of July 1st
On the documentation side of things, introducing .asf.yaml enabled some
improvements and better alignment with what other projects do. There are
new instructions in drill-site/master/README.md but here's the need-to-know.
1. The branch drill/gh-pages is now obsolete. It's full history has
been imported to drill-site/master. The apache/drill repo should not
receive website artefacts at all any more. After a couple of stable
months we can optionally clean up by deleting the drill/gh-pages branch.
2. Github Pages (http://apache.github.io/drill/) is out of the picture
too now.
3. There's a CI build run by ASF infrastructure when new Markdown docs
are pushed to master or staging in drill-site. This generates a new
site and deploys it to https://drill.apache.org or
https://drill.staged.apache.org respectively.
4. Because of 3 there's mostly no need to install or run Jekyll locally
any more but you still can in much the same way as before, just
simplified. See README.me in drill-site for more info.
Regards
James
On 2021/05/31 16:43, Ted Dunning wrote:
> Drill is on this list.
>
> I think that the fix is relatively trivial, but haven't examined it
> carefully.
>
> ---------- Forwarded message ---------
> From: Daniel Gruno <hu...@apache.org>
> Date: Mon, May 31, 2021 at 6:41 AM
> Subject: [NOTICE] Git web site publishing to be done via .asf.yaml only as
> of July 1st
> To: Users <us...@infra.apache.org>
>
>
> TL;DR: if your project web site is kept in subversion, disregard this
> email please. If your project web site is using git, and you have not
> deployed it via .asf.yaml, you MUST switch before July 1st or risk your
> web site goes stale.
>
>
>
> Dear Apache projects,
> In order to simplify our web site publishing services and improve
> self-serve for projects and stability of deployments, we will be turning
> off the old 'gitwcsub' method of publishing git web sites. As of this
> moment, this involves 120 web sites. All web sites should switch to our
> self-serve method of publishing via the .asf.yaml meta-file. We aim to
> turn off gitwcsub around July 1st.
>
>
> ## How to publish via .asf.yaml:
> Publishing via .asf.yaml is described at:
> https://s.apache.org/asfyamlpublishing
> You can also see an example .asf.yaml with publishing and staging
> profiles for our own infra web site at:
> https://github.com/apache/infrastructure-website/blob/asf-site/.asf.yaml
>
> In short, one puts a file called .asf.yaml into the branch that needs to
> be published as the project's web site, with the following two-line
> content, in this case assuming the published branch is 'asf-site':
>
> publish:
> whoami: asf-site
>
>
> It is important to note that the .asf.yaml file MUST be present at the
> root of the file system in the branch you wish to publish. The 'whoami'
> parameter acts as a guard, ensure that only the intended branch is used
> for publishing.
>
>
> ## Is my project affected by this?
> The quickest way to check if you need to switch to a .asf.yaml approach
> is to check out site source page at
> https://infra-reports.apache.org/site-source/ - if your site is listed
> in yellow, you will need to switch. This page will also tell you which
> branch you are currently publishing as your web site. This is (should
> be) the branch that you must add a .asf.yaml meta file to.
>
> The web site source list updates every hour. If your project site
> appears in green, you are already using .asf.yaml for publishing and do
> not need to make any changes.
>
>
> ## What happens if we miss the deadline?
> If you miss the deadline, don't fret. Your site will of course still
> remain online as is, but new updates will not appear till you
> create/edit the .asf.yaml and set up publishing.
>
>
> ## Who do we contact if we have questions?
> Please contact us at users@infra.apache.org if you have any additional
> questions.
>
>
> With regards,
> Daniel on behalf of ASF Infra.
>
Re: [NOTICE] Git web site publishing to be done via .asf.yaml only as
of July 1st
Posted by Charles Givre <cg...@gmail.com>.
Thanks James for doing this!!
-- C
> On Aug 27, 2021, at 7:48 AM, luoc <lu...@apache.org> wrote:
>
>
> Got it. Thank you, James.
> @kingswanwho Any questions?
>
>> 在 2021年8月27日，18:50，James Turton <ja...@somecomputer.xyz.invalid> 写道：
>>
>> On the documentation side of things, introducing .asf.yaml enabled some improvements and better alignment with what other projects do. There are new instructions in drill-site/master/README.md but here's the need-to-know.
>>
>> 1. The branch drill/gh-pages is now obsolete. It's full history has been imported to drill-site/master. The apache/drill repo should not receive website artefacts at all any more. After a couple of stable months we can optionally clean up by deleting the drill/gh-pages branch.
>> 2. Github Pages (http://apache.github.io/drill/) is out of the picture too now.
>> 3. There's a CI build run by ASF infrastructure when new Markdown docs are pushed to master or staging in drill-site. This generates a new site and deploys it to https://drill.apache.org or https://drill.staged.apache.org respectively.
>> 4. Because of 3 there's mostly no need to install or run Jekyll locally any more but you still can in much the same way as before, just simplified. See README.me in drill-site for more info.
>>
>> Regards
>> James
>>
>>> On 2021/05/31 16:43, Ted Dunning wrote:
>>> Drill is on this list.
>>>
>>> I think that the fix is relatively trivial, but haven't examined it
>>> carefully.
>>>
>>> ---------- Forwarded message ---------
>>> From: Daniel Gruno <hu...@apache.org>
>>> Date: Mon, May 31, 2021 at 6:41 AM
>>> Subject: [NOTICE] Git web site publishing to be done via .asf.yaml only as
>>> of July 1st
>>> To: Users <us...@infra.apache.org>
>>>
>>>
>>> TL;DR: if your project web site is kept in subversion, disregard this
>>> email please. If your project web site is using git, and you have not
>>> deployed it via .asf.yaml, you MUST switch before July 1st or risk your
>>> web site goes stale.
>>>
>>>
>>>
>>> Dear Apache projects,
>>> In order to simplify our web site publishing services and improve
>>> self-serve for projects and stability of deployments, we will be turning
>>> off the old 'gitwcsub' method of publishing git web sites. As of this
>>> moment, this involves 120 web sites. All web sites should switch to our
>>> self-serve method of publishing via the .asf.yaml meta-file. We aim to
>>> turn off gitwcsub around July 1st.
>>>
>>>
>>> ## How to publish via .asf.yaml:
>>> Publishing via .asf.yaml is described at:
>>> https://s.apache.org/asfyamlpublishing
>>> You can also see an example .asf.yaml with publishing and staging
>>> profiles for our own infra web site at:
>>> https://github.com/apache/infrastructure-website/blob/asf-site/.asf.yaml
>>>
>>> In short, one puts a file called .asf.yaml into the branch that needs to
>>> be published as the project's web site, with the following two-line
>>> content, in this case assuming the published branch is 'asf-site':
>>>
>>> publish:
>>> whoami: asf-site
>>>
>>>
>>> It is important to note that the .asf.yaml file MUST be present at the
>>> root of the file system in the branch you wish to publish. The 'whoami'
>>> parameter acts as a guard, ensure that only the intended branch is used
>>> for publishing.
>>>
>>>
>>> ## Is my project affected by this?
>>> The quickest way to check if you need to switch to a .asf.yaml approach
>>> is to check out site source page at
>>> https://infra-reports.apache.org/site-source/ - if your site is listed
>>> in yellow, you will need to switch. This page will also tell you which
>>> branch you are currently publishing as your web site. This is (should
>>> be) the branch that you must add a .asf.yaml meta file to.
>>>
>>> The web site source list updates every hour. If your project site
>>> appears in green, you are already using .asf.yaml for publishing and do
>>> not need to make any changes.
>>>
>>>
>>> ## What happens if we miss the deadline?
>>> If you miss the deadline, don't fret. Your site will of course still
>>> remain online as is, but new updates will not appear till you
>>> create/edit the .asf.yaml and set up publishing.
>>>
>>>
>>> ## Who do we contact if we have questions?
>>> Please contact us at users@infra.apache.org if you have any additional
>>> questions.
>>>
>>>
>>> With regards,
>>> Daniel on behalf of ASF Infra.
>>>
>
Re: [NOTICE] Git web site publishing to be done via .asf.yaml only as of July 1st
Posted by luoc <lu...@apache.org>.
Got it. Thank you, James.
@kingswanwho Any questions?
> 在 2021年8月27日，18:50，James Turton <ja...@somecomputer.xyz.invalid> 写道：
>
> On the documentation side of things, introducing .asf.yaml enabled some improvements and better alignment with what other projects do. There are new instructions in drill-site/master/README.md but here's the need-to-know.
>
> 1. The branch drill/gh-pages is now obsolete. It's full history has been imported to drill-site/master. The apache/drill repo should not receive website artefacts at all any more. After a couple of stable months we can optionally clean up by deleting the drill/gh-pages branch.
> 2. Github Pages (http://apache.github.io/drill/) is out of the picture too now.
> 3. There's a CI build run by ASF infrastructure when new Markdown docs are pushed to master or staging in drill-site. This generates a new site and deploys it to https://drill.apache.org or https://drill.staged.apache.org respectively.
> 4. Because of 3 there's mostly no need to install or run Jekyll locally any more but you still can in much the same way as before, just simplified. See README.me in drill-site for more info.
>
> Regards
> James
>
>> On 2021/05/31 16:43, Ted Dunning wrote:
>> Drill is on this list.
>>
>> I think that the fix is relatively trivial, but haven't examined it
>> carefully.
>>
>> ---------- Forwarded message ---------
>> From: Daniel Gruno <hu...@apache.org>
>> Date: Mon, May 31, 2021 at 6:41 AM
>> Subject: [NOTICE] Git web site publishing to be done via .asf.yaml only as
>> of July 1st
>> To: Users <us...@infra.apache.org>
>>
>>
>> TL;DR: if your project web site is kept in subversion, disregard this
>> email please. If your project web site is using git, and you have not
>> deployed it via .asf.yaml, you MUST switch before July 1st or risk your
>> web site goes stale.
>>
>>
>>
>> Dear Apache projects,
>> In order to simplify our web site publishing services and improve
>> self-serve for projects and stability of deployments, we will be turning
>> off the old 'gitwcsub' method of publishing git web sites. As of this
>> moment, this involves 120 web sites. All web sites should switch to our
>> self-serve method of publishing via the .asf.yaml meta-file. We aim to
>> turn off gitwcsub around July 1st.
>>
>>
>> ## How to publish via .asf.yaml:
>> Publishing via .asf.yaml is described at:
>> https://s.apache.org/asfyamlpublishing
>> You can also see an example .asf.yaml with publishing and staging
>> profiles for our own infra web site at:
>> https://github.com/apache/infrastructure-website/blob/asf-site/.asf.yaml
>>
>> In short, one puts a file called .asf.yaml into the branch that needs to
>> be published as the project's web site, with the following two-line
>> content, in this case assuming the published branch is 'asf-site':
>>
>> publish:
>> whoami: asf-site
>>
>>
>> It is important to note that the .asf.yaml file MUST be present at the
>> root of the file system in the branch you wish to publish. The 'whoami'
>> parameter acts as a guard, ensure that only the intended branch is used
>> for publishing.
>>
>>
>> ## Is my project affected by this?
>> The quickest way to check if you need to switch to a .asf.yaml approach
>> is to check out site source page at
>> https://infra-reports.apache.org/site-source/ - if your site is listed
>> in yellow, you will need to switch. This page will also tell you which
>> branch you are currently publishing as your web site. This is (should
>> be) the branch that you must add a .asf.yaml meta file to.
>>
>> The web site source list updates every hour. If your project site
>> appears in green, you are already using .asf.yaml for publishing and do
>> not need to make any changes.
>>
>>
>> ## What happens if we miss the deadline?
>> If you miss the deadline, don't fret. Your site will of course still
>> remain online as is, but new updates will not appear till you
>> create/edit the .asf.yaml and set up publishing.
>>
>>
>> ## Who do we contact if we have questions?
>> Please contact us at users@infra.apache.org if you have any additional
>> questions.
>>
>>
>> With regards,
>> Daniel on behalf of ASF Infra.
>>