Convert the configuration reference to RST

Registered by Gauvain Pocentek

The Configuration Reference will be converted from docbook to RST, and the associated tools (openstack-doc-tools) will be updated to support RST tables output.

Blueprint information

Status:
Complete
Approver:
Lana
Priority:
Medium
Drafter:
Gauvain Pocentek
Direction:
Approved
Assignee:
Gauvain Pocentek
Definition:
Approved
Series goal:
Accepted for mitaka
Implementation:
Implemented
Milestone target:
milestone icon mitaka
Started by
Matt Kassawara
Completed by
KATO Tomoyuki

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/config-ref-rst,n,z

Addressed by: https://review.openstack.org/241998
    [config-ref] RST migration

Addressed by: https://review.openstack.org/242809
    [config-ref] Initial structure for RST migration

Addressed by: https://review.openstack.org/243612
    [config-ref] Convert overview chapter to RST

Addressed by: https://review.openstack.org/245536
    swift flags: read from RST

Addressed by: https://review.openstack.org/245221
    [config-ref] Migrate app_policy_json.xml to rst

Gerrit topic: https://review.openstack.org/#q,topic:246330,n,z

Addressed by: https://review.openstack.org/246330
    [config-ref] Initial import of RST tables

Gerrit topic: https://review.openstack.org/#q,topic:bp/config-ref,n,z

Addressed by: https://review.openstack.org/245888
    [config-ref] Migrate ch_configuring-openstack-block-storage.xml to rst

Addressed by: https://review.openstack.org/246770
    [config-ref] Convert ch_baremetalconfigure.xml to RST

Addressed by: https://review.openstack.org/245523
    [config-ref] Convert compute chapter to RST

Addressed by: https://review.openstack.org/248453
    [config-ref] Convert nova config options to RST

Addressed by: https://review.openstack.org/249170
    [config-ref] RST conversion: section_backup-drivers.xml

Addressed by: https://review.openstack.org/249613
    [config-ref] Migrate ch_sharedfilesystemsconfigure.xml to RST

Addressed by: https://review.openstack.org/249703
    [config-ref] Dummy include of conf-change tables

Addressed by: https://review.openstack.org/250578
    [config-ref] Convert nova logs section to RST

Addressed by: https://review.openstack.org/250605
    [config-ref] Convert nova.conf samples to RST

