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

[Anne Gentle | Just Write Click]

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  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_keywords=yes=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=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: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [nova][docs] Concerns with docs migration

[Anne Gentle | Just Write Click]

> On Aug 2, 2017, at 1:37 PM, Sean Dague  wrote:
> 
>> On 08/02/2017 12:28 PM, Clark Boylan wrote:
>>> On Wed, Aug 2, 2017, at 07:55 AM, Matt Riedemann wrote:
>>> Now that Stephen Finucane is back from enjoying his youth and 
>>> gallivanting all over Europe, and we talked about a few things in IRC 
>>> this morning on the docs migration for Nova, I wanted to dump my 
>>> concerns here for broader consumption.
>>> 
>>> 1. We know we have to fix a bunch of broken links by adding in redirects 
>>> [1] which sdague started here [2]. However, that apparently didn't catch 
>>> everything, e.g. [3], so I'm concerned we're missing other broken links. 
>>> Is there a way to find out?
>> 
>> The infra team can generate lists of 404 urls fairly easily on the docs
>> server. This won't show you everything but will show you what urls
>> people are finding/using that 404.
> 
> If we could get a weekly report of 404 urls posted somewhere public,
> that would be extremely useful, because the easy ones based on git
> renames are done, and everything else is going to require human
> inspection to figure out what the right landing target is.
> 

Fantastic idea. 

I love how many more ideas we are getting as more brains share them.

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

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [docs] Retiring clouddocs-maven-plugin

[Anne Gentle | Just Write Click]

Yes! Thank you, nice to lift that up up and away!
 - 
Anne

> On Jun 30, 2017, at 9:30 AM, Alexandra Settle  wrote:
> 
> Sound proposal. +1 
> 
> Thanks Andreas
> 
> On 6/30/17, 2:16 PM, "Andreas Jaeger"  wrote:
> 
>It's IMHO time to retire
>http://git.openstack.org/cgit/openstack/clouddocs-maven-plugin/ - this
>was used to build documents from XML.
> 
>We converted all documents to RST, have released the last version in
>April 2015, and not merged anything since May 2016.
> 
>Current openstack-manuals got fully converted to RST with Mitaka, so we
>have no current branches that need this.
> 
>Thus I propose to retire the repo and will propose patches for it. Once
>those are submitted, I'll reply here with references to them,
> 
>Andreas
>-- 
> Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
>  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>   GF: Felix Imendörffer, Jane Smithard, Graham Norton,
>   HRB 21284 (AG Nürnberg)
>GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
> 
> 
>__
>OpenStack Development Mailing List (not for usage questions)
>Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> 
> 
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all] PTL/TC candidate workflow proposal for next elections

[Anne Gentle | Just Write Click]

On Sat, Aug 22, 2015 at 6:11 PM, Anita Kuno ante...@anteaya.info wrote:

 On 08/22/2015 04:35 PM, Maish Saidel-Keesing wrote:
  +1 To what Joshua said.
 
  I would also like to understand what is the goal we are trying to
  accomplish by moving this to a repo and submitting a CR and what does
  this solve or improve on the current way we are doing things?

 The point when I proposed this workflow last release cycle was to make
 the election officials job possible to complete with certainty all
 candidates had been acknowledged rather than lost in the noise while
 still being able to do the other daily activities the election officials
 have to accomplish while being election officials.

 Noise on the mailing list? Wasn't a concern for me then and isn't now,
 as an interested observer. Making sure the officials can have confidence
 in their work? Very important.


I understand the workflow to be necessary due to the scale at which we're 
governing now. With over 40 PTL positions plus the six TC spots rotating, I 
sense we need to adopt tooling that ensures every project gets equivalent, 
trackable, audit-able, process-oriented support. 

