[OpenStack-docs] [openstack-docs] Archiving documentation

Tom Fifield tom at openstack.org
Wed Jan 25 10:43:46 UTC 2017


Hi Lana,

The need from the users is very simple to state.

After the server move, users on Icehouse and Juno are running without 
docs - their existing links and bookmarks return an error 404 message.

While discussions around about archiving practices should continue, the 
docs team has the ability to help these users (again, 26% prod from last 
user survey) in the interim. This can be done with minimal once-off 
effort (5 minutes current estimate), and without incurring any 
additional maintenance burden of significance.

Basically, someone on infra just needs to run this:

mkdir /afs/openstack.org/docs/icehouse
cp -r /afs/openstack.org/docs-old/icehouse/config-reference 
/afs/docs/openstack/icehouse/

mkdir /afs/openstack.org/docs/juno
cp -r /afs/openstack.org/docs-old/juno/config-reference 
/afs/docs/openstack/juno/


Then, discussions can continue in a much less frenetic way :)


Regards,


Tom


On 25/01/17 18:35, Lana Brindley wrote:
> Hi Tom,
>
> Clearly, more conversation is required here. This mail thread has just degenerated and now we're all talking past each other. I would like to take this offline to better understand what you're asking for.
>
> When are you available for a chat?
>
> Lana
>
> On 25/01/17 20:19, Tom Fifield wrote:
>> Hi Alex,
>>
>> Actually, in this case I'm a Community Manager intervening in a Development Team that's failing to put user's needs first :)
>>
>> The fix is 4 commands, it will help a bunch of users, it's that simple.
>>
>> Where a trivial fix that would help roughly a quarter of OpenStack users is available, the documentation team should be able to take that on without going through a months-long approval process.
>>
>> Regards,
>>
>> Tom
>>
>> On 25/01/17 18:04, Alexandra Settle wrote:
>>> Tom, I would like to make the docs-team stance perfectly clear: You have suggested a solution, we have requested a specification.
>>>
>>> As you are a member of the core documentation team, a community team, we look forward to your patches.
>>>
>>> Thank you,
>>>
>>> Alex
>>>
>>> On 1/25/17, 9:29 AM, "Andreas Jaeger" <aj at suse.com> wrote:
>>>
>>>     On 2017-01-25 09:59, Tom Fifield  wrote:
>>>     > On 25/01/17 16:55, Andreas Jaeger wrote:
>>>     >> On 2017-01-25 09:34, Tom Fifield  wrote:
>>>     >>> On 25/01/17 16:13, Andreas Jaeger wrote:
>>>     >>>> On 2017-01-25 09:01, Tom Fifield  wrote:
>>>     >>>>> On 25/01/17 15:58, Andreas Jaeger wrote:
>>>     >>>>>> On 2017-01-25 08:47, Tom Fifield  wrote:
>>>     >>>>>>> On 25/01/17 15:33, Andreas Jaeger wrote:
>>>     >>>>>>>> On 2017-01-25 05:39, Tom Fifield  wrote:
>>>     >>>>>>>>> I'd suggest that anyone on the infrastructure team would be
>>>     >>>>>>>>> happy to
>>>     >>>>>>>>> perform this copy (and have the access necessary to do so. Just
>>>     >>>>>>>>> drop a
>>>     >>>>>>>>> mail to openstack-infra at lists.openstack.org (or in
>>>     >>>>>>>>> #openstack-infra) and
>>>     >>>>>>>>> ask to copy the icehouse dir from 'docs-archived' to 'docs.o.o'.
>>>     >>>>>>>>
>>>     >>>>>>>> I can coordinate that copying - but before I do, I'd like to see a
>>>     >>>>>>>> plan.
>>>     >>>>>>>>
>>>     >>>>>>>> Btw. copying the complete icehouse dir is wrong, I don't want to
>>>     >>>>>>>> copy
>>>     >>>>>>>> the Install Guide as you said as well. So, what should be copied
>>>     >>>>>>>> exactly?
>>>     >>>>>>>
>>>     >>>>>>> Cheers, so pseudocode then:
>>>     >>>>>>> scp docs-archive:/var/www/icehouse docs.o.o:/afs/docs/icehouse
>>>     >>>>>>> rm docs.o.o/afs/docs/icehouse/install-guide*
>>>     >>>>>>
>>>     >>>>>>
>>>     >>>>>> I'd like a positive list on which guides to copy over.
>>>     >>>>>
>>>     >>>>> Can you mail me the results of:
>>>     >>>>>
>>>     >>>>> find .
>>>     >>>>>
>>>     >>>>> in the appropriate directory on docs-archived?
>>>     >>>>>
>>>     >>>>> That way we can be 100% precise.
>>>     >>>>
>>>     >>>> find on / or on /icehouse ?
>>>     >>>>
>>>     >>>> On icehouse:
>>>     >>>> $ ls icehouse/
>>>     >>>> config-reference  index.html  install-guide  training-guides
>>>     >>>>
>>>     >>>> On / will be longer, if you want that, you'll get it offline later.
>>>     >>>>
>>>     >>>> Btw. docs-old is read-only via AFS for anybody that wants to check it.
>>>     >>>
>>>     >>>
>>>     >>> Great! That's so simple then - since it's only the config reference,
>>>     >>> it's just:
>>>     >>>
>>>     >>> mkdir /afs/openstack.org/docs/icehouse
>>>     >>> cp -r /afs/openstack.org/docs-old/icehouse/config-reference
>>>     >>> /afs/docs/openstack/icehouse/
>>>     >>>
>>>     >>> mkdir /afs/openstack.org/docs/juno
>>>     >>> cp -r /afs/openstack.org/docs-old/juno/config-reference
>>>     >>> /afs/docs/openstack/juno/
>>>     >>>
>>>     >>> I'll revise my estimate down to 5 minutes now :)
>>>     >>
>>>     >> ;)
>>>     >>
>>>     >> Where's the spec?
>>>     >
>>>     > Feel free to make one, but I'd recommend the docs team not bother with
>>>     > specs for 5 minute bug-fix tasks - it's quite a bit of overhead :)
>>>
>>>
>>>     Tom, this is not about a 5 minute fix - this is how we do it in the
>>>     future...
>>>
>>>     And for that I want the spec,
>>>     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-docs mailing list
>>>     OpenStack-docs at lists.openstack.org
>>>     http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>>
>>>
>>
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>




More information about the OpenStack-docs mailing list