Addressed by: https://review.openstack.org/250655
    [config-ref-rst] Convert orchestration/*

Addressed by: https://review.openstack.org/250732
    [config-ref] Convert nova conductor to RST

Addressed by: https://review.openstack.org/250828
    [config-ref] Convert nova cells to RST

Addressed by: https://review.openstack.org/251000
    [config-ref] Convert nova scheduler to RST

Addressed by: https://review.openstack.org/251034
    [config-ref] Add telemetry service config options

Addressed by: https://review.openstack.org/251033
    [config-ref] Convert database service sections

Addressed by: https://review.openstack.org/251037
    [config-ref] Convert some image-service files

Addressed by: https://review.openstack.org/251056
    [config-ref] Convert ch-telemetry

Addressed by: https://review.openstack.org/251101
    [config-ref] Convert volumen-encryption section

Addressed by: https://review.openstack.org/251103
    WIP: [config-ref] Networking sections

Addressed by: https://review.openstack.org/251108
    [config-ref] Convert Manila drivers to RST

Addressed by: https://review.openstack.org/251119
    [config-ref] WIP: Unify supported operations

Addressed by: https://review.openstack.org/251142
    [config-ref] Manila: Consolidate driver options

Addressed by: https://review.openstack.org/251143
    [config-ref] Add manila RPC section

Addressed by: https://review.openstack.org/251167
    [config-ref] Convert compute db and rpc to RST

Addressed by: https://review.openstack.org/251225
    Update autohelp template for Config Reference

Addressed by: https://review.openstack.org/251509
    [config-ref] Convert telemetry sample-files.xml

Addressed by: https://review.openstack.org/251562
    [config-ref] Remove unnecessary quotes

Addressed by: https://review.openstack.org/251774
    [config-ref] Convert compute api and ec2api to RST

Addressed by: https://review.openstack.org/251462
    [config-ref] Migrate blockbridge-eps-driver.xml to rst

Addressed by: https://review.openstack.org/251941
    [config-ref] Migrate dell-equallogic-driver.xml to rst

Addressed by: https://review.openstack.org/252200
    [config-ref] Convert compute hypervisors to RST

Addressed by: https://review.openstack.org/252404
    [config-ref] Convert compute fc and iscsi to RST

Addressed by: https://review.openstack.org/252408
    [config-ref] Convert compute Hyper-V to RST

Addressed by: https://review.openstack.org/252427
    [config-ref] Convert compute KVM to RST

Addressed by: https://review.openstack.org/252712
    [config-ref] Update the links to each hypervisor

Addressed by: https://review.openstack.org/252714
    [config-ref] Convert compute LXC to RST

Addressed by: https://review.openstack.org/252997
    [config-ref] Convert compute LXC to RST

Addressed by: https://review.openstack.org/253168
    [config-ref] Import neutron RST tables

Addressed by: https://review.openstack.org/253341
    [config-ref] Convert compute VMware to RST

Addressed by: https://review.openstack.org/253384
    [config-ref] Convert compute Xen API to RST

Addressed by: https://review.openstack.org/253440
    [config-ref] Convert compute Xen libvirt to RST

Addressed by: https://review.openstack.org/253932
    [config-ref] Convert violin drivers to RST

Addressed by: https://review.openstack.org/253936
    [config-ref] Convert tintri driver to RST

Addressed by: https://review.openstack.org/253938
    [config-ref] Convert solidfire driver to RST

Addressed by: https://review.openstack.org/253939
    [config-ref] Convert smbfs driver to RST

Addressed by: https://review.openstack.org/253941
    [config-ref] Convert sheepdog driver to RST

Addressed by: https://review.openstack.org/253942
    [config-ref] Convert Scality driver to RST

Addressed by: https://review.openstack.org/253943
    [config-ref] Convert Quobyte driver to RST

Addressed by: https://review.openstack.org/253953
    [config-ref] Convert sample conf files sections to RST

Addressed by: https://review.openstack.org/253954
    [config-ref] Convert the orchestration chapter to RST

Addressed by: https://review.openstack.org/254053
    [config-ref] Convert ch_imageservice to RST

Addressed by: https://review.openstack.org/254093
    [config-ref] Migrate ch_identityconfigure to RST

Addressed by: https://review.openstack.org/254100
    [config-ref] Convert the sahara chapter to RST

Addressed by: https://review.openstack.org/254112
    [config-ref] Convert the trove chapter to RST

Addressed by: https://review.openstack.org/254129
    [config-ref] Convert sahara chapter to RST

Addressed by: https://review.openstack.org/254209
    [config-ref] Convert cinder ProphetStor to RST

Addressed by: https://review.openstack.org/254219
    [config-ref] Convert cinder Nimble to RST

Addressed by: https://review.openstack.org/254227
    Convert pure storage driver to RST

Addressed by: https://review.openstack.org/254251
    Convert pure storage driver to RST

Addressed by: https://review.openstack.org/254265
    Convert pure storage driver to RST

Addressed by: https://review.openstack.org/254275
    [config-ref] Convert the swift section to RST

Addressed by: https://review.openstack.org/254297
    [config-ref] [WIP] Convert ibm-gpfs-volume-driver to RST

Addressed by: https://review.openstack.org/254356
    [config-ref] Convert ibm-sonas-7k-driver to RST

Addressed by: https://review.openstack.org/254375
    [config-ref] [WIP] Convert ibm-storwize-svc-driver to RST

Addressed by: https://review.openstack.org/254390
    [config-ref] Convert ibm-xiv-volume-driver to RST

Addressed by: https://review.openstack.org/254666
    [config-ref] Convert dashboard configure to RST

Addressed by: https://review.openstack.org/254697
    [config-ref] Convert dashboard customize to RST

Addressed by: https://review.openstack.org/254742
    [config-ref] Convert dashboard files to RST

Addressed by: https://review.openstack.org/254763
    [config-ref] Convert block storage NFS to RST

Addressed by: https://review.openstack.org/254925
    [config-ref] Convert LVM cinder driver to RST

Addressed by: https://review.openstack.org/254948
    [config-ref] Convert the NetApp cinder driver to RST

Addressed by: https://review.openstack.org/255066
    [config-ref] Convert block storage Hitachi to RST

Addressed by: https://review.openstack.org/255068
    [config-ref] Convert block storage Gluster to RST

Addressed by: https://review.openstack.org/255206
    Convert HP MSA driver to RST

Addressed by: https://review.openstack.org/255247
    [config-ref] Convert block storage HDS HNAS to RST

Addressed by: https://review.openstack.org/255257
    [config-ref] Convert HPE 3PAR driver to RST

Addressed by: https://review.openstack.org/255454
    [config-ref] Convert lenovo-driver to RST

Addressed by: https://review.openstack.org/255739
    [config-ref] Neutron conf-changes

Addressed by: https://review.openstack.org/255744
    [config-ref] Add README in conf-changes/ folder

Addressed by: https://review.openstack.org/255806
    [config-ref] Minor changes to HPE 3PAR drivers RST

Addressed by: https://review.openstack.org/255932
    [config-ref] Convert the XtremIO cinder driver to RST

Addressed by: https://review.openstack.org/255954
    [config-ref] Convert FlashSystem volume driver to RST

Addressed by: https://review.openstack.org/255977
    [config-ref] Convert EMC VNX driver to RST

Addressed by: https://review.openstack.org/256147
    [config-ref] Fix minor issues with IBM FlashSystem

Addressed by: https://review.openstack.org/256601
    [config-ref] Convert HPE Lefthand driver to RST

Addressed by: https://review.openstack.org/256633
    [config-ref] Convert the Dell drivers to RST

Addressed by: https://review.openstack.org/256643
    [config-ref] Convert KVM backing storage to RST

Gerrit topic: https://review.openstack.org/#q,topic:rst,n,z

Addressed by: https://review.openstack.org/256941
    [config-ref] Improvements of drivers using rst mark-ups

Gerrit topic: https://review.openstack.org/#q,topic:dvp-rst,n,z

Addressed by: https://review.openstack.org/256946
    [config-ref] Improvements for bloack storage drivers

Gerrit topic: https://review.openstack.org/#q,topic:mark,n,z

Addressed by: https://review.openstack.org/256939
    [config-ref] Improvements for hp-msa-driver

Gerrit topic: https://review.openstack.org/#q,topic:markup,n,z

Addressed by: https://review.openstack.org/256943
    [config-ref] Improvements for netapp-volume-driver

Gerrit topic: https://review.openstack.org/#q,topic:fix-markup,n,z

Addressed by: https://review.openstack.org/256945
    [config-ref] RST markup improvements for block-storage drivers

Gerrit topic: https://review.openstack.org/#q,topic:fix-imp,n,z

Addressed by: https://review.openstack.org/256922
    [config-ref] Improvements in dell-storagecenter-driver

Gerrit topic: https://review.openstack.org/#q,topic:develop,n,z

Addressed by: https://review.openstack.org/256927
    [config-ref] Improvements of drivers using rst mark-ups

Gerrit topic: https://review.openstack.org/#q,topic:improve,n,z

Addressed by: https://review.openstack.org/256925
    [config-ref] Small improvements for emc-xtremio-driver

Addressed by: https://review.openstack.org/256953
    [config-ref] Improvements in shared file systems drivers

Addressed by: https://review.openstack.org/257276
    [config-ref] Migrate dothill-driver.xml to rst

Addressed by: https://review.openstack.org/257347
    [config-ref] Migrate emc-scaleio-driver.xml to rst

Addressed by: https://review.openstack.org/257569
    WIP [config-ref-rst] Convert Huawei driver to RST

Addressed by: https://review.openstack.org/257986
    WIP[config-ref-rst] Convert Huawei storage drivers to RST

Addressed by: https://review.openstack.org/258998
    [config-ref] Convert the EMC VMAX driver to RST

Addressed by: https://review.openstack.org/259807
    [autohelp] config-ref-rst moves to config-reference

Addressed by: https://review.openstack.org/259889
    [config-ref] Publish the RST version

Addressed by: https://review.openstack.org/259908
    Setup RST config-reference for translations

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.