(DEPRECATED) Apache Flink Mailing List archive.

[DISCUSS] Link Stateful Functions from the Flink Website

Classic

List

Threaded

7 messages Options

Stephan Ewen

[DISCUSS] Link Stateful Functions from the Flink Website

Hi all!

I think it would be nice to mention Stateful Function on the Flink website.
At the moment, Stateful Functions is very hard to discover, and with the
first release of it under Apache Flink, it would be a good time to change
that.

My proposal would be to add a "What is Stateful Functions?" below the "What
is Apache Flink" entry in the sidenav, and point it to
https://ci.apache.org/projects/flink/flink-statefun-docs-master/
It is not ideal, yet, but it may serve as an intermediate solution until we
can make more involved attempt to rethink the website (for example to also
make SQL more prominent than it currently is).

An alternative idea was to link it only from the docs, but this would be a
bit hidden, in my opinion.

As a bit of background:
- The Stateful Functions docs a are a separate doc tree at the moment,
because the code (with the docs) is for now in a separate repository and
separately versioned/releases.
- The layout of the Stateful Functions docs is still in the old/original
format, from when it was an "outside Flink" project.
- There are plans to migrate this to the same stack as the Flink docs and
make it look consistent, but it would be nice to have the docs available
in the meantime already.

Best,
Stephan

Yu Li

Re: [DISCUSS] Link Stateful Functions from the Flink Website

+1 on adding a "What is Stateful Functions" link below the "What is Apache
Flink" entry and integrating into the Flink docs gradually (instead of
hiding it behind until fully integrated).

Best Regards,
Yu

On Tue, 10 Mar 2020 at 19:33, Stephan Ewen <[hidden email]> wrote:

> Hi all!
>
> I think it would be nice to mention Stateful Function on the Flink website.
> At the moment, Stateful Functions is very hard to discover, and with the
> first release of it under Apache Flink, it would be a good time to change
> that.
>
> My proposal would be to add a "What is Stateful Functions?" below the "What
> is Apache Flink" entry in the sidenav, and point it to
> https://ci.apache.org/projects/flink/flink-statefun-docs-master/
> It is not ideal, yet, but it may serve as an intermediate solution until we
> can make more involved attempt to rethink the website (for example to also
> make SQL more prominent than it currently is).
>
> An alternative idea was to link it only from the docs, but this would be a
> bit hidden, in my opinion.
>
> As a bit of background:
> - The Stateful Functions docs a are a separate doc tree at the moment,
> because the code (with the docs) is for now in a separate repository and
> separately versioned/releases.
> - The layout of the Stateful Functions docs is still in the old/original
> format, from when it was an "outside Flink" project.
> - There are plans to migrate this to the same stack as the Flink docs and
> make it look consistent, but it would be nice to have the docs available
> in the meantime already.
>
> Best,
> Stephan
>

Tzu-Li (Gordon) Tai

Re: [DISCUSS] Link Stateful Functions from the Flink Website

+1 on the suggestion to add "What is Stateful Functions" to the left
navigation bar.
That might also mean it would be nice to have a slight rework to the main
image on the website, illustrating the use cases of Flink (this one [1]).
On the image it does mention "Event-Driven Applications", but there's
somewhat missing a more direct connection from that term to the Stateful
Functions project.

As for what the "What is Stateful Functions?" button directs to, maybe that
should point to a general concepts page. Initially, we can begin with the
README contents on the project repo [2].
As for the actual Statefun documentation link [3], I think we should link
that from an item in the "Documentation" pull-down list.

One last thing to increase visibility of the Statefun project just a bit
more:
There's a "Flink on Github" button on the very bottom of the navigation bar.
What do you think about adding a "Flink Stateful Functions on Github"
button there as well?

Cheers,
Gordon

[1]
https://github.com/apache/flink-web/blob/asf-site/img/flink-home-graphic.png
[2] https://github.com/apache/flink-statefun/blob/master/README.md
[3] https://ci.apache.org/projects/flink/flink-statefun-docs-master/

On Tue, Mar 10, 2020 at 8:29 PM Yu Li <[hidden email]> wrote:

> +1 on adding a "What is Stateful Functions" link below the "What is Apache
> Flink" entry and integrating into the Flink docs gradually (instead of
> hiding it behind until fully integrated).
>
> Best Regards,
> Yu
>
>
> On Tue, 10 Mar 2020 at 19:33, Stephan Ewen <[hidden email]> wrote:
>
> > Hi all!
> >
> > I think it would be nice to mention Stateful Function on the Flink
> website.
> > At the moment, Stateful Functions is very hard to discover, and with the
> > first release of it under Apache Flink, it would be a good time to change
> > that.
> >
> > My proposal would be to add a "What is Stateful Functions?" below the
> "What
> > is Apache Flink" entry in the sidenav, and point it to
> > https://ci.apache.org/projects/flink/flink-statefun-docs-master/
> > It is not ideal, yet, but it may serve as an intermediate solution until
> we
> > can make more involved attempt to rethink the website (for example to
> also
> > make SQL more prominent than it currently is).
> >
> > An alternative idea was to link it only from the docs, but this would be
> a
> > bit hidden, in my opinion.
> >
> > As a bit of background:
> > - The Stateful Functions docs a are a separate doc tree at the moment,
> > because the code (with the docs) is for now in a separate repository and
> > separately versioned/releases.
> > - The layout of the Stateful Functions docs is still in the
> old/original
> > format, from when it was an "outside Flink" project.
> > - There are plans to migrate this to the same stack as the Flink docs
> and
> > make it look consistent, but it would be nice to have the docs available
> > in the meantime already.
> >
> > Best,
> > Stephan
> >
>

Hequn Cheng-2

Re: [DISCUSS] Link Stateful Functions from the Flink Website

Hi,

Thanks a lot for raising the discussion @Stephan.
+1 to increase the visibilities of the Stateful Functions.

Another option I'm think is adding a section(named Stateful Functions or
Flink Projects?)
under the "Latest Blog Posts". The advantage is we can add a picture and
some descriptions here.
A picture may attract more attention from the users when he/she visit the
website.
The picture can be the same one in [1].

In the future, if we have multiple Flink individual projects, we can also
turn the section into a Table list
to expose all of them.

What do you think?

Best,
Hequn

[1] https://ci.apache.org/projects/flink/flink-statefun-docs-master/

On Tue, Mar 10, 2020 at 11:13 PM Tzu-Li (Gordon) Tai <[hidden email]>
wrote:

> +1 on the suggestion to add "What is Stateful Functions" to the left
> navigation bar.
> That might also mean it would be nice to have a slight rework to the main
> image on the website, illustrating the use cases of Flink (this one [1]).
> On the image it does mention "Event-Driven Applications", but there's
> somewhat missing a more direct connection from that term to the Stateful
> Functions project.
>
> As for what the "What is Stateful Functions?" button directs to, maybe that
> should point to a general concepts page. Initially, we can begin with the
> README contents on the project repo [2].
> As for the actual Statefun documentation link [3], I think we should link
> that from an item in the "Documentation" pull-down list.
>
> One last thing to increase visibility of the Statefun project just a bit
> more:
> There's a "Flink on Github" button on the very bottom of the navigation
> bar.
> What do you think about adding a "Flink Stateful Functions on Github"
> button there as well?
>
> Cheers,
> Gordon
>
> [1]
>
> https://github.com/apache/flink-web/blob/asf-site/img/flink-home-graphic.png
> [2] https://github.com/apache/flink-statefun/blob/master/README.md
> [3] https://ci.apache.org/projects/flink/flink-statefun-docs-master/
>
>
> On Tue, Mar 10, 2020 at 8:29 PM Yu Li <[hidden email]> wrote:
>
> > +1 on adding a "What is Stateful Functions" link below the "What is
> Apache
> > Flink" entry and integrating into the Flink docs gradually (instead of
> > hiding it behind until fully integrated).
> >
> > Best Regards,
> > Yu
> >
> >
> > On Tue, 10 Mar 2020 at 19:33, Stephan Ewen <[hidden email]> wrote:
> >
> > > Hi all!
> > >
> > > I think it would be nice to mention Stateful Function on the Flink
> > website.
> > > At the moment, Stateful Functions is very hard to discover, and with
> the
> > > first release of it under Apache Flink, it would be a good time to
> change
> > > that.
> > >
> > > My proposal would be to add a "What is Stateful Functions?" below the
> > "What
> > > is Apache Flink" entry in the sidenav, and point it to
> > > https://ci.apache.org/projects/flink/flink-statefun-docs-master/
> > > It is not ideal, yet, but it may serve as an intermediate solution
> until
> > we
> > > can make more involved attempt to rethink the website (for example to
> > also
> > > make SQL more prominent than it currently is).
> > >
> > > An alternative idea was to link it only from the docs, but this would
> be
> > a
> > > bit hidden, in my opinion.
> > >
> > > As a bit of background:
> > > - The Stateful Functions docs a are a separate doc tree at the
> moment,
> > > because the code (with the docs) is for now in a separate repository
> and
> > > separately versioned/releases.
> > > - The layout of the Stateful Functions docs is still in the
> > old/original
> > > format, from when it was an "outside Flink" project.
> > > - There are plans to migrate this to the same stack as the Flink docs
> > and
> > > make it look consistent, but it would be nice to have the docs
> available
> > > in the meantime already.
> > >
> > > Best,
> > > Stephan
> > >
> >
>

Zhijiang(wangzhijiang999)

Re: [DISCUSS] Link Stateful Functions from the Flink Website

Thanks for launching this discussion @Stephan!

+1 for the idea of linking stateful functions in Flink website. It is time to increase the exposure of this secret weapon for attracting more attentions.
It is benefit for interested users to try it out in desired scenarios and also benefit for developing it well.

Best,
Zhijiang
------------------------------------------------------------------
From:Hequn Cheng <[hidden email]>
Send Time:2020 Mar. 11 (Wed.) 15:36
To:dev <[hidden email]>
Subject:Re: [DISCUSS] Link Stateful Functions from the Flink Website

Hi,

Thanks a lot for raising the discussion @Stephan.
+1 to increase the visibilities of the Stateful Functions.

Another option I'm think is adding a section(named Stateful Functions or
Flink Projects?)
under the "Latest Blog Posts". The advantage is we can add a picture and
some descriptions here.
A picture may attract more attention from the users when he/she visit the
website.
The picture can be the same one in [1].

In the future, if we have multiple Flink individual projects, we can also
turn the section into a Table list
to expose all of them.

What do you think?

Best,
Hequn

[1] https://ci.apache.org/projects/flink/flink-statefun-docs-master/

On Tue, Mar 10, 2020 at 11:13 PM Tzu-Li (Gordon) Tai <[hidden email]>
wrote:

Stephan Ewen

Re: [DISCUSS] Link Stateful Functions from the Flink Website

Thank you all, for chiming in!

I like the ideas suggested to update the website, I am also +1 for an
update the the main image and make sure we show. Maybe something like [1],
which would also help to increase SQL visibility.
I guess that would be a bit of a bigger effort, and I would kick off that
bigger discussion in a few days or so.

Until then, as an immediate "band aid", I would then add these here (unless
there are concerns):
- What is "Stateful Functions"? link
- Documentation -> Stateful Functions Docs
- StateFun on GitHub

Best,
Stephan

[1]
https://onedrive.live.com/?authkey=%21ABxm14umFhJOXFQ&cid=E2B4A3561C93FA7B&id=E2B4A3561C93FA7B%213535&parId=E2B4A3561C93FA7B%21342&o=OneUp

On Thu, Mar 12, 2020 at 7:39 AM Zhijiang <[hidden email]>
wrote:

> Thanks for launching this discussion @Stephan!
>
> +1 for the idea of linking stateful functions in Flink website. It is time
> to increase the exposure of this secret weapon for attracting more
> attentions.
> It is benefit for interested users to try it out in desired scenarios and
> also benefit for developing it well.
>
>
> Best,
> Zhijiang
> ------------------------------------------------------------------
> From:Hequn Cheng <[hidden email]>
> Send Time:2020 Mar. 11 (Wed.) 15:36
> To:dev <[hidden email]>
> Subject:Re: [DISCUSS] Link Stateful Functions from the Flink Website
>
> Hi,
>
> Thanks a lot for raising the discussion @Stephan.
> +1 to increase the visibilities of the Stateful Functions.
>
> Another option I'm think is adding a section(named Stateful Functions or
> Flink Projects?)
> under the "Latest Blog Posts". The advantage is we can add a picture and
> some descriptions here.
> A picture may attract more attention from the users when he/she visit the
> website.
> The picture can be the same one in [1].
>
> In the future, if we have multiple Flink individual projects, we can also
> turn the section into a Table list
> to expose all of them.
>
> What do you think?
>
> Best,
> Hequn
>
> [1] https://ci.apache.org/projects/flink/flink-statefun-docs-master/
>
> On Tue, Mar 10, 2020 at 11:13 PM Tzu-Li (Gordon) Tai <[hidden email]>
> wrote:
>
> > +1 on the suggestion to add "What is Stateful Functions" to the left
> > navigation bar.
> > That might also mean it would be nice to have a slight rework to the main
> > image on the website, illustrating the use cases of Flink (this one [1]).
> > On the image it does mention "Event-Driven Applications", but there's
> > somewhat missing a more direct connection from that term to the Stateful
> > Functions project.
> >
> > As for what the "What is Stateful Functions?" button directs to, maybe
> that
> > should point to a general concepts page. Initially, we can begin with the
> > README contents on the project repo [2].
> > As for the actual Statefun documentation link [3], I think we should link
> > that from an item in the "Documentation" pull-down list.
> >
> > One last thing to increase visibility of the Statefun project just a bit
> > more:
> > There's a "Flink on Github" button on the very bottom of the navigation
> > bar.
> > What do you think about adding a "Flink Stateful Functions on Github"
> > button there as well?
> >
> > Cheers,
> > Gordon
> >
> > [1]
> >
> >
> https://github.com/apache/flink-web/blob/asf-site/img/flink-home-graphic.png
> > [2] https://github.com/apache/flink-statefun/blob/master/README.md
> > [3] https://ci.apache.org/projects/flink/flink-statefun-docs-master/
> >
> >
> > On Tue, Mar 10, 2020 at 8:29 PM Yu Li <[hidden email]> wrote:
> >
> > > +1 on adding a "What is Stateful Functions" link below the "What is
> > Apache
> > > Flink" entry and integrating into the Flink docs gradually (instead of
> > > hiding it behind until fully integrated).
> > >
> > > Best Regards,
> > > Yu
> > >
> > >
> > > On Tue, 10 Mar 2020 at 19:33, Stephan Ewen <[hidden email]> wrote:
> > >
> > > > Hi all!
> > > >
> > > > I think it would be nice to mention Stateful Function on the Flink
> > > website.
> > > > At the moment, Stateful Functions is very hard to discover, and with
> > the
> > > > first release of it under Apache Flink, it would be a good time to
> > change
> > > > that.
> > > >
> > > > My proposal would be to add a "What is Stateful Functions?" below the
> > > "What
> > > > is Apache Flink" entry in the sidenav, and point it to
> > > > https://ci.apache.org/projects/flink/flink-statefun-docs-master/
> > > > It is not ideal, yet, but it may serve as an intermediate solution
> > until
> > > we
> > > > can make more involved attempt to rethink the website (for example to
> > > also
> > > > make SQL more prominent than it currently is).
> > > >
> > > > An alternative idea was to link it only from the docs, but this would
> > be
> > > a
> > > > bit hidden, in my opinion.
> > > >
> > > > As a bit of background:
> > > > - The Stateful Functions docs a are a separate doc tree at the
> > moment,
> > > > because the code (with the docs) is for now in a separate repository
> > and
> > > > separately versioned/releases.
> > > > - The layout of the Stateful Functions docs is still in the
> > > old/original
> > > > format, from when it was an "outside Flink" project.
> > > > - There are plans to migrate this to the same stack as the Flink
> docs
> > > and
> > > > make it look consistent, but it would be nice to have the docs
> > available
> > > > in the meantime already.
> > > >
> > > > Best,
> > > > Stephan
> > > >
> > >
> >
>
>

Till Rohrmann

Re: [DISCUSS] Link Stateful Functions from the Flink Website

+1 for the list of proposed changes

- What is "Stateful Functions"? link
- Documentation -> Stateful Functions Docs
- StateFun on GitHub

Cheers,
Till

On Thu, Mar 12, 2020 at 12:22 PM Stephan Ewen <[hidden email]> wrote:

> Thank you all, for chiming in!
>
> I like the ideas suggested to update the website, I am also +1 for an
> update the the main image and make sure we show. Maybe something like [1],
> which would also help to increase SQL visibility.
> I guess that would be a bit of a bigger effort, and I would kick off that
> bigger discussion in a few days or so.
>
Until then, as an immediate "band aid", I would then add these here (unless

> there are concerns):
> - What is "Stateful Functions"? link
> - Documentation -> Stateful Functions Docs
> - StateFun on GitHub
>
> Best,
> Stephan
>
> [1]
>
> https://onedrive.live.com/?authkey=%21ABxm14umFhJOXFQ&cid=E2B4A3561C93FA7B&id=E2B4A3561C93FA7B%213535&parId=E2B4A3561C93FA7B%21342&o=OneUp
>
>
> On Thu, Mar 12, 2020 at 7:39 AM Zhijiang <[hidden email]
> .invalid>
> wrote:
>
> > Thanks for launching this discussion @Stephan!
> >
> > +1 for the idea of linking stateful functions in Flink website. It is
> time
> > to increase the exposure of this secret weapon for attracting more
> > attentions.
> > It is benefit for interested users to try it out in desired scenarios and
> > also benefit for developing it well.
> >
> >
> > Best,
> > Zhijiang
> > ------------------------------------------------------------------
> > From:Hequn Cheng <[hidden email]>
> > Send Time:2020 Mar. 11 (Wed.) 15:36
> > To:dev <[hidden email]>
> > Subject:Re: [DISCUSS] Link Stateful Functions from the Flink Website
> >
> > Hi,
> >
> > Thanks a lot for raising the discussion @Stephan.
> > +1 to increase the visibilities of the Stateful Functions.
> >
> > Another option I'm think is adding a section(named Stateful Functions or
> > Flink Projects?)
> > under the "Latest Blog Posts". The advantage is we can add a picture and
> > some descriptions here.
> > A picture may attract more attention from the users when he/she visit the
> > website.
> > The picture can be the same one in [1].
> >
> > In the future, if we have multiple Flink individual projects, we can also
> > turn the section into a Table list
> > to expose all of them.
> >
> > What do you think?
> >
> > Best,
> > Hequn
> >
> > [1] https://ci.apache.org/projects/flink/flink-statefun-docs-master/
> >
> > On Tue, Mar 10, 2020 at 11:13 PM Tzu-Li (Gordon) Tai <
> [hidden email]>
> > wrote:
> >
> > > +1 on the suggestion to add "What is Stateful Functions" to the left
> > > navigation bar.
> > > That might also mean it would be nice to have a slight rework to the
> main
> > > image on the website, illustrating the use cases of Flink (this one
> [1]).
> > > On the image it does mention "Event-Driven Applications", but there's
> > > somewhat missing a more direct connection from that term to the
> Stateful
> > > Functions project.
> > >
> > > As for what the "What is Stateful Functions?" button directs to, maybe
> > that
> > > should point to a general concepts page. Initially, we can begin with
> the
> > > README contents on the project repo [2].
> > > As for the actual Statefun documentation link [3], I think we should
> link
> > > that from an item in the "Documentation" pull-down list.
> > >
> > > One last thing to increase visibility of the Statefun project just a
> bit
> > > more:
> > > There's a "Flink on Github" button on the very bottom of the navigation
> > > bar.
> > > What do you think about adding a "Flink Stateful Functions on Github"
> > > button there as well?
> > >
> > > Cheers,
> > > Gordon
> > >
> > > [1]
> > >
> > >
> >
> https://github.com/apache/flink-web/blob/asf-site/img/flink-home-graphic.png
> > > [2] https://github.com/apache/flink-statefun/blob/master/README.md
> > > [3] https://ci.apache.org/projects/flink/flink-statefun-docs-master/
> > >
> > >
> > > On Tue, Mar 10, 2020 at 8:29 PM Yu Li <[hidden email]> wrote:
> > >
> > > > +1 on adding a "What is Stateful Functions" link below the "What is
> > > Apache
> > > > Flink" entry and integrating into the Flink docs gradually (instead
> of
> > > > hiding it behind until fully integrated).
> > > >
> > > > Best Regards,
> > > > Yu
> > > >
> > > >
> > > > On Tue, 10 Mar 2020 at 19:33, Stephan Ewen <[hidden email]> wrote:
> > > >
> > > > > Hi all!
> > > > >
> > > > > I think it would be nice to mention Stateful Function on the Flink
> > > > website.
> > > > > At the moment, Stateful Functions is very hard to discover, and
> with
> > > the
> > > > > first release of it under Apache Flink, it would be a good time to
> > > change
> > > > > that.
> > > > >
> > > > > My proposal would be to add a "What is Stateful Functions?" below
> the
> > > > "What
> > > > > is Apache Flink" entry in the sidenav, and point it to
> > > > > https://ci.apache.org/projects/flink/flink-statefun-docs-master/
> > > > > It is not ideal, yet, but it may serve as an intermediate solution
> > > until
> > > > we
> > > > > can make more involved attempt to rethink the website (for example
> to
> > > > also
> > > > > make SQL more prominent than it currently is).
> > > > >
> > > > > An alternative idea was to link it only from the docs, but this
> would
> > > be
> > > > a
> > > > > bit hidden, in my opinion.
> > > > >
> > > > > As a bit of background:
> > > > > - The Stateful Functions docs a are a separate doc tree at the
> > > moment,
> > > > > because the code (with the docs) is for now in a separate
> repository
> > > and
> > > > > separately versioned/releases.
> > > > > - The layout of the Stateful Functions docs is still in the
> > > > old/original
> > > > > format, from when it was an "outside Flink" project.
> > > > > - There are plans to migrate this to the same stack as the Flink
> > docs
> > > > and
> > > > > make it look consistent, but it would be nice to have the docs
> > > available
> > > > > in the meantime already.
> > > > >
> > > > > Best,
> > > > > Stephan
> > > > >
> > > >
> > >
> >
> >
>