[OpenStack-docs] RST Based User Guides are published!
Bernd Bausch
berndbausch at gmail.com
Fri Apr 17 07:20:39 UTC 2015
The problems are based on wrong assumptions.
Perhaps no git is installed wherever the documentation is built. Therefore, no SHA.
It also looks like the working directory is ..../openstack-manuals when the doc is built, which results in the erroneous source code link e.g. <http://git.openstack.org/cgit/openstack/openstack-manuals/tree/cli_set_environment_variables_using_openstack_rc.rst> instead of the correct <http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guides/source/common/cli_set_environment_variables_using_openstack_rc.rst>.
In the end, it won’t be that easy to fix this.
Who can help me with the assumptions? What does the system look like where the production version of the docs is built?
Bernd
-----Original Message-----
From: Bernd Bausch [mailto:berndbausch at gmail.com]
Sent: Friday, April 17, 2015 3:50 PM
To: 'Andreas Jaeger'; 'openstack-docs at lists.openstack.org'
Subject: RE: [OpenStack-docs] RST Based User Guides are published!
I just HAD to try out my bug link.
And my nightmare becomes reality:
-----------------------------------
Release: 1.0.0 on Apr 17, 2015
SHA:
Source: http://git.openstack.org/cgit/openstack/openstack-manuals/tree/index.rst
-----------------------------------
The SHA is not populated. How did it disappear? Is the Jenkins test not realistic enough?
The link to the source is wrong; it should be http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guides/source/index.rst. That should be an easy fix.
How about the release string - is it correct?
Bernd
-----Original Message-----
From: Andreas Jaeger [mailto:aj at suse.com]
Sent: Friday, April 17, 2015 3:38 PM
To: openstack-docs at lists.openstack.org
Subject: [OpenStack-docs] RST Based User Guides are published!
The RST based user guides are now published, have a look at the shiny new versions:
http://docs.openstack.org/user-guide/index.html
http://docs.openstack.org/user-guide-admin/index.html
Thanks to everybody that participated in getting this up with converting content, reviewing, creation of the openstackdocstheme etc! I enjoyed the teamwork.
If anything is broken with these guides, please tell us.
Links from index pages should work, I expect that we find some old links to old locations and if somebody could grep through our repos for these (just search for "user-guide/content" and "user-guide-admin/content"), it would be appreciated!
Anne will delete the old content now doing the final steps in:
https://wiki.openstack.org/wiki/Documentation/Migrate#Publishing_User_Guides
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
_______________________________________________
OpenStack-docs mailing list
OpenStack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
More information about the OpenStack-docs
mailing list