fuel-dev team mailing list archive

[Meg McRoberts <mmcroberts@xxxxxxxxxxxx>]

Thanks -- I was just curious.

Dmitry, are you aware of what is happening with the Mirantis OpenStack
Express documentation?
As I understand the current strategy, we are putting the docs in the
fuel-docs repo but they are to
be published on a separate web page.  I just set up new files with stub
content so that we can get
the content together -- for now, they are building as part of fuel-docs but
that may have to change.

https://review.openstack.org/#/c/84920/ -- and I have a build error there
-- I think I missed updating
a file.  I committed it so the MOE team could start populating it --
tomorrow I'll try to get it straightened
out.

Anyhow, just a heads-up so you know ...
meg


On Thu, Apr 3, 2014 at 1:37 AM, Dmitry Ilyin <dilyin@xxxxxxxxxxxx> wrote:

> Well, as far as I remember it was done when we made building of separete
> pdfs instead of a single one. But I guess we can use same index files for
> both cases. I'll try to refactor this later.
>
>
> 2014-04-03 12:15 GMT+04:00 Meg McRoberts <mmcroberts@xxxxxxxxxxxx>:
>
> Thanks, Dmitry!  I just fixed that -- let's see if Jenkins can build it
>> now.
>>
>> Can anyone explain why we need separate sourcing files for PDF and HTML?
>> I was just curious.
>>
>> meg
>>
>>
>> On Thu, Apr 3, 2014 at 12:52 AM, Dmitry Ilyin <dilyin@xxxxxxxxxxxx>wrote:
>>
>>> Meg, we have found out why the doc isn't building.
>>>
>>> There is a reference to the removed file
>>> ./contents/contents-install.rst: .. include::
>>> /pages/install-guide/networks.rst
>>>
>>> You have removed it from /install-guide.rst but forgot to remove it
>>> from /contents/contents-install.rst
>>> Files inside the contents folder are only used when building pdf. So
>>> error is not visible when you try to build html.
>>>
>>>
>>> 2014-04-03 11:15 GMT+04:00 Dmitry Ilyin <dilyin@xxxxxxxxxxxx>:
>>>
>>>> Hi, Meg
>>>>
>>>> I have built the second revision of your updates without an error.
>>>>
>>>> It's great that we are going to correct our fuel-docs repo, there are
>>>> a lot of minor issues, old garbage and other stuff that should be fixed.
>>>> If you have any problems with rst or Sphinx or just need an advice you
>>>> can always ask me, I'll try to help you.
>>>> And I can also participate in the doc cleanup process.
>>>>
>>>>
>>>> 2014-04-03 10:45 GMT+04:00 Mike Scherbakov <mscherbakov@xxxxxxxxxxxx>:
>>>>
>>>>> Sorry Meg,
>>>>> I can't really help as I'm overloaded these days.
>>>>>
>>>>> fuel-dev, any volunteer to help Meg with Sphinx?
>>>>>
>>>>> Thanks!
>>>>>
>>>>>
>>>>> On Tue, Apr 1, 2014 at 11:37 AM, Meg McRoberts <
>>>>> mmcroberts@xxxxxxxxxxxx> wrote:
>>>>>
>>>>>> Thanks, Mike.  Yes, this is one of the documents I found.  My problem
>>>>>> is that I don't know what or where the
>>>>>> container directive is.  I read  this:
>>>>>> http://docutils.sourceforge.net/docs/ref/rst/directives.html -- it
>>>>>> looks like the
>>>>>> container directive is going to contain the "container" string -- I
>>>>>> did a grep -r on the fuel-docs repo and get no
>>>>>> hits for "container".
>>>>>>
>>>>>> Any suggestions about what I should be looking for?  This was
>>>>>> building fine before I split the files...
>>>>>>  meg
>>>>>>
>>>>>>
>>>>>> On Mon, Mar 31, 2014 at 11:47 PM, Mike Scherbakov <
>>>>>> mscherbakov@xxxxxxxxxxxx> wrote:
>>>>>>
>>>>>>> Doesn't this help:
>>>>>>> http://comments.gmane.org/gmane.text.docutils.user/5827 ?
>>>>>>>
>>>>>>>
>>>>>>> On Tue, Apr 1, 2014 at 8:09 AM, Meg McRoberts <
>>>>>>> mmcroberts@xxxxxxxxxxxx> wrote:
>>>>>>>
>>>>>>>> Hi, Mike,
>>>>>>>> I have a doc build problem that I can't figure out -- could you
>>>>>>>> help or forward this to
>>>>>>>> someone else who can help.
>>>>>>>>
>>>>>>>> As a first step in the doc reorganization (blueprints coming soon),
>>>>>>>> Dmitry wants me to
>>>>>>>> break up the existing doc source into modular files -- only one
>>>>>>>> header section per file.
>>>>>>>> Also making the source tree deeper, with more sub-directories.  I
>>>>>>>> am doing this phase
>>>>>>>> without modifying or moving any of the information.
>>>>>>>>
>>>>>>>> The Install Guide is the last one I did and I am now getting the
>>>>>>>> following build error:
>>>>>>>>
>>>>>>>> Warning, treated as error:
>>>>>>>> pages/install-guide/0070-networks/0100-understand-config-network.rst:11:
>>>>>>>> SEVERE: Unexpected section title.
>>>>>>>>
>>>>>>>>     Understanding and Configuring the Network
>>>>>>>>     =========================================
>>>>>>>>
>>>>>>>>     make: *** [html] Error 1
>>>>>>>>     megm@megm-ThinkPad-W530:~/fuel-docs$
>>>>>>>>
>>>>>>>> This happens locally and with Jenkins.
>>>>>>>>
>>>>>>>> I googled and found information that this indicates that I have a
>>>>>>>> section header inside a
>>>>>>>> container directive but I can't find the "container" string
>>>>>>>> anywhere in these docs.  I've tried
>>>>>>>> all sorts of things to get around it -- if I delete the "========="
>>>>>>>> line under this header, I get
>>>>>>>> the same message for the next heading that comes up.
>>>>>>>>
>>>>>>>> Is there something else that masquerades as a container directory?
>>>>>>>>  Anything else I should
>>>>>>>> look for.
>>>>>>>>
>>>>>>>> I committed the files despite the build error so you could see them:
>>>>>>>> https://review.openstack.org/#/c/84334/
>>>>>>>>
>>>>>>>> I'll be online past midnight
>>>>>>>> my time if you want to Skype or something.
>>>>>>>>
>>>>>>>> Thanks much!
>>>>>>>> meg
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> Mike Scherbakov
>>>>>>> #mihgen
>>>>>>>
>>>>>>
>>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> Mike Scherbakov
>>>>> #mihgen
>>>>>
>>>>> --
>>>>> Mailing list: https://launchpad.net/~fuel-dev
>>>>> Post to     : fuel-dev@xxxxxxxxxxxxxxxxxxx
>>>>> Unsubscribe : https://launchpad.net/~fuel-dev
>>>>> More help   : https://help.launchpad.net/ListHelp
>>>>>
>>>>>
>>>>
>>>
>>
>