[nova][docs] O search where art thou?

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[nova][docs] O search where art thou?

Matt Riedemann-3
Before the great docs migration, searching for something in the nova
devref was restricted to the nova devref:

https://docs.openstack.org/nova/ocata/search.html?q=rbd&check_keywords=yes&area=default

Now searching for something in the nova docs searches docs.o.o, ask.o.o,
maybe other places, but it's basically so many unrelated results it's
not usable for me:

https://docs.openstack.org/nova/latest/search.html#stq=rbd&stp=1

Is there a way we can just get the content-specific (restricted to
whatever is in the nova repo for docs) search results back and if people
want more, they go to docs.o.o to search for stuff?

Because when I'm in nova docs looking for rbd stuff, I don't want to
sift through forum questions or glance docs or cinder docs, etc.

--

Thanks,

Matt

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [nova][docs] O search where art thou?

Sean Dague-2
On 08/11/2017 08:22 AM, Matt Riedemann wrote:

> Before the great docs migration, searching for something in the nova
> devref was restricted to the nova devref:
>
> https://docs.openstack.org/nova/ocata/search.html?q=rbd&check_keywords=yes&area=default
>
>
> Now searching for something in the nova docs searches docs.o.o, ask.o.o,
> maybe other places, but it's basically so many unrelated results it's
> not usable for me:
>
> https://docs.openstack.org/nova/latest/search.html#stq=rbd&stp=1
>
> Is there a way we can just get the content-specific (restricted to
> whatever is in the nova repo for docs) search results back and if people
> want more, they go to docs.o.o to search for stuff?
>
> Because when I'm in nova docs looking for rbd stuff, I don't want to
> sift through forum questions or glance docs or cinder docs, etc.

Equally problematic, in the rbd search above it returns content from all
published branches, and seems to be coming back in reverse order. So
mitaka content is the first link for folks for searching from latest docs.

        -Sean

--
Sean Dague
http://dague.net

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [nova][docs] O search where art thou?

Anne Gentle
Yeah, I need to circle back in the theme work to make sure both search scopes are available. My prior attempt had some wonky CSS debugging and I needed to separate patches more.

I'll put up another patch to the theme today to bring in the Sphinx search in the sidebar as it was before.

I'm not sure how to solve the sort problem Sean notes, would like help there.
Hope this helps -
Anne

> On Aug 11, 2017, at 7:32 AM, Sean Dague <[hidden email]> wrote:
>
>> On 08/11/2017 08:22 AM, Matt Riedemann wrote:
>> Before the great docs migration, searching for something in the nova
>> devref was restricted to the nova devref:
>>
>> https://docs.openstack.org/nova/ocata/search.html?q=rbd&check_keywords=yes&area=default
>>
>>
>> Now searching for something in the nova docs searches docs.o.o, ask.o.o,
>> maybe other places, but it's basically so many unrelated results it's
>> not usable for me:
>>
>> https://docs.openstack.org/nova/latest/search.html#stq=rbd&stp=1
>>
>> Is there a way we can just get the content-specific (restricted to
>> whatever is in the nova repo for docs) search results back and if people
>> want more, they go to docs.o.o to search for stuff?
>>
>> Because when I'm in nova docs looking for rbd stuff, I don't want to
>> sift through forum questions or glance docs or cinder docs, etc.
>
> Equally problematic, in the rbd search above it returns content from all
> published branches, and seems to be coming back in reverse order. So
> mitaka content is the first link for folks for searching from latest docs.
>
>    -Sean
>
> --
> Sean Dague
> http://dague.net
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: [hidden email]?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [nova][docs] O search where art thou?

Sean Dague-2
On 08/11/2017 08:50 AM, Anne Gentle | Just Write Click wrote:
> Yeah, I need to circle back in the theme work to make sure both search scopes are available. My prior attempt had some wonky CSS debugging and I needed to separate patches more.
>
> I'll put up another patch to the theme today to bring in the Sphinx search in the sidebar as it was before.
>
> I'm not sure how to solve the sort problem Sean notes, would like help there.
> Hope this helps -
> Anne

