On 4/25/17, 3:40 AM, "Emilien Macchi" <emil...@redhat.com> wrote:
On Fri, Mar 24, 2017 at 11:35 AM, Emilien Macchi <emil...@redhat.com> wrote:
> On Wed, Mar 22, 2017 at 2:25 PM, Emilien Macchi <emil...@redhat.com>
wrote:
>> Thanks to these who volunteered, it's appreciated.
>>
>> I'm going to kick-off initial work here:
>>
>> 1. Create CI job that build deploy-guide on tripleo-docs repo (when
>> required) - https://review.openstack.org/448740
>
> Step 1 done.
>
>> 2. In tripleo-docs, modify tox.ini and create initial structure for
>> deployment guide (I'll kick it off once we have the CI job)
>
> Step 2, done and ready for review:
https://review.openstack.org/#/c/449684/
>
>> 3. Start moving deployment related bits from doc/source/ to
>> deploy-guide/source/ (I'll need your help for this step). We also need
>> to include Alexendra and her team to make sure we're moving the right
>> bits.
>
> Keep posted, that will be the next step.
So this step is ready now, since we have the directory in place:
https://github.com/openstack/tripleo-docs/tree/master/deploy-guide/source
I would need some help and feedback on the bits that we're going to move:
* what chapters do we want to move? (related to Deployment)
* how do we handle redirection from old URLs (to keep web search valid
until it's indexed again)
Redirection can be handled in multiple ways. You can look at doing what the
kolla team did and not move it at all, but rather, use ‘includes’. For example:
https://github.com/openstack/kolla-ansible/blob/master/deploy-guide/source/quickstart.rst
However, I would personally not recommend this action. Simply because if you
are planning to have a deployment guide, I would recommend you commit to this
action so there is one source of truth when people are looking for the guide
itself. The OpenStack-Ansible team ‘created’ a new deployment guide, and moved
most of their install content across. The team then linked to the Deployment
Guide on their docs.o.o/dev page. You can see that here:
https://docs.openstack.org/developer/openstack-ansible/
It is entirely up to the TripleO team what they intend to do here. But there
are options, basically. There will be broken links without, we recommend
implementing this method:
https://docs.openstack.org/contributor-guide/project-deploy-guide.html#deployment-guide-and-installation-guide-links
>> 4. Expose TripleO deployment guide to deployment guides front page and
>> drink a gin tonic.
I haven't figured yet how to expose the guide to the frontpage but
maybe Alexandra or someone from Docs team can help. It's unclear to me
how to handle that since we have a branchless doc repo, so we would
likely have a versionless documentation link (and handle
version-specific bits inline).
I don’t think the versioning should matter so much here. We will not version
your guides, and if you do not, there is no problem. To ‘publish’ the guides,
you need to add your deployment guide to our www/project-deploy-guide/draft
file. See here:
https://github.com/openstack/openstack-manuals/blob/master/www/project-deploy-guide/draft/index.html
Also for Ocata:
https://github.com/openstack/openstack-manuals/blob/master/www/project-deploy-guide/ocata/index.html
Again, any help is welcome. It would be great to achieve this goal in
Pike: having an official TripleO deployment guide among other
deployment tools guides.
Hopefully this helps a bit ( ping me if you have any questions/concerns.
Thanks,
>> I'll give an update when 2. is done so we can start working on the
content.
>>
>> Thanks,
>>
>> On Wed, Mar 22, 2017 at 8:22 AM, Flavio Percoco <fla...@redhat.com>
wrote:
>>> On 20/03/17 08:01 -0400, Emilien Macchi wrote:
>>>>
>>>> I proposed a blueprint to track the work done:
>>>>
>>>> https://blueprints.launchpad.net/tripleo/+spec/tripleo-deploy-guide
>>>> Target: pike-3
>>>>
>>>> Volunteers to work on it with me, please let me know.
>>>
>>>
>>> It'd be awesome to have some input from the containers squad on this
effort
>>> too.
>>> Put me on the list for now while we find another volunteer in the
containers
>>> DFG.
>>>
>>> Flavio
>>>
>>>> Thanks,
>>>>
>>>> On Tue, Mar 14, 2017 at 7:00 AM, Alexandra Settle
<a.set...@outlook.com>
>>>> wrote:
>>>>>
>>>>> Hey Emilien,
>>>>>
>>>>> You pretty much covered it all! Docs team is happy to provide
guidance,
>>>>> but in reality, it should be a fairly straight forward process.
>>>>>
>>>>> The Kolla team just completed their deploy-guide patches and were
able to
>>>>> help refine the process a bit further. Hopefully this should help the
>>>>> TripleO team :)
>>>>>
>>>>> Reach out if you have any questions at all :)
>>>>>
>>>>> Thanks,
>>>>>
>>>>> Alex
>>>>>
>>>>> On 3/13/17, 10:32 PM, "Emilien Macchi" <emil...@redhat.com> wrote:
>>>>>
>>>>> Team,
>>>>>
>>>>> [adding Alexandra, OpenStack Docs PTL]
>>>>>
>>>>> It seems like there is a common interest in pushing deployment
guides
>>>>> for different OpenStack Deployment projects: OSA, Kolla.
>>>>> The landing page is here:
>>>>> https://docs.openstack.org/project-deploy-guide/newton/
>>>>>
>>>>> And one example:
>>>>>
>>>>>
https://docs.openstack.org/project-deploy-guide/openstack-ansible/newton/
>>>>>
>>>>> I think this is pretty awesome and it would bring more visibility
for
>>>>> TripleO project, and help our community to find TripleO
documentation
>>>>> from a consistent place.
>>>>>
>>>>> The good news, is that openstack-docs team built a pretty solid
>>>>> workflow to make that happen:
>>>>>
>>>>> https://docs.openstack.org/contributor-guide/project-deploy-guide.html
>>>>> And we don't need to create new repos or do any crazy changes. It
>>>>> would probably be some refactoring and sphinx things.
>>>>>
>>>>> Alexandra, please add any words if I missed something obvious.
>>>>>
>>>>> Feedback from the team would be welcome here before we engage any
>>>>> work,
>>>>>
>>>>> Thanks!
>>>>> --
>>>>> Emilien Macchi
>>>>>
>>>>>
>>>>
>>>>
>>>>
>>>> --
>>>> Emilien Macchi
>>>>
>>>>
__________________________________________________________________________
>>>> OpenStack Development Mailing List (not for usage questions)
>>>> Unsubscribe:
openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>>
>>>
>>> --
>>> @flaper87
>>> Flavio Percoco
>>>
>>>
__________________________________________________________________________
>>> OpenStack Development Mailing List (not for usage questions)
>>> Unsubscribe:
openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>>
>>
>>
>>
>> --
>> Emilien Macchi
>
>
>
> --
> Emilien Macchi
--
Emilien Macchi
__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
