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

Tom Fifield tom at openstack.org
Wed Jan 25 10:11:44 UTC 2017


On 25/01/17 17:29, Andreas Jaeger 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,

Actually, a 5 minute fix is exactly what this is about :)

Up to 26% of OpenStack users are affected by the recent docs server 
migration (Icehouse+Juno). As a result of their documentation not being 
migrated, they are running clouds without docs. Each day's delay on 
resolving this is a day they continue to be impacted.

Take months to discuss the future, by all means - it does deserve it. 
However, this fix needs to happen with immediacy and it won't impact 
those discussions.

Anything else is putting process over user experience, without reason.

Please listen to your users, and put them first :) Run the following 
commands, so they are not left inhibited while your process is run:

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/






More information about the OpenStack-docs mailing list