If we have the option to use sphinx baked in search, instead of the
bounce out to google swift_search that's being installed, it's all
solved. The sphinx search builds the search terms into a compiled
javascript file on build, and will only link to content in the tree.

I think the thing to do is probably enhance openstackdocstheme to have
some toggle of "local_search = True" which would get rid of swift_search
and just use baked in local search. Then on a per site basic people
could turn it on / off, and openstackdocstheme could still be used for
sites that want global search.

        -Sean

--
Sean Dague
http://dague.net

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [nova][docs] O search where art thou?

Doug Hellmann-2
Excerpts from Sean Dague's message of 2017-08-11 09:10:59 -0400:

> On 08/11/2017 08:50 AM, Anne Gentle | Just Write Click wrote:
> > Yeah, I need to circle back in the theme work to make sure both search scopes are available. My prior attempt had some wonky CSS debugging and I needed to separate patches more.
> >
> > I'll put up another patch to the theme today to bring in the Sphinx search in the sidebar as it was before.
> >
> > I'm not sure how to solve the sort problem Sean notes, would like help there.
> > Hope this helps -
> > Anne
>
> If we have the option to use sphinx baked in search, instead of the
> bounce out to google swift_search that's being installed, it's all
> solved. The sphinx search builds the search terms into a compiled
> javascript file on build, and will only link to content in the tree.
>
> I think the thing to do is probably enhance openstackdocstheme to have
> some toggle of "local_search = True" which would get rid of swift_search
> and just use baked in local search. Then on a per site basic people
> could turn it on / off, and openstackdocstheme could still be used for
> sites that want global search.
>
>     -Sean
>

We could also limit the global search to one of the top-level pages in
the openstack-manuals repo and have the theme link to a search page
there.

Doug

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [nova][docs] O search where art thou?

Anne Gentle
In reply to this post by Sean Dague-2
On Fri, Aug 11, 2017 at 8:10 AM, Sean Dague <[hidden email]> wrote:

> On 08/11/2017 08:50 AM, Anne Gentle | Just Write Click wrote:
>> Yeah, I need to circle back in the theme work to make sure both search scopes are available. My prior attempt had some wonky CSS debugging and I needed to separate patches more.
>>
>> I'll put up another patch to the theme today to bring in the Sphinx search in the sidebar as it was before.
>>
>> I'm not sure how to solve the sort problem Sean notes, would like help there.
>> Hope this helps -
>> Anne
>
> If we have the option to use sphinx baked in search, instead of the
> bounce out to google swift_search that's being installed, it's all
> solved. The sphinx search builds the search terms into a compiled
> javascript file on build, and will only link to content in the tree.
>
> I think the thing to do is probably enhance openstackdocstheme to have
> some toggle of "local_search = True" which would get rid of swift_search
> and just use baked in local search. Then on a per site basic people
> could turn it on / off, and openstackdocstheme could still be used for
> sites that want global search.

The global search will always be available in the header, so my idea
is to add the scoped-to-project's-collection search to the sidebar.
Let me know if that works and I'll get going on it.

Anne

>
>         -Sean
>
> --
> Sean Dague
> http://dague.net
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: [hidden email]?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev



--

Read my blog: justwrite.click
Subscribe to Docs|Code: docslikecode.com

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [nova][docs] O search where art thou?

Anne Gentle
In reply to this post by Doug Hellmann-2
On Fri, Aug 11, 2017 at 9:26 AM, Doug Hellmann <[hidden email]> wrote:

> Excerpts from Sean Dague's message of 2017-08-11 09:10:59 -0400:
>> On 08/11/2017 08:50 AM, Anne Gentle | Just Write Click wrote:
>> > Yeah, I need to circle back in the theme work to make sure both search scopes are available. My prior attempt had some wonky CSS debugging and I needed to separate patches more.
>> >
>> > I'll put up another patch to the theme today to bring in the Sphinx search in the sidebar as it was before.
>> >
>> > I'm not sure how to solve the sort problem Sean notes, would like help there.
>> > Hope this helps -
>> > Anne
>>
>> If we have the option to use sphinx baked in search, instead of the
>> bounce out to google swift_search that's being installed, it's all
>> solved. The sphinx search builds the search terms into a compiled
>> javascript file on build, and will only link to content in the tree.
>>
>> I think the thing to do is probably enhance openstackdocstheme to have
>> some toggle of "local_search = True" which would get rid of swift_search
>> and just use baked in local search. Then on a per site basic people
>> could turn it on / off, and openstackdocstheme could still be used for
>> sites that want global search.
>>
>>     -Sean
>>
>
> We could also limit the global search to one of the top-level pages in
> the openstack-manuals repo and have the theme link to a search page
> there.
>

Mmm, I think it's simpler to keep the global search in the header
as-is across docs, www, ask, and so on. So, keep it in the header and
add an additional search form for within-project. Sound good?

Anne

> Doug
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: [hidden email]?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [nova][docs] O search where art thou?

Sean Dague-2
In reply to this post by Anne Gentle
On 08/11/2017 10:49 AM, Anne Gentle wrote:

> On Fri, Aug 11, 2017 at 8:10 AM, Sean Dague <[hidden email]> wrote:
>> On 08/11/2017 08:50 AM, Anne Gentle | Just Write Click wrote:
>>> Yeah, I need to circle back in the theme work to make sure both search scopes are available. My prior attempt had some wonky CSS debugging and I needed to separate patches more.
>>>
>>> I'll put up another patch to the theme today to bring in the Sphinx search in the sidebar as it was before.
>>>
>>> I'm not sure how to solve the sort problem Sean notes, would like help there.
>>> Hope this helps -
>>> Anne
>>
>> If we have the option to use sphinx baked in search, instead of the
>> bounce out to google swift_search that's being installed, it's all
>> solved. The sphinx search builds the search terms into a compiled
>> javascript file on build, and will only link to content in the tree.
>>
>> I think the thing to do is probably enhance openstackdocstheme to have
>> some toggle of "local_search = True" which would get rid of swift_search
>> and just use baked in local search. Then on a per site basic people
>> could turn it on / off, and openstackdocstheme could still be used for
>> sites that want global search.
>
> The global search will always be available in the header, so my idea
> is to add the scoped-to-project's-collection search to the sidebar.
> Let me know if that works and I'll get going on it.

The sidebar would be good. I still think it's a little confusing to have
2 different search fields, but maybe if "Search" in the toolbar was
"Search all of OpenStack", and the sidebar was more clearly "Search
$project Docs", it would be more clear.

The big technical bit is actually the openstackdocstheme replaced
search.html with a form that uses swift_search. I was hacking on this
this morning and it seems that in able to get that back to something
that works with built in search is going to need to redo that page, and
also add the ability to inject script_footers (as all the javascript is
late loaded in openstackdocstheme).

        -Sean

--
Sean Dague
http://dague.net

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [nova][docs] O search where art thou?

Sean Dague-2
In reply to this post by Matt Riedemann-3
On 08/11/2017 08:22 AM, Matt Riedemann wrote:

> Before the great docs migration, searching for something in the nova
> devref was restricted to the nova devref:
>
> https://docs.openstack.org/nova/ocata/search.html?q=rbd&check_keywords=yes&area=default
>
>
> Now searching for something in the nova docs searches docs.o.o, ask.o.o,
> maybe other places, but it's basically so many unrelated results it's
> not usable for me:
>
> https://docs.openstack.org/nova/latest/search.html#stq=rbd&stp=1
>
> Is there a way we can just get the content-specific (restricted to
> whatever is in the nova repo for docs) search results back and if people
> want more, they go to docs.o.o to search for stuff?
>
> Because when I'm in nova docs looking for rbd stuff, I don't want to
> sift through forum questions or glance docs or cinder docs, etc.

The following change will bring back local search behavior like that -
https://review.openstack.org/#/c/493107/

It will need to be landed and release, and probably backported to
stable/pike given that all the branches have been cut.

        -Sean

--
Sean Dague
http://dague.net

__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [hidden email]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Loading...