settingsLogin | Registersettings

[Openstack-operators] [OpenStack-docs] [doc] Operations Guide removal

0 votes

I tried to convert all docs to rst using pandoc as the following example shows
pandoc -f docbook -t rst -s sectioncinder-deployment-choices.xml -o sectioncinder-deployment-choices.rst

There were no errors thrown, however we are missing things such as section headers, and the internal links did not convert either.

Please advise how to address this issue?

P.S.
By way of example:

For example, in the rst doc these are this is what we have
debian@debian-1:~/openstack-repo/openstack-deploy-ops-guide/cinder$ egrep -B 1 "^**|^--|^==" section_cinder-deployment-choices.rst | egrep -v '^-' | grep -v "^$"
Theory of Operation & Deployment Choices
========================================
Cinder Backends and Storage Virtual Machines.
Cinder volumes and FlexVol volumes.
Cinder volume representation within a FlexVol volume.
Cinder Scheduling and resource pool selection.
Cinder snapshots versus NetApp Snapshots.
E-Series snapshots.
CDOT and 7-mode consistency groups.
E-Series consistency groups.
SANtricity Web Services Proxy.
FAS.
E-Series.
iSCSI.
NFS.
Volume Groups.
Dynamic Disk Pools (DDP).
Options.
Setup.
Filer Side Setup.
OpenStack Setup.
Data ONTAP Thin Provisioning.
E-Series Thin Provisioning.
Establishing an iSCSI Session.
iSCSI Session Scope.
Configuration Options.

Where as in the original xml file:
debian@debian-1:~/openstack-repo/openstack-deploy-ops-guide/cinder$ grep -i title section_cinder-deployment-choices.xml

Theory of Operation & Deployment Choices
Construct Mappings between Cinder and Data ONTAP
Cinder Backends and Storage Virtual Machines
Cinder volumes and FlexVol volumes
Cinder volume representation within a FlexVol volume
Cinder Scheduling and resource pool selection
Cinder snapshots versus NetApp Snapshots
E-Series snapshots
CDOT and 7-mode consistency groups
E-Series consistency groups
SANtricity Web Services Proxy
SANtricity Web Services Proxy
Mitaka Support
Recommendation
Deployment Choice: FAS vs E-Series
FAS
E-Series
Deployment Choice: Clustered Data ONTAP vs Data ONTAP operating in 7-Mode
Recommendation
Deployment Choice: NFS versus iSCSI
iSCSI
NFS
Recommendation
Recommendation
Deployment Choice: Volume Groups vs Dynamic Disk Pools (E-Series)
Volume Groups
Dynamic Disk Pools (DDP)
Recommendation
Deployment Choice: NFS Security
Options
Setup
Filer Side Setup
OpenStack Setup
Fibre Channel Switch Fabric With Cinder
Using Cinder Volume Types to Create a Storage Service Catalog
Over-Subscription and Thin-Provisioning
Data ONTAP Thin Provisioning
E-Series Thin Provisioning
Unidirectional CHAP Authentication
Establishing an iSCSI Session
iSCSI Session Scope
Configuration Options

-----Original Message-----
From: Doug Hellmann [mailto:doug@doughellmann.com]
Sent: Thursday, August 10, 2017 8:37 AM
To: openstack-operators openstack-operators@lists.openstack.org
Subject: Re: [Openstack-operators] [OpenStack-docs] [doc] Operations Guide removal

Excerpts from Yuki Kasuya's message of 2017-08-10 17:09:48 +0900:

I tried to convert all docs under ops-guide dir using pandoc. Like
below, toctree,term and some directives doesn't work after converting.
But, at glance, almost fine after converting.
If you don't mind, I'll able to create wiki pages of ops-guide.

xxx@devstack02:~/work/openstack-manuals/doc/ops-guide/source$ pandoc
index.rst -t mediawiki -o index .wiki
pandoc: ignoring unknown directive: toctree "source" (line 58, column
1)
pandoc: ignoring unknown role :term: in "source" (line 20, column 13)
pandoc: ignoring unknown role :term: in "source" (line 19, column 59)

It should be safe to ignore the toctree directives. If you want to keep the same structure between the wiki pages and the original source document, you might want to replace those with lists of links.

The term role automatically links to the glossary. As long as the text highlighted by the role is present in the output, it is fine to ignore that warning, too.

Doug


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

OpenStack-operators mailing list
OpenStack-operators@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators
asked Aug 10, 2017 in openstack-operators by Morgenstern,_Chad (180 points)  

1 Response

0 votes

