[Openstack-docs] Problem: Training Guide refers to "basic-install" files

Anne Gentle annegentle at justwriteclick.com
Sun Oct 13 16:29:18 UTC 2013


On Sun, Oct 13, 2013 at 10:48 AM, Sean Roberts <seanrob at yahoo-inc.com>wrote:

>  We are targeting havana. This is still a new process for everyone,
> linking in other project docs.
>

Ok, with a havana target you definitely need to clean up your includes. You
also need to figure out what to do about the conditional text, will you
output two training manuals?


> I don't expect our needs to shut down tom's progess. Ideally as included
> source docs change, known by test.py or some script, notification would go
> out as the patch is being reviewed, so the other docs won't break on next
> build. We has briefly discussed this at the bootcamp. I can start the
> discussion if you think it is time.
>
>
You won't shut down our progress, but just know that training manuals are
second priority for reviews, install and the release has to get done this
week.

I'd be open to ideas about automation but you do have to keep up with
reviews as a human, and I think that's what Tom's doing here, giving you a
heads up that some assumptions have changed.


> ~sean
>
> On Oct 12, 2013, at 18:31, "Anne Gentle" <annegentle at justwriteclick.com>
> wrote:
>
>   I don't recall Sean or Colin saying which release they are targeting.
> So their training materials might trail a release. They can also backport
> since the openstack-manuals repo does create a stable/relname branch.
>
>  I always ask for more communication about details, and they've been good
> about it so far. So let's see what release they're targeting then figure
> out the next best action. Sean, Colin, what are you targeting? Do you have
> a plan for revisions with the new install guide?
>
>  Anne
>
>
> On Sat, Oct 12, 2013 at 6:50 PM, Tom Fifield <tom at openstack.org> wrote:
>
>> Hi,
>>
>> We have a problem: the Training Guide refers to a bunch of files from
>> the old "basic install".
>>
>> Just in case you weren't aware, the basic install has already gone away,
>> replaced by our new choose-your-own adventure install guide. The "basic
>> install" won't be updated for Havana, and I've actually started patching
>> to remove the files @ https://review.openstack.org/#/c/51386/
>>
>> I'm not quite sure how to proceed here. We've been working all year to
>> streamline into a single install doc, but the training-guide seems to be
>> very heavily reliant on the structure of the old guide. You can't even
>> just replace the includes with the nearest-relevant section, because the
>> new install guide uses conditional formatting for the different
>> operating systems supported.
>>
>> At the very least, we need to make sure the old text doesn't end up in
>> the translation system.
>>
>>
>> Regards,
>>
>>
>> Tom
>>
>> _______________________________________________
>> Openstack-docs mailing list
>> Openstack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>
>
>
>  --
> Anne Gentle
> annegentle at justwriteclick.com
>
>  _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>


-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20131013/4948207a/attachment.html>


More information about the Openstack-docs mailing list