Make docs searchable

classic Classic list List threaded Threaded
12 messages Options
Reply | Threaded
Open this post in threaded view
|

Make docs searchable

Ufuk Celebi-2
Hey all,

I think our documentation has grown to a point where we need to think about
how to make it more accessible.

I would like to add a custom Google search limited to the docs *excluding*
the API docs (otherwise the results are very noisy).

Mocks:

http://tinypic.com/view.php?pic=2qtlg1k&s=8
http://tinypic.com/view.php?pic=2mchk7b&s=8


If you think this is worthwhile, I would go ahead and add this to the docs.

– Ufuk
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Robert Metzger
Cool. I would like to have the ability to search the docs, so +1 for this
idea!

On Wed, Apr 1, 2015 at 12:10 PM, Ufuk Celebi <[hidden email]> wrote:

> Hey all,
>
> I think our documentation has grown to a point where we need to think about
> how to make it more accessible.
>
> I would like to add a custom Google search limited to the docs *excluding*
> the API docs (otherwise the results are very noisy).
>
> Mocks:
>
> http://tinypic.com/view.php?pic=2qtlg1k&s=8
> http://tinypic.com/view.php?pic=2mchk7b&s=8
>
>
> If you think this is worthwhile, I would go ahead and add this to the docs.
>
> – Ufuk
>
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Till Rohrmann
I also like the idea. +1

On Wed, Apr 1, 2015 at 12:20 PM, Robert Metzger <[hidden email]> wrote:

> Cool. I would like to have the ability to search the docs, so +1 for this
> idea!
>
> On Wed, Apr 1, 2015 at 12:10 PM, Ufuk Celebi <[hidden email]> wrote:
>
> > Hey all,
> >
> > I think our documentation has grown to a point where we need to think
> about
> > how to make it more accessible.
> >
> > I would like to add a custom Google search limited to the docs
> *excluding*
> > the API docs (otherwise the results are very noisy).
> >
> > Mocks:
> >
> > http://tinypic.com/view.php?pic=2qtlg1k&s=8
> > http://tinypic.com/view.php?pic=2mchk7b&s=8
> >
> >
> > If you think this is worthwhile, I would go ahead and add this to the
> docs.
> >
> > – Ufuk
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Stephan Ewen
big +1

On Wed, Apr 1, 2015 at 12:25 PM, Till Rohrmann <[hidden email]> wrote:

> I also like the idea. +1
>
> On Wed, Apr 1, 2015 at 12:20 PM, Robert Metzger <[hidden email]>
> wrote:
>
> > Cool. I would like to have the ability to search the docs, so +1 for this
> > idea!
> >
> > On Wed, Apr 1, 2015 at 12:10 PM, Ufuk Celebi <[hidden email]> wrote:
> >
> > > Hey all,
> > >
> > > I think our documentation has grown to a point where we need to think
> > about
> > > how to make it more accessible.
> > >
> > > I would like to add a custom Google search limited to the docs
> > *excluding*
> > > the API docs (otherwise the results are very noisy).
> > >
> > > Mocks:
> > >
> > > http://tinypic.com/view.php?pic=2qtlg1k&s=8
> > > http://tinypic.com/view.php?pic=2mchk7b&s=8
> > >
> > >
> > > If you think this is worthwhile, I would go ahead and add this to the
> > docs.
> > >
> > > – Ufuk
> > >
> >
>
mxm
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

mxm
+1 Nice idea!

We would just have to filter the /api/java and /api/scala path.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Fabian Hueske-2
+1!
Would also be good if we could make the documentation less monolithic.
There are some really large pages which would benefit from an in-page
search ;-)

2015-04-01 13:57 GMT+02:00 Maximilian Michels <[hidden email]>:

> +1 Nice idea!
>
> We would just have to filter the /api/java and /api/scala path.
>
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Henry Saputra
In reply to this post by Ufuk Celebi-2
+1

Superbly needed :)

On Wednesday, April 1, 2015, Ufuk Celebi <[hidden email]> wrote:

> Hey all,
>
> I think our documentation has grown to a point where we need to think about
> how to make it more accessible.
>
> I would like to add a custom Google search limited to the docs *excluding*
> the API docs (otherwise the results are very noisy).
>
> Mocks:
>
> http://tinypic.com/view.php?pic=2qtlg1k&s=8
> http://tinypic.com/view.php?pic=2mchk7b&s=8
>
>
> If you think this is worthwhile, I would go ahead and add this to the docs.
>
> – Ufuk
>
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Kostas Tzoumas-2
+1

On Wed, Apr 1, 2015 at 4:58 PM, Henry Saputra <[hidden email]>
wrote:

> +1
>
> Superbly needed :)
>
> On Wednesday, April 1, 2015, Ufuk Celebi <[hidden email]> wrote:
>
> > Hey all,
> >
> > I think our documentation has grown to a point where we need to think
> about
> > how to make it more accessible.
> >
> > I would like to add a custom Google search limited to the docs
> *excluding*
> > the API docs (otherwise the results are very noisy).
> >
> > Mocks:
> >
> > http://tinypic.com/view.php?pic=2qtlg1k&s=8
> > http://tinypic.com/view.php?pic=2mchk7b&s=8
> >
> >
> > If you think this is worthwhile, I would go ahead and add this to the
> docs.
> >
> > – Ufuk
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Aljoscha Krettek-2
+1
On Apr 2, 2015 9:02 AM, "Kostas Tzoumas" <[hidden email]> wrote:

> +1
>
> On Wed, Apr 1, 2015 at 4:58 PM, Henry Saputra <[hidden email]>
> wrote:
>
> > +1
> >
> > Superbly needed :)
> >
> > On Wednesday, April 1, 2015, Ufuk Celebi <[hidden email]> wrote:
> >
> > > Hey all,
> > >
> > > I think our documentation has grown to a point where we need to think
> > about
> > > how to make it more accessible.
> > >
> > > I would like to add a custom Google search limited to the docs
> > *excluding*
> > > the API docs (otherwise the results are very noisy).
> > >
> > > Mocks:
> > >
> > > http://tinypic.com/view.php?pic=2qtlg1k&s=8
> > > http://tinypic.com/view.php?pic=2mchk7b&s=8
> > >
> > >
> > > If you think this is worthwhile, I would go ahead and add this to the
> > docs.
> > >
> > > – Ufuk
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Ufuk Celebi-2
OK, I've added the change as PRs. Nothing fancy. Would be still nice if someone checked it out locally and make sure that the search results refer to the correct doc version.

https://github.com/apache/flink/pull/563
https://github.com/apache/flink/pull/564

– Ufuk
mxm
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

mxm
Works really nicely.

Two things:
- Formatting issues: http://i.imgur.com/AUy53Oj.png
- I don't like the placement. How about we place it in the navigation bar
at the top? There is enough space.

On Thu, Apr 2, 2015 at 11:49 AM, Ufuk Celebi <[hidden email]> wrote:

> OK, I've added the change as PRs. Nothing fancy. Would be still nice if
> someone checked it out locally and make sure that the search results refer
> to the correct doc version.
>
> https://github.com/apache/flink/pull/563
> https://github.com/apache/flink/pull/564
>
> – Ufuk
Reply | Threaded
Open this post in threaded view
|

Re: Make docs searchable

Ufuk Celebi-2

On 02 Apr 2015, at 12:08, Maximilian Michels <[hidden email]> wrote:

> Works really nicely.
>
> Two things:
> - Formatting issues: http://i.imgur.com/AUy53Oj.png

I'll see what we can be done about this. But as you see from the commit, it's essentially just a JavaScript include.

> - I don't like the placement. How about we place it in the navigation bar
> at the top? There is enough space.

That's what I had in mind as well at first, but there the Javascript thingy really messes it up. Let's gather some feedback on the placement before we invest more time.