Excerpts from Morgenstern, Chad's message of 2017-08-10 13:01:47 +0000:

I tried to convert all docs to rst using pandoc as the following example shows
pandoc -f docbook -t rst -s sectioncinder-deployment-choices.xml -o sectioncinder-deployment-choices.rst

There were no errors thrown, however we are missing things such as section headers, and the internal links did not convert either.

Please advise how to address this issue?

Yuki Kasuya is also working on this (see the thread "Operations Guide
removal" on this list. Maybe you can collaborate?

Doug

P.S.
By way of example:

For example, in the rst doc these are this is what we have
debian@debian-1:~/openstack-repo/openstack-deploy-ops-guide/cinder$ egrep -B 1 "^**|^--|^==" section_cinder-deployment-choices.rst | egrep -v '^-' | grep -v "^$"
Theory of Operation & Deployment Choices
========================================
Cinder Backends and Storage Virtual Machines.
Cinder volumes and FlexVol volumes.
Cinder volume representation within a FlexVol volume.
Cinder Scheduling and resource pool selection.
Cinder snapshots versus NetApp Snapshots.
E-Series snapshots.
CDOT and 7-mode consistency groups.
E-Series consistency groups.
SANtricity Web Services Proxy.
FAS.
E-Series.
iSCSI.
NFS.
Volume Groups.
Dynamic Disk Pools (DDP).
Options.
Setup.
Filer Side Setup.
OpenStack Setup.
Data ONTAP Thin Provisioning.
E-Series Thin Provisioning.
Establishing an iSCSI Session.
iSCSI Session Scope.
Configuration Options.

Where as in the original xml file:
debian@debian-1:~/openstack-repo/openstack-deploy-ops-guide/cinder$ grep -i title section_cinder-deployment-choices.xml

Theory of Operation & Deployment Choices
Construct Mappings between Cinder and Data ONTAP
Cinder Backends and Storage Virtual Machines
Cinder volumes and FlexVol volumes
Cinder volume representation within a FlexVol volume
Cinder Scheduling and resource pool selection
Cinder snapshots versus NetApp Snapshots
E-Series snapshots
CDOT and 7-mode consistency groups
E-Series consistency groups
SANtricity Web Services Proxy
SANtricity Web Services Proxy
Mitaka Support
Recommendation
Deployment Choice: FAS vs E-Series
FAS
E-Series
Deployment Choice: Clustered Data ONTAP vs Data ONTAP operating in 7-Mode
Recommendation
Deployment Choice: NFS versus iSCSI
iSCSI
NFS
Recommendation
Recommendation
Deployment Choice: Volume Groups vs Dynamic Disk Pools (E-Series)
Volume Groups
Dynamic Disk Pools (DDP)
Recommendation
Deployment Choice: NFS Security
Options
Setup
Filer Side Setup
OpenStack Setup
Fibre Channel Switch Fabric With Cinder
Using Cinder Volume Types to Create a Storage Service Catalog
Over-Subscription and Thin-Provisioning
Data ONTAP Thin Provisioning
E-Series Thin Provisioning
Unidirectional CHAP Authentication
Establishing an iSCSI Session
iSCSI Session Scope
Configuration Options

-----Original Message-----
From: Doug Hellmann [mailto:doug@doughellmann.com]
Sent: Thursday, August 10, 2017 8:37 AM
To: openstack-operators openstack-operators@lists.openstack.org
Subject: Re: [Openstack-operators] [OpenStack-docs] [doc] Operations Guide removal

Excerpts from Yuki Kasuya's message of 2017-08-10 17:09:48 +0900:

I tried to convert all docs under ops-guide dir using pandoc. Like
below, toctree,term and some directives doesn't work after converting.
But, at glance, almost fine after converting.
If you don't mind, I'll able to create wiki pages of ops-guide.

xxx@devstack02:~/work/openstack-manuals/doc/ops-guide/source$ pandoc
index.rst -t mediawiki -o index .wiki
pandoc: ignoring unknown directive: toctree "source" (line 58, column
1)
pandoc: ignoring unknown role :term: in "source" (line 20, column 13)
pandoc: ignoring unknown role :term: in "source" (line 19, column 59)

It should be safe to ignore the toctree directives. If you want to keep the same structure between the wiki pages and the original source document, you might want to replace those with lists of links.

The term role automatically links to the glossary. As long as the text highlighted by the role is present in the output, it is fine to ignore that warning, too.

Doug


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

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


OpenStack-operators mailing list
OpenStack-operators@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators
responded Aug 10, 2017 by Doug_Hellmann (87,520 points)   3 4 9
...