settingsLogin | Registersettings

[OpenStack-docs] [ha-guide] RST guide skeleton in place

0 votes

FYI, the HA spec has been approved and also the RST skeletion is now in
place: http://git.openstack.org/cgit/openstack/ha-guide/tree/doc/ha-guide

The setup of the RST guide is the same as for all other RST guides.

The guide is build as "ha-guide" as part of every change, you can check
the generated content clicking on the "checkbuild" check.

The skeleton looks like this currently:
http://docs-draft.openstack.org/42/180642/1/check/gate-ha-guide-tox-doc-publish-checkbuild/2276078//publish-docs/draft/ha-guide/index.html

It is not published anywhere at the moment, if you have enough content
that publishing a draft would help you, this can be done like with the
RST guides in openstack-manuals.

So, time to get content added ;)

For writing, please check our conventions that include RST conventions
as well: https://wiki.openstack.org/wiki/Documentation/Markup_conventions

If you want to migrate files from DocBook to RST, see
https://wiki.openstack.org/wiki/Documentation/Migrate

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@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
asked May 7, 2015 in openstack-docs by Andreas_Jaeger (17,140 points)   2 3 4

3 Responses

0 votes

Thanks for all the help êveryone. We havenew content and will start
dropping it in.

On Thursday, May 7, 2015, Andreas Jaeger aj@suse.com wrote:
FYI, the HA spec has been approved and also the RST skeletion is now in
place: http://git.openstack.org/cgit/openstack/ha-guide/tree/doc/ha-guide

The setup of the RST guide is the same as for all other RST guides.

The guide is build as "ha-guide" as part of every change, you can check
the generated content clicking on the "checkbuild" check.

The skeleton looks like this currently:

http://docs-draft.openstack.org/42/180642/1/check/gate-ha-guide-tox-doc-publish-checkbuild/2276078//publish-docs/draft/ha-guide/index.html

It is not published anywhere at the moment, if you have enough content
that publishing a draft would help you, this can be done like with the RST
guides in openstack-manuals.

So, time to get content added ;)

For writing, please check our conventions that include RST conventions as
well: https://wiki.openstack.org/wiki/Documentation/Markup_conventions

If you want to migrate files from DocBook to RST, see
https://wiki.openstack.org/wiki/Documentation/Migrate

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@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
responded May 7, 2015 by nickchase (1,240 points)   2
0 votes

Thanks Andreas.

Do we need to submit for code reviews to add content, or just drop in?

thanks,
-Sriram

On Thu, May 7, 2015 at 5:00 AM, Nick Chase nchase@mirantis.com wrote:

Thanks for all the help êveryone. We havenew content and will start
dropping it in.

On Thursday, May 7, 2015, Andreas Jaeger aj@suse.com wrote:

FYI, the HA spec has been approved and also the RST skeletion is now in
place: http://git.openstack.org/cgit/openstack/ha-guide/tree/doc/ha-guide

The setup of the RST guide is the same as for all other RST guides.

The guide is build as "ha-guide" as part of every change, you can check
the generated content clicking on the "checkbuild" check.

The skeleton looks like this currently:

http://docs-draft.openstack.org/42/180642/1/check/gate-ha-guide-tox-doc-publish-checkbuild/2276078//publish-docs/draft/ha-guide/index.html

It is not published anywhere at the moment, if you have enough content
that publishing a draft would help you, this can be done like with the RST
guides in openstack-manuals.

So, time to get content added ;)

For writing, please check our conventions that include RST conventions
as well: https://wiki.openstack.org/wiki/Documentation/Markup_conventions

If you want to migrate files from DocBook to RST, see
https://wiki.openstack.org/wiki/Documentation/Migrate

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@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Thanks,
-Sriram
425-463-8386
www.clouddon.com
embrace the cloud


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
responded May 14, 2015 by sriram_at_clouddon.c (280 points)   1
0 votes

On 05/14/2015 07:01 AM, Sriram Subramanian wrote:
Thanks Andreas.

Do we need to submit for code reviews to add content, or just drop in?

All submission for openstack manuals follows the common OpenStack code
review process, see
https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers if you
haven't contributed so far (and replace openstack-manuals with ha-guide).

So, please send reviews!

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, 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@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
responded May 14, 2015 by Andreas_Jaeger (17,140 points)   2 3 4
...