[Announce] Hugo migration complete

[Seth Wiesman-4]

Hi Everyone,

I'm happy to say the migration of Flinks documentation to hugo is complete!
There will likely be some continued work over the next weeks to clean up
the css but the documentation freeze is over.

Please carefully read docs/README for details about how to build and work
with our new documentation setup. I will be working to update the
documentation contribution guide on flink-web today.

There were a lot of files that were automatically migrated from Jekyll to
Hugo. If you notice an issue please create a ticket in Jira and tag me
(sjwiesman).

If you have any questions please do not hesitate to ping me on a PR, I will
be extra vigilant to watch my Github notifications through this release
cycle.

*IMPORTANT* Jekyll and Hugo both use a directory called docs/content for
different purposes. Jekyll uses it to cache build artifacts and as such it
has been part of flinks .gitignore. This means the Jekyll content will *not*
be removed when you pull from master. Please manually delete these files or
the site will fail to build. I strongly encourage you to delete docs/content
before pulling from master.

Seth

[Chesnay Schepler-3]

Thank you Seth for the work you put in. This is a really nice improvement.
(When do we migrate the Flink website? :P )

Regarding the follow-ups raised in the PR, will you go over them and
create tickets, or...?

On 2/10/2021 3:40 PM, Seth Wiesman wrote:

> Hi Everyone,
>
> I'm happy to say the migration of Flinks documentation to hugo is complete!
> There will likely be some continued work over the next weeks to clean up
> the css but the documentation freeze is over.
>
> Please carefully read docs/README for details about how to build and work
> with our new documentation setup. I will be working to update the
> documentation contribution guide on flink-web today.
>
> There were a lot of files that were automatically migrated from Jekyll to
> Hugo. If you notice an issue please create a ticket in Jira and tag me
> (sjwiesman).
>
> If you have any questions please do not hesitate to ping me on a PR, I will
> be extra vigilant to watch my Github notifications through this release
> cycle.
>
> *IMPORTANT* Jekyll and Hugo both use a directory called docs/content for
> different purposes. Jekyll uses it to cache build artifacts and as such it
> has been part of flinks .gitignore. This means the Jekyll content will *not*
> be removed when you pull from master. Please manually delete these files or
> the site will fail to build. I strongly encourage you to delete docs/content
> before pulling from master.
>
> Seth
>

[Seth Wiesman-4]

One thing at a time :)

I'm creating tickets now for the ones on the PR but please create others as
they come up.

On Wed, Feb 10, 2021 at 9:02 AM Chesnay Schepler <[hidden email]> wrote:

> Thank you Seth for the work you put in. This is a really nice improvement.
> (When do we migrate the Flink website? :P )
>
> Regarding the follow-ups raised in the PR, will you go over them and
> create tickets, or...?
>
> On 2/10/2021 3:40 PM, Seth Wiesman wrote:
> > Hi Everyone,
> >
> > I'm happy to say the migration of Flinks documentation to hugo is
> complete!
> > There will likely be some continued work over the next weeks to clean up
> > the css but the documentation freeze is over.
> >
> > Please carefully read docs/README for details about how to build and work
> > with our new documentation setup. I will be working to update the
> > documentation contribution guide on flink-web today.
> >
> > There were a lot of files that were automatically migrated from Jekyll to
> > Hugo. If you notice an issue please create a ticket in Jira and tag me
> > (sjwiesman).
> >
> > If you have any questions please do not hesitate to ping me on a PR, I
> will
> > be extra vigilant to watch my Github notifications through this release
> > cycle.
> >
> > *IMPORTANT* Jekyll and Hugo both use a directory called docs/content for
> > different purposes. Jekyll uses it to cache build artifacts and as such
> it
> > has been part of flinks .gitignore. This means the Jekyll content will
> *not*
> > be removed when you pull from master. Please manually delete these files
> or
> > the site will fail to build. I strongly encourage you to delete
> docs/content
> > before pulling from master.
> >
> > Seth
> >
>
>

[Piotr Nowojski-5]

