Open Stack

On 04/03/2015 05:53 PM, Laurel Michaels wrote:
> I originally sent this email to Andreas, and he asked me to post it on
> the mailing list:

Sorry for beeing brief in my reply - I didn't know whether I would have 
time today to answer in detail and wanted to have this known to everybody.

> *** original email ***
>
> Hi Andreas,
>
> Thanks for fixing this patch:
>
>
> https://review.openstack.org/#/c/169002/
>
>
> A few questions on what was wrong and how you fixed it.
>
> You write:
>
> "There was a scope user_only missing in the file, we need to add these
> to all files..."
>
> So, I looked in the patch and found:
>
> .. meta::
>      :scope: user_only
>
>
> Hmmm... that was  new to me -- I guess this is something that came into
> being recently? My previous migration patches didn't have it.
>
> I then looked at the migration info page here:
>
> https://wiki.openstack.org/wiki/Documentation/Migrate

I've enhanced the page now to mention user_only as well.

It was introduced with
https://review.openstack.org/#/c/167776/ and then enhanced by Olena to 
not have the files show up in *both* user and admin guide.

Your change was done before my patch - and once mine and Olena's had 
merged, it failed.

so, content that shows up in both guides, should have no scope tag. For 
content that is only for one guide, we need to add markup.

We can also use the ":orphan:" tag to mark that a file might not 
included for building. Sphinx requires that every file gets included. 
So, if you include a file only for one guide and that includes another 
file, you can mark the included file as orphan or add the scope again...



> and noticed that under admin guide it says to add this at the start of
> every file:
>
>
> .. meta::
>      :scope: admin_only
>
> I guess I should edit that page and add info at the start of the user
> guide table, saying to set the user_only scope for all user guide files?

Olena has done this but feel free to double check that no place has been 
missed.

> Would that be correct?
>
> Thanks again for doing the fix,

Andreas
-- 
  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
    GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
        Graham Norton, HRB 21284 (AG Nürnberg)
     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126