[openstack-dev] [ptls][all][tc][docs] Documentation migration spec
doug at doughellmann.com
Fri Jun 23 16:32:27 UTC 2017
> On Jun 23, 2017, at 12:10 PM, j.klare at cloudbau.de wrote:
> Hi Doug,
> first of all sorry for the late response. I am the current PTL of the openstack-chef project and read the spec a while ago, but did not really connect it to our project. To be honest, i am not really sure what we would move and how to do it. Currently we have some wiki pages, but most of them are pretty old and completely outdated since we stopped caring for them after we dropped to only a few contributors and moved our focus to maintaining the project code itself.
> Currently we own and maintain 12 service and ops cookbook repositories:
> one (not very often used) specs repository:
> and one repo to integrate them all:
> All of these repos have some READMEs that contain some of the documentation needed to use these. The documentation on how to use the openstack-chef project as a combination of all these cookbooks, is located under https://github.com/openstack/openstack-chef-repo/tree/master/doc <https://github.com/openstack/openstack-chef-repo/tree/master/doc> (which might already be close to the right space ?). Looking through the openstack-manuals repo, i did not find any documentation specific for our projects, so i think we do not need to export/import any of it. In my opinion the easiest way to follow the proposed change of us would be to just move the stuff we have under the ‘openstack-chef-repo’ mentioned above and add some more files to follow the ‘minimal layout’. If you agree on this, i can try to push a patch for it next week and add you as a reviewer?
Yes, it sounds like you only need to move things you already have around into the new structure. You don’t need to create empty directories or pages for content that doesn’t apply, so if you don’t have any configuration guide instructions for example then you don’t need to create the configuration/ directory.
If you add me as a reviewer, I’ll help make sure you have it organized as expected. And if you use the doc-migration tag the other folks working on the migration will review the patch, too.
> On 23. June 2017 at 16:16:58, Doug Hellmann (doug at doughellmann.com <mailto:doug at doughellmann.com>) wrote:
>>> On Jun 23, 2017, at 8:57 AM, Renat Akhmerov <renat.akhmerov at gmail.com <mailto:renat.akhmerov at gmail.com>> wrote:
>>> I can say for Mistral . We only planned to add Mistral docs to the central repo but didn’t do it yet. So, as far as I understand, we don’t need to move anything. We’ll review the spec and adjust the folder structure according to the proposed.
>> Please do review the steps in the spec. Not all of them are about moving content. There are steps for setting up the new build job so that the content will be published to the new URLs as well.
>>> Renat Akhmerov
>>> 23 июня 2017 г., 3:32 +0700, Doug Hellmann <doug at doughellmann.com <mailto:doug at doughellmann.com>>, писал:
>>>> Excerpts from Alexandra Settle's message of 2017-06-08 15:17:34 +0000:
>>>>> Hi everyone,
>>>>> Doug and I have written up a spec following on from the conversation  that we had regarding the documentation publishing future.
>>>>> Please take the time out of your day to review the spec as this affects *everyone*.
>>>>> See: https://review.openstack.org/#/c/472275/ <https://review.openstack.org/#/c/472275/>
>>>>> I will be PTO from the 9th – 19th of June. If you have any pressing concerns, please email me and I will get back to you as soon as I can, or, email Doug Hellmann and hopefully he will be able to assist you.
>>>>>  http://lists.openstack.org/pipermail/openstack-dev/2017-May/117162.html <http://lists.openstack.org/pipermail/openstack-dev/2017-May/117162.html>
>>>> Andreas pointed out that the new documentation job will behave a
>>>> little differently from the old setup, and thought I should mention
>>>> it so that people aren't surprised.
>>>> The new job is configured to update the docs for all repos every
>>>> time a patch is merged, not just when we tag releases. The server
>>>> projects have been working that way, but this is different for some
>>>> of the libraries, especially the clients.
>>>> I will be going back and adding a step to build the docs when we
>>>> tag releases after the move actually starts, so that we can link
>>>> to docs for specific versions of projects. That change will be
>>>> transparent to everyone else, so I have it on the list for after
>>>> the migration is under way.
>>>> OpenStack Development Mailing List (not for usage questions)
>>>> Unsubscribe: OpenStack-dev-request at lists.openstack.org <mailto:OpenStack-dev-request at lists.openstack.org>?subject:unsubscribe
>>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>
>>> OpenStack Development Mailing List (not for usage questions)
>>> Unsubscribe: OpenStack-dev-request at lists.openstack.org <mailto:OpenStack-dev-request at lists.openstack.org>?subject:unsubscribe
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the OpenStack-dev