Hi Seth,

To clarify if I understand it correctly. Does it mean that now every time
we are switching between master/release-1.11/release-1.12 branches we will
need to remember to remove docs/content?

Best,
Piotrek

śr., 10 lut 2021 o 16:08 Seth Wiesman <[hidden email]> napisał(a):

> One thing at a time :)
>
> I'm creating tickets now for the ones on the PR but please create others as
> they come up.
>
> On Wed, Feb 10, 2021 at 9:02 AM Chesnay Schepler <[hidden email]>
> wrote:
>
> > Thank you Seth for the work you put in. This is a really nice
> improvement.
> > (When do we migrate the Flink website? :P )
> >
> > Regarding the follow-ups raised in the PR, will you go over them and
> > create tickets, or...?
> >
> > On 2/10/2021 3:40 PM, Seth Wiesman wrote:
> > > Hi Everyone,
> > >
> > > I'm happy to say the migration of Flinks documentation to hugo is
> > complete!
> > > There will likely be some continued work over the next weeks to clean
> up
> > > the css but the documentation freeze is over.
> > >
> > > Please carefully read docs/README for details about how to build and
> work
> > > with our new documentation setup. I will be working to update the
> > > documentation contribution guide on flink-web today.
> > >
> > > There were a lot of files that were automatically migrated from Jekyll
> to
> > > Hugo. If you notice an issue please create a ticket in Jira and tag me
> > > (sjwiesman).
> > >
> > > If you have any questions please do not hesitate to ping me on a PR, I
> > will
> > > be extra vigilant to watch my Github notifications through this release
> > > cycle.
> > >
> > > *IMPORTANT* Jekyll and Hugo both use a directory called docs/content
> for
> > > different purposes. Jekyll uses it to cache build artifacts and as such
> > it
> > > has been part of flinks .gitignore. This means the Jekyll content will
> > *not*
> > > be removed when you pull from master. Please manually delete these
> files
> > or
> > > the site will fail to build. I strongly encourage you to delete
> > docs/content
> > > before pulling from master.
> > >
> > > Seth
> > >
> >
> >
>

[Seth Wiesman-4]

Piotr,

docs/content is where Jekyll stores its build artifacts. In
release-1.11/release-1.12 it is hidden via .gitignore so its content is not
removed when switching to master from those branches. You only need to
remember to delete this folder when you are switching from release-1.11/12
to master AND you built the docs on that branch. Switching from master to
release-1.11/12 does not require anything.

Seth

On Wed, Feb 10, 2021 at 9:32 AM Piotr Nowojski <[hidden email]> wrote:

> Hi Seth,
>
> To clarify if I understand it correctly. Does it mean that now every time
> we are switching between master/release-1.11/release-1.12 branches we will
> need to remember to remove docs/content?
>
> Best,
> Piotrek
>
> śr., 10 lut 2021 o 16:08 Seth Wiesman <[hidden email]> napisał(a):
>
> > One thing at a time :)
> >
> > I'm creating tickets now for the ones on the PR but please create others
> as
> > they come up.
> >
> > On Wed, Feb 10, 2021 at 9:02 AM Chesnay Schepler <[hidden email]>
> > wrote:
> >
> > > Thank you Seth for the work you put in. This is a really nice
> > improvement.
> > > (When do we migrate the Flink website? :P )
> > >
> > > Regarding the follow-ups raised in the PR, will you go over them and
> > > create tickets, or...?
> > >
> > > On 2/10/2021 3:40 PM, Seth Wiesman wrote:
> > > > Hi Everyone,
> > > >
> > > > I'm happy to say the migration of Flinks documentation to hugo is
> > > complete!
> > > > There will likely be some continued work over the next weeks to clean
> > up
> > > > the css but the documentation freeze is over.
> > > >
> > > > Please carefully read docs/README for details about how to build and
> > work
> > > > with our new documentation setup. I will be working to update the
> > > > documentation contribution guide on flink-web today.
> > > >
> > > > There were a lot of files that were automatically migrated from
> Jekyll
> > to
> > > > Hugo. If you notice an issue please create a ticket in Jira and tag
> me
> > > > (sjwiesman).
> > > >
> > > > If you have any questions please do not hesitate to ping me on a PR,
> I
> > > will
> > > > be extra vigilant to watch my Github notifications through this
> release
> > > > cycle.
> > > >
> > > > *IMPORTANT* Jekyll and Hugo both use a directory called docs/content
> > for
> > > > different purposes. Jekyll uses it to cache build artifacts and as
> such
> > > it
> > > > has been part of flinks .gitignore. This means the Jekyll content
> will
> > > *not*
> > > > be removed when you pull from master. Please manually delete these
> > files
> > > or
> > > > the site will fail to build. I strongly encourage you to delete
> > > docs/content
> > > > before pulling from master.
> > > >
> > > > Seth
> > > >
> > >
> > >
> >
>

[Matthias]

Thanks again, Seth. Good job! :+1:

On Wed, Feb 10, 2021 at 5:00 PM Seth Wiesman <[hidden email]> wrote:

> Piotr,
>
> docs/content is where Jekyll stores its build artifacts. In
> release-1.11/release-1.12 it is hidden via .gitignore so its content is not
> removed when switching to master from those branches. You only need to
> remember to delete this folder when you are switching from release-1.11/12
> to master AND you built the docs on that branch. Switching from master to
> release-1.11/12 does not require anything.
>
> Seth
>
> On Wed, Feb 10, 2021 at 9:32 AM Piotr Nowojski <[hidden email]>
> wrote:
>
> > Hi Seth,
> >
> > To clarify if I understand it correctly. Does it mean that now every time
> > we are switching between master/release-1.11/release-1.12 branches we
> will
> > need to remember to remove docs/content?
> >
> > Best,
> > Piotrek
> >
> > śr., 10 lut 2021 o 16:08 Seth Wiesman <[hidden email]> napisał(a):
> >
> > > One thing at a time :)
> > >
> > > I'm creating tickets now for the ones on the PR but please create
> others
> > as
> > > they come up.
> > >
> > > On Wed, Feb 10, 2021 at 9:02 AM Chesnay Schepler <[hidden email]>
> > > wrote:
> > >
> > > > Thank you Seth for the work you put in. This is a really nice
> > > improvement.
> > > > (When do we migrate the Flink website? :P )
> > > >
> > > > Regarding the follow-ups raised in the PR, will you go over them and
> > > > create tickets, or...?
> > > >
> > > > On 2/10/2021 3:40 PM, Seth Wiesman wrote:
> > > > > Hi Everyone,
> > > > >
> > > > > I'm happy to say the migration of Flinks documentation to hugo is
> > > > complete!
> > > > > There will likely be some continued work over the next weeks to
> clean
> > > up
> > > > > the css but the documentation freeze is over.
> > > > >
> > > > > Please carefully read docs/README for details about how to build
> and
> > > work
> > > > > with our new documentation setup. I will be working to update the
> > > > > documentation contribution guide on flink-web today.
> > > > >
> > > > > There were a lot of files that were automatically migrated from
> > Jekyll
> > > to
> > > > > Hugo. If you notice an issue please create a ticket in Jira and tag
> > me
> > > > > (sjwiesman).
> > > > >
> > > > > If you have any questions please do not hesitate to ping me on a
> PR,
> > I
> > > > will
> > > > > be extra vigilant to watch my Github notifications through this
> > release
> > > > > cycle.
> > > > >
> > > > > *IMPORTANT* Jekyll and Hugo both use a directory called
> docs/content
> > > for
> > > > > different purposes. Jekyll uses it to cache build artifacts and as
> > such
> > > > it
> > > > > has been part of flinks .gitignore. This means the Jekyll content
> > will
> > > > *not*
> > > > > be removed when you pull from master. Please manually delete these
> > > files
> > > > or
> > > > > the site will fail to build. I strongly encourage you to delete
> > > > docs/content
> > > > > before pulling from master.
> > > > >
> > > > > Seth
> > > > >
> > > >
> > > >
> > >
> >

[Chesnay Schepler-3]

Looks like the buildbot scripts have not been updated yet:
https://ci.apache.org/builders/flink-docs-master/builds/2134/steps/Build%20docs/logs/stdio

On 2/10/2021 7:16 PM, Matthias Pohl wrote:

> Thanks again, Seth. Good job! :+1:
>
> On Wed, Feb 10, 2021 at 5:00 PM Seth Wiesman <[hidden email]> wrote:
>
>> Piotr,
>>
>> docs/content is where Jekyll stores its build artifacts. In
>> release-1.11/release-1.12 it is hidden via .gitignore so its content is not
>> removed when switching to master from those branches. You only need to
>> remember to delete this folder when you are switching from release-1.11/12
>> to master AND you built the docs on that branch. Switching from master to
>> release-1.11/12 does not require anything.
>>
>> Seth
>>
>> On Wed, Feb 10, 2021 at 9:32 AM Piotr Nowojski <[hidden email]>
>> wrote:
>>
>>> Hi Seth,
>>>
>>> To clarify if I understand it correctly. Does it mean that now every time
>>> we are switching between master/release-1.11/release-1.12 branches we
>> will
>>> need to remember to remove docs/content?
>>>
>>> Best,
>>> Piotrek
>>>
>>> śr., 10 lut 2021 o 16:08 Seth Wiesman <[hidden email]> napisał(a):
>>>
>>>> One thing at a time :)
>>>>
>>>> I'm creating tickets now for the ones on the PR but please create
>> others
>>> as
>>>> they come up.
>>>>
>>>> On Wed, Feb 10, 2021 at 9:02 AM Chesnay Schepler <[hidden email]>
>>>> wrote:
>>>>
>>>>> Thank you Seth for the work you put in. This is a really nice
>>>> improvement.
>>>>> (When do we migrate the Flink website? :P )
>>>>>
>>>>> Regarding the follow-ups raised in the PR, will you go over them and
>>>>> create tickets, or...?
>>>>>
>>>>> On 2/10/2021 3:40 PM, Seth Wiesman wrote:
>>>>>> Hi Everyone,
>>>>>>
>>>>>> I'm happy to say the migration of Flinks documentation to hugo is
>>>>> complete!
>>>>>> There will likely be some continued work over the next weeks to
>> clean
>>>> up
>>>>>> the css but the documentation freeze is over.
>>>>>>
>>>>>> Please carefully read docs/README for details about how to build
>> and
>>>> work
>>>>>> with our new documentation setup. I will be working to update the
>>>>>> documentation contribution guide on flink-web today.
>>>>>>
>>>>>> There were a lot of files that were automatically migrated from
>>> Jekyll
>>>> to
>>>>>> Hugo. If you notice an issue please create a ticket in Jira and tag
>>> me
>>>>>> (sjwiesman).
>>>>>>
>>>>>> If you have any questions please do not hesitate to ping me on a
>> PR,
>>> I
>>>>> will
>>>>>> be extra vigilant to watch my Github notifications through this
>>> release
>>>>>> cycle.
>>>>>>
>>>>>> *IMPORTANT* Jekyll and Hugo both use a directory called
>> docs/content
>>>> for
>>>>>> different purposes. Jekyll uses it to cache build artifacts and as
>>> such
>>>>> it
>>>>>> has been part of flinks .gitignore. This means the Jekyll content
>>> will
>>>>> *not*
>>>>>> be removed when you pull from master. Please manually delete these
>>>> files
>>>>> or
>>>>>> the site will fail to build. I strongly encourage you to delete
>>>>> docs/content
>>>>>> before pulling from master.
>>>>>>
>>>>>> Seth
>>>>>>
>>>>>

[Robert Metzger]

I'm taking care of the buildbot scripts.

Thanks a lot for the effort!

On Wed, Feb 10, 2021 at 7:23 PM Chesnay Schepler <[hidden email]> wrote:

> Looks like the buildbot scripts have not been updated yet:
>
> https://ci.apache.org/builders/flink-docs-master/builds/2134/steps/Build%20docs/logs/stdio
>
> On 2/10/2021 7:16 PM, Matthias Pohl wrote:
> > Thanks again, Seth. Good job! :+1:
> >
> > On Wed, Feb 10, 2021 at 5:00 PM Seth Wiesman <[hidden email]>
> wrote:
> >
> >> Piotr,
> >>
> >> docs/content is where Jekyll stores its build artifacts. In
> >> release-1.11/release-1.12 it is hidden via .gitignore so its content is
> not
> >> removed when switching to master from those branches. You only need to
> >> remember to delete this folder when you are switching from
> release-1.11/12
> >> to master AND you built the docs on that branch. Switching from master
> to
> >> release-1.11/12 does not require anything.
> >>
> >> Seth
> >>
> >> On Wed, Feb 10, 2021 at 9:32 AM Piotr Nowojski <[hidden email]>
> >> wrote:
> >>
> >>> Hi Seth,
> >>>
> >>> To clarify if I understand it correctly. Does it mean that now every
> time
> >>> we are switching between master/release-1.11/release-1.12 branches we
> >> will
> >>> need to remember to remove docs/content?
> >>>
> >>> Best,
> >>> Piotrek
> >>>
> >>> śr., 10 lut 2021 o 16:08 Seth Wiesman <[hidden email]>
> napisał(a):
> >>>
> >>>> One thing at a time :)
> >>>>
> >>>> I'm creating tickets now for the ones on the PR but please create
> >> others
> >>> as
> >>>> they come up.
> >>>>
> >>>> On Wed, Feb 10, 2021 at 9:02 AM Chesnay Schepler <[hidden email]>
> >>>> wrote:
> >>>>
> >>>>> Thank you Seth for the work you put in. This is a really nice
> >>>> improvement.
> >>>>> (When do we migrate the Flink website? :P )
> >>>>>
> >>>>> Regarding the follow-ups raised in the PR, will you go over them and
> >>>>> create tickets, or...?
> >>>>>
> >>>>> On 2/10/2021 3:40 PM, Seth Wiesman wrote:
> >>>>>> Hi Everyone,
> >>>>>>
> >>>>>> I'm happy to say the migration of Flinks documentation to hugo is
> >>>>> complete!
> >>>>>> There will likely be some continued work over the next weeks to
> >> clean
> >>>> up
> >>>>>> the css but the documentation freeze is over.
> >>>>>>
> >>>>>> Please carefully read docs/README for details about how to build
> >> and
> >>>> work
> >>>>>> with our new documentation setup. I will be working to update the
> >>>>>> documentation contribution guide on flink-web today.
> >>>>>>
> >>>>>> There were a lot of files that were automatically migrated from
> >>> Jekyll
> >>>> to
> >>>>>> Hugo. If you notice an issue please create a ticket in Jira and tag
> >>> me
> >>>>>> (sjwiesman).
> >>>>>>
> >>>>>> If you have any questions please do not hesitate to ping me on a
> >> PR,
> >>> I
> >>>>> will
> >>>>>> be extra vigilant to watch my Github notifications through this
> >>> release
> >>>>>> cycle.
> >>>>>>
> >>>>>> *IMPORTANT* Jekyll and Hugo both use a directory called
> >> docs/content
> >>>> for
> >>>>>> different purposes. Jekyll uses it to cache build artifacts and as
> >>> such
> >>>>> it
> >>>>>> has been part of flinks .gitignore. This means the Jekyll content
> >>> will
> >>>>> *not*
> >>>>>> be removed when you pull from master. Please manually delete these
> >>>> files
> >>>>> or
> >>>>>> the site will fail to build. I strongly encourage you to delete
> >>>>> docs/content
> >>>>>> before pulling from master.
> >>>>>>
> >>>>>> Seth
> >>>>>>
> >>>>>
>
>