Anne
 


 Thanks,
 Anita.
 
  Will it reduce noise? marginally (IMHO).
 
  Maish
 
  On 08/22/15 06:02, Joshua Hesketh wrote:
  I'm struggling to think of a way this might help enable discussions
  between nominees and voters about their platforms. Since the tooling
  will send out the nomination announcements the only real noise that is
  reduced is the nomination confirmed type emails.
 
  While I think this sounds really neat, I'm not convinced that it'll
  actually reduce noise on the mailing list if that was the goal. I
  realise the primary goal is to help the election officials, but
  perhaps we can achieve both of these by a separate mailing list for
  both nomination announcements and also platform discussions? This
  could be a first step and then once we have the tooling to confirm a
  nominees validity we could automate that first announcement email still.
 
  Just a thought anyway.
 
  Cheers,
  Josh
 
  On Sat, Aug 22, 2015 at 5:44 AM, Anita Kuno ante...@anteaya.info
  mailto:ante...@anteaya.info wrote:
 
  On 08/21/2015 03:37 PM, Jeremy Stanley wrote:
   On 2015-08-21 14:32:50 -0400 (-0400), Anita Kuno wrote:
   Personally I would recommend that the election officials have
   verification permissions on the proposed repo and the automation
   step is skipped to begin with as a way of expediting the repo
   creation. Getting the workflow in place in enough time that
   potential candidates can familiarize themselves with the change,
   is of primary importance I feel. Automation can happen after the
   workflow is in place.
  
   Agreed, I'm just curious what our options actually are for
   automating the confirmation research currently performed. It's
   certainly not a prerequisite for using the new repo/workflow in a
   manually-driven capacity in the meantime.
  
 
  Fair enough. I don't want to answer the question myself as I feel
  it's
  best for the response to come from current election officials.
 
  Thanks Jeremy,
  Anita.
 
 
 
 
 
  
 __
  OpenStack Development Mailing List (not for usage questions)
  Unsubscribe: 
 openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
  http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
 


 __
 OpenStack Development Mailing List (not for usage questions)
 Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
 http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev




-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] What's Up Doc? Apr. 24 2015

[Anne Gentle | Just Write Click]

__Redirect madness (March madness was over too soon)__
Sorry to bring down the docs site for a while (in my overnight) earlier 
today. Thanks to Sean Dague and Andreas Jaeger for quick help. We now have 
three of us with the ability to fix it quickly without waiting for builds 
to finish. Our hope is to get off of FTP dependence next release and move 
to object store (swift) for the site next release. 

You may still see oddities around the /trunk /draft moves in Google 
searches, but I am already seeing top hits changing for the End User Guide 
and Admin User Guide, so I expect we're out of the woods.

__Kilo release: cutting a stable branch__
I would love to cut a stable/kilo branch a week from today, but of course 
we always evaluate day-by-day, week-by-week on the completeness of the 
Configuration Reference and Install Guides.

__Networking Guide sprint and Bug Triage day 4/23__
Thanks to those who could help out for the sprint and bug triage day. 
Really appreciate the thoughtfulness on this day about doc bugs. While our 
numbers didn't budge much for openstack-manuals, the downward trend in 
openstack-api-site this release has been impressive, dang. Thanks Diane 
especially for the diligence in bug fixes. Check out 
http://webnumbr.com/untouched-bugs-in-openstack-api-site. 

__First App Tutorial__
Good progress on cleanup patches for the First App Tutorial. We'll publish 
on developer.openstack.org once it's sufficiently edited.

__Doc team meeting__

We met this week, see the minutes here to catch up:
http://eavesdrop.openstack.org/meetings/docteam/2015/docteam.2015-04-22-14.00.html

We want to switch to a different meeting schedule; alternating weeks rather 
than first/third, second/fourth. Please weigh in on times for the new 
schedule.

__Liberty Design Summit__
Be sure to put your ideas in the etherpad at 
https://etherpad.openstack.org/p/Docs_Liberty_Design_Sessions 
Lana will fit those into the schedule at 
https://docs.google.com/spreadsheets/d/1VsFdRYGbX5eCde81XDV7TrPBfEC7cgtOFikruYmqbPY/edit?usp=sharing
 
and we'll see you in Vancouver! 

-- 
Anne Gentle
annegen...@justwriteclick.com__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] What's Up Doc? April 17, 2015

[Anne Gentle | Just Write Click]

_Migration Day!_
Both our End User Guide and our Admin User Guide have been migrated from 
DocBook source to RST source and now build with Sphinx and a shiny new 
theme:

http://docs.openstack.org/user-guide/index.html
http://docs.openstack.org/user-guide-admin/index.html

Multiple thanks and shout-outs to everyone who made this happen, it's about 
six months of effort and a big blueprint to mark COMPLETE! If you see any 
problems, please report them at http://bugs.launchpad.net/openstack-manuals. 
The new design may take a while to learn how to navigate but it's a marked 
improvement in both user and contributor experience. Now go, write some 
docs! 

_New Theme_
Developers, you can now use the openstackdocstheme rather than oslosphinx 
for your developer docs published to docs.openstack.org/developer. Please 
read the openstackdocstheme/README.rst [1] carefully as it has important 
information about required conf.py changes. You can also continue to use 
oslosphinx, though I believe consistency is best. 

_Docs Analytics_
Projects, I'd like all of you to rebuild your docs using either theme as we 
need to get web analytics working again. For the last year or so, only nova 
and swift have had web analytics consistently. Gold star to 
oslosphinx-the-project for being first to build with their updated theme 
containing analytics - who will be next?

_Bug Triage Day_
Join us next Thursday, April 23, for a doc bug triage day! [2] We have doc 
team members standing by around the clock to answer questions and triage 
doc bugs. 

_Liberty Summit Doc Topics_
Please add your docs hot topics here for consideration to discuss in 
Vancouver: 
https://etherpad.openstack.org/p/Docs_Liberty_Design_Sessions
Lana will combine and compile to add to the wiki using the schedule. [3]

Thanks,
Anne

1. 
http://git.openstack.org/cgit/openstack/openstackdocstheme/tree/README.rst
2. https://wiki.openstack.org/wiki/Documentation/BugDay
3. 
https://docs.google.com/spreadsheets/d/1VsFdRYGbX5eCde81XDV7TrPBfEC7cgtOFikruYmqbPY/edit?usp=sharing


-- 
Anne Gentle
annegen...@justwriteclick.com__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] What's Up Doc? Apr 2 2015

[Anne Gentle | Just Write Click]

_ Doc team meeting APAC/Pacific edition _
Thanks to Joseph Robinson for running the APAC doc team meeting this week. 
You can get logs and minutes:
Minutes: 
http://eavesdrop.openstack.org/meetings/docteam/2015/docteam.2015-04-01-01.01.html
Log: 
http://eavesdrop.openstack.org/meetings/docteam/2015/docteam.2015-04-01-01.01.log.html

_ Progress and status _
Over 100 patches merged this week, nice job everyone. Our bug backlog 
continues to be, well, high. With 116 new, untriaged bugs in 
openstack-manuals and 581 triaged, we have a lot of work to do, and need 
all the help we can get. 

_ API docs updates _
Great work Paul Michali and Diane Fleming at Cisco, they completed the API 
reference info for LBaaS v 2.0 and it's now available at 
http://developer.openstack.org/api-ref-networking-v2-ext.html#lbaas-v2.0. 
Way to go.

Great work sahara team, they did a series of patches this week that put the 
Data processing API reference information on 
http://developer.openstack.org/api-ref-data-processing-v1.1.html. Thanks 
and kudos to PTL Sergey Lukjanov.

Great progress on Telemetry API reference docs, really impressive review in 
progress on capabilities for their API. Thank you Ildiko Vancsa for your 
diligence!

_ Welcoming more docs-core members_
Welcome to the three newest members of openstack-docs-core who have shown 
great review numbers and patches to the docs:
Maria Zlatkova
Olga Gusarenko 
Alexander Adamov

More +2 power! We also have a handful of up-and-comers who we hope to 
level up so that we can increase resources reviewing documentation for 
docs.openstack.org and developer.openstack.org.

_ Legal use of docs.openstack.org _
I'm working with the OpenStack Foundation to understand which projects 
should publish to docs.openstack.org. Many newer projects started 
automating builds to docs.openstack.org/developer/projectname and I need 
to find out where the line is drawn for what's hosted where and with what 
themes around the content. Thanks for patience while we sort this out.


-- 
Anne Gentle
annegen...@justwriteclick.com__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev