You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@kafka.apache.org by Guozhang Wang <wa...@gmail.com> on 2016/12/14 02:12:44 UTC
Website Update, Part 2
Folks,
We are continuing to improve our website, and one of it is to break the
single gigantic "documentation" page:
https://kafka.apache.org/documentation/
into sub-spaces and sub-pages for better visibility. As the first step of
this effort, we will be gradually extract each section of this page into a
separate page and then grow each one of them in their own sub-space.
As of now, we have extract Streams section out of documentation as
https://kafka.apache.org/documentation/streams
while all the existing hashtags are preserved and re-directed via JS (many
thanks to Derrick!) so that we do not loose any SEO. At the same time I
have updated the "website doc contributions" wiki a bit with guidance on
locally displaying and debugging doc changes with this refactoring:
https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Website+Documentation+Changes
We are trying to do the same for Connect, Ops, Configs, APIs etc in the
near future. Any comments, improvements, and contributions are welcome and
encouraged.
--
-- Guozhang
Re: Website Update, Part 2
Posted by Guozhang Wang <wa...@gmail.com>.
Hi Gwen,
I am about to have a separate side bar for the subsections, but a
site-level search bar is also a good idea. Just filed a JIRA to keep track
of this.
Guozhang
On Tue, Dec 13, 2016 at 6:16 PM, Gwen Shapira <gw...@confluent.io> wrote:
> Hi,
>
> Since we are breaking down the docs, we can no longer use ctrl-f to find
> where to find specific things we are looking for... maybe it is time to add
> a site search bar? I think google has something we can embed.
>
> On Tue, Dec 13, 2016 at 6:12 PM, Guozhang Wang <wa...@gmail.com> wrote:
>
> > Folks,
> >
> > We are continuing to improve our website, and one of it is to break the
> > single gigantic "documentation" page:
> >
> > https://kafka.apache.org/documentation/
> >
> > into sub-spaces and sub-pages for better visibility. As the first step of
> > this effort, we will be gradually extract each section of this page into
> a
> > separate page and then grow each one of them in their own sub-space.
> >
> > As of now, we have extract Streams section out of documentation as
> >
> > https://kafka.apache.org/documentation/streams
> >
> > while all the existing hashtags are preserved and re-directed via JS
> (many
> > thanks to Derrick!) so that we do not loose any SEO. At the same time I
> > have updated the "website doc contributions" wiki a bit with guidance on
> > locally displaying and debugging doc changes with this refactoring:
> >
> > https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Website+
> > Documentation+Changes
> >
> >
> > We are trying to do the same for Connect, Ops, Configs, APIs etc in the
> > near future. Any comments, improvements, and contributions are welcome
> and
> > encouraged.
> >
> >
> > --
> > -- Guozhang
> >
>
>
>
> --
> *Gwen Shapira*
> Product Manager | Confluent
> 650.450.2760 | @gwenshap
> Follow us: Twitter <https://twitter.com/ConfluentInc> | blog
> <http://www.confluent.io/blog>
>
--
-- Guozhang
Re: Website Update, Part 2
Posted by Gwen Shapira <gw...@confluent.io>.
Hi,
Since we are breaking down the docs, we can no longer use ctrl-f to find
where to find specific things we are looking for... maybe it is time to add
a site search bar? I think google has something we can embed.
On Tue, Dec 13, 2016 at 6:12 PM, Guozhang Wang <wa...@gmail.com> wrote:
> Folks,
>
> We are continuing to improve our website, and one of it is to break the
> single gigantic "documentation" page:
>
> https://kafka.apache.org/documentation/
>
> into sub-spaces and sub-pages for better visibility. As the first step of
> this effort, we will be gradually extract each section of this page into a
> separate page and then grow each one of them in their own sub-space.
>
> As of now, we have extract Streams section out of documentation as
>
> https://kafka.apache.org/documentation/streams
>
> while all the existing hashtags are preserved and re-directed via JS (many
> thanks to Derrick!) so that we do not loose any SEO. At the same time I
> have updated the "website doc contributions" wiki a bit with guidance on
> locally displaying and debugging doc changes with this refactoring:
>
> https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Website+
> Documentation+Changes
>
>
> We are trying to do the same for Connect, Ops, Configs, APIs etc in the
> near future. Any comments, improvements, and contributions are welcome and
> encouraged.
>
>
> --
> -- Guozhang
>
--
*Gwen Shapira*
Product Manager | Confluent
650.450.2760 | @gwenshap
Follow us: Twitter <https://twitter.com/ConfluentInc> | blog
<http://www.confluent.io/blog>
Re: Website Update, Part 2
Posted by Gwen Shapira <gw...@confluent.io>.
Hi,
Since we are breaking down the docs, we can no longer use ctrl-f to find
where to find specific things we are looking for... maybe it is time to add
a site search bar? I think google has something we can embed.
On Tue, Dec 13, 2016 at 6:12 PM, Guozhang Wang <wa...@gmail.com> wrote:
> Folks,
>
> We are continuing to improve our website, and one of it is to break the
> single gigantic "documentation" page:
>
> https://kafka.apache.org/documentation/
>
> into sub-spaces and sub-pages for better visibility. As the first step of
> this effort, we will be gradually extract each section of this page into a
> separate page and then grow each one of them in their own sub-space.
>
> As of now, we have extract Streams section out of documentation as
>
> https://kafka.apache.org/documentation/streams
>
> while all the existing hashtags are preserved and re-directed via JS (many
> thanks to Derrick!) so that we do not loose any SEO. At the same time I
> have updated the "website doc contributions" wiki a bit with guidance on
> locally displaying and debugging doc changes with this refactoring:
>
> https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Website+
> Documentation+Changes
>
>
> We are trying to do the same for Connect, Ops, Configs, APIs etc in the
> near future. Any comments, improvements, and contributions are welcome and
> encouraged.
>
>
> --
> -- Guozhang
>
--
*Gwen Shapira*
Product Manager | Confluent
650.450.2760 | @gwenshap
Follow us: Twitter <https://twitter.com/ConfluentInc> | blog
<http://www.confluent.io/blog>