|
|
Line 200: |
Line 200: |
| | | |
| I'm going to do the migration work with pandoc and propose the patch to the project's repo. Be on the lookout for those patches. | | I'm going to do the migration work with pandoc and propose the patch to the project's repo. Be on the lookout for those patches. |
− |
| |
− | === Configuration Reference Guide Migration ===
| |
− |
| |
− | Sign up below for a chapter, then create a patch with RST in doc/config-ref-rst/source for others to review. While the Config Ref Specialty team will be giving the conversion attention, contributions are welcome.
| |
− |
| |
− | {| class="wikitable"
| |
− | |-
| |
− | ! Chapter/Section (old filename) !! Chapter/Section (new filename) !! Name !! Patch URL !! Status
| |
− | |-
| |
− | | app_firewalls-ports.xml || firewalls-default-ports.rst || Gauvain Pocentek || https://review.openstack.org/245419/ || Merged
| |
− | |-
| |
− | | app_policy_json.xml || policy-json-file.rst || France Berteloot || https://review.openstack.org/245221/ || Merged
| |
− | |-
| |
− | | bk-config-ref.xml || index.rst || Gauvain Pocentek || https://review.openstack.org/242809/ || Merged
| |
− | |-
| |
− | | block-storage/backup/ceph-backup-driver.xml || block-storage/backup/ceph-backup-driver.rst || Gauvain Pocentek || https://review.openstack.org/249170 || Merged
| |
− | |-
| |
− | | block-storage/backup/nfs-backup-driver.xml || block-storage/backup/nfs-backup-driver.rst || Gauvain Pocentek || https://review.openstack.org/249170 || Merged
| |
− | |-
| |
− | | block-storage/backup/swift-backup-driver.xml || block-storage/backup/swift-backup-driver.rst || Gauvain Pocentek || https://review.openstack.org/249170 || Merged
| |
− | |-
| |
− | | block-storage/backup/tsm-backup-driver.xml || block-storage/backup/tsm-backup-driver.rst || Gauvain Pocentek || https://review.openstack.org/249170 || Merged
| |
− | |-
| |
− | | block-storage/drivers/blockbridge-eps-driver.xml || block-storage/drivers/blockbridge-eps-driver.rst || France Berteloot || https://review.openstack.org/251462/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/ceph-rbd-volume-driver.xml || block-storage/drivers/ceph-rbd-volume-driver.rst || France Berteloot || https://review.openstack.org/251475/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/dell-equallogic-driver.xml || block-storage/drivers/dell-equallogic-driver.rst || Gauvain Pocentek || https://review.openstack.org/256633 || Merged
| |
− | |-
| |
− | | block-storage/drivers/dell-storagecenter-driver.xml || block-storage/drivers/dell-storagecenter-driver.rst || Gauvain Pocentek || https://review.openstack.org/256633 || Merged
| |
− | |-
| |
− | | block-storage/drivers/dothill-driver.xml || block-storage/drivers/dothill-driver.xml || France Berteloot|| https://review.openstack.org/#/c/257276/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/emc-scaleio-driver.xml || block-storage/drivers/emc-scaleio-driver.rst || France Berteloot || https://review.openstack.org/#/c/257347/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/emc-vmax-driver.xml || block-storage/drivers/emc-vmax-driver.xml || Gauvain Pocentek || https://review.openstack.org/#/c/258998/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/emc-vnx-driver.xml || block-storage/drivers/emc-vnx-driver.rst || Gauvain Pocentek || https://review.openstack.org/255977 || Merged
| |
− | |-
| |
− | | block-storage/drivers/emc-xtremio-driver.xml || block-storage/drivers/emc-xtremio-driver.rst || Gauvain Pocentek || https://review.openstack.org/255932 || Merged
| |
− | |-
| |
− | | block-storage/drivers/glusterfs-driver.xml || block-storage/drivers/glusterfs-driver.rst || KATO Tomoyuki || https://review.openstack.org/255068/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/hds-hnas-driver.xml || block-storage/drivers/hds-hnas-driver.rst || KATO Tomoyuki || https://review.openstack.org/#/c/255247/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/hitachi-storage-volume-driver.xml || block-storage/drivers/hitachi-storage-volume-driver.rst || KATO Tomoyuki || https://review.openstack.org/255066/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/hpe-3par-driver.xml || block-storage/drivers/hpe-3par-driver.rst || Njira Perci || https://review.openstack.org/255257/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/hpe-lefthand-driver.xml || block-storage/drivers/hpe-lefthand-driver.rst || Njira Perci || https://review.openstack.org/256601 || Merged
| |
− | |-
| |
− | | block-storage/drivers/hp-msa-driver.xml || block-storage/drivers/hp-msa-driver.rst || Njira Perci || https://review.openstack.org/255206/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/huawei-storage-driver.xml || block-storage/drivers/huawei-storage-driver.rst || Njira Perci || https://review.openstack.org/257986/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/ibm-flashsystem-volume-driver.xml || block-storage/drivers/ibm-flashsystem-volume-driver.rst || Linette Williams || https://review.openstack.org/255954 || Merged
| |
− | |-
| |
− | | block-storage/drivers/ibm-gpfs-volume-driver.xml || block-storage/drivers/ibm-gpfs-volume-driver.rst || Linette Williams || https://review.openstack.org/254297 || Merged
| |
− | |-
| |
− | | block-storage/drivers/ibm-sonas-7k-driver.xml || block-storage/drivers/ibm-sonas-7k-driver.rst || Linette Williams || https://review.openstack.org/254356 || Merged
| |
− | |-
| |
− | | block-storage/drivers/ibm-storwize-svc-driver.xml || block-storage/drivers/ibm-storwize-svc-driver.rst || Linette Williams || https://review.openstack.org/254375/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/ibm-xiv-volume-driver.xml || block-storage/drivers/ibm-xiv-volume-driver.rst || Linette Williams || https://review.openstack.org/254390/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/lenovo-driver.xml || block-storage/drivers/lenovo-driver.rst || Linette Williams || https://review.openstack.org/255454 || Merged
| |
− | |-
| |
− | | block-storage/drivers/lvm-volume-driver.xml || block-storage/drivers/lvm-volume-driver.rst || Gauvain Pocentek || https://review.openstack.org/254925 || Merged
| |
− | |-
| |
− | | block-storage/drivers/netapp-volume-driver.xml || block-storage/drivers/netapp-volume-driver.rst || Gauvain Pocentek || https://review.openstack.org/254948 || Merged
| |
− | |-
| |
− | | block-storage/drivers/nfs-volume-driver.xml || block-storage/drivers/nfs-volume-driver.rst || KATO Tomoyuki || https://review.openstack.org/254763/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/nimble-volume-driver.xml || block-storage/drivers/nimble-volume-driver.rst || KATO Tomoyuki || https://review.openstack.org/254219/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/prophetstor-dpl-driver.xml || block-storage/drivers/prophetstor-dpl-driver.rst || KATO Tomoyuki || https://review.openstack.org/254209/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/pure-storage-driver.xml || block-storage/drivers/pure-storage-driver.rst || Njira Perci || https://review.openstack.org/254251/ || Merged
| |
− | |-
| |
− | | block-storage/drivers/quobyte-driver.xml || block-storage/drivers/quobyte-driver.rst || Gauvain Pocentek || https://review.openstack.org/253943 || Merged
| |
− | |-
| |
− | | block-storage/drivers/scality-sofs-driver.xml || block-storage/drivers/scality-sofs-driver.rst || Gauvain Pocentek || https://review.openstack.org/253942 || Merged
| |
− | |-
| |
− | | block-storage/drivers/sheepdog-driver.xml || block-storage/drivers/sheepdog-driver.rst || Gauvain Pocentek || https://review.openstack.org/253941 || Merged
| |
− | |-
| |
− | | block-storage/drivers/smbfs-volume-driver.xml || block-storage/drivers/smbfs-volume-driver.rst || Gauvain Pocentek || https://review.openstack.org/253939 || Merged
| |
− | |-
| |
− | | block-storage/drivers/solidfire-volume-driver.xml || block-storage/drivers/solidfire-volume-driver.rst || Gauvain Pocentek || https://review.openstack.org/253938 || Merged
| |
− | |-
| |
− | | block-storage/drivers/tintri-volume-driver.xml || block-storage/drivers/tintri-volume-driver.rst || Gauvain Pocentek || https://review.openstack.org/253936 || Merged
| |
− | |-
| |
− | | block-storage/drivers/violin-v6000-driver.xml || block-storage/drivers/violin-v6000-driver.rst || Gauvain Pocentek || https://review.openstack.org/253932 || Merged
| |
− | |-
| |
− | | block-storage/drivers/violin-v7000-driver.xml || block-storage/drivers/violin-v7000-driver.rst || Gauvain Pocentek || https://review.openstack.org/253932 || Merged
| |
− | |-
| |
− | | block-storage/drivers/vmware-vmdk-driver.xml || block-storage/drivers/vmware-vmdk-driver.rst || Gauvain Pocentek || https://review.openstack.org/253841 || Merged
| |
− | |-
| |
− | | block-storage/drivers/windows-iscsi-volume-driver.xml || block-storage/drivers/windows-iscsi-volume-driver.rst || Gauvain Pocentek || https://review.openstack.org/253841 || Merged
| |
− | |-
| |
− | | block-storage/drivers/xio-volume-driver.xml || block-storage/drivers/xio-volume-driver.rst || Gauvain Pocentek || https://review.openstack.org/253841 || Merged
| |
− | |-
| |
− | | block-storage/drivers/zfssa-iscsi-driver.xml || block-storage/drivers/zfssa-iscsi-driver.rst || Gauvain Pocentek || https://review.openstack.org/253841 || Merged
| |
− | |-
| |
− | | block-storage/drivers/zfssa-nfs-driver.xml || block-storage/drivers/zfssa-nfs-driver.rst || Gauvain Pocentek || https://review.openstack.org/253841 || Merged
| |
− | |-
| |
− | | block-storage/section_backup-drivers.xml || block-storage/backup-drivers.rst || Gauvain Pocentek || https://review.openstack.org/249170 || Merged
| |
− | |-
| |
− | | block-storage/section_block-storage-overview.xml || block-storage-overview.rst || France Berteloot || https://review.openstack.org/246824/ || Merged
| |
− | |-
| |
− | | block-storage/section_block-storage-sample-configuration-files.xml || block-storage-sample-configuration-files.rst || France Berteloot || https://review.openstack.org/251766/ || Merged
| |
− | |-
| |
− | | block-storage/section_cinder-log-files.xml || cinder-log-files.rst || France Berteloot || https://review.openstack.org/249691/ || Merged
| |
− | |-
| |
− | | block-storage/section_fc-zoning.xml || fc-zoning.rst || France Berteloot || https://review.openstack.org/249899/ || Merged
| |
− | |-
| |
− | | block-storage/section_misc.xml || volume-misc.rst || France Berteloot || https://review.openstack.org/251375 || Merged
| |
− | |-
| |
− | | block-storage/section_volume-drivers.xml || volume-drivers.rst || France Berteloot || https://review.openstack.org/247684 || Merged
| |
− | |-
| |
− | | block-storage/section_volume-encryption.xml || block-storage/volume-encryption.rst|| Andreas Jaeger || https://review.openstack.org/251101 || Merged
| |
− | |-
| |
− | | ch_baremetalconfigure.xml || baremetal.rst || Gauvain Pocentek || https://review.openstack.org/246770 || Merged
| |
− | |-
| |
− | | ch_blockstorageconfigure.xml || block-storage.rst || France Berteloot || https://review.openstack.org/245888/ || Merged
| |
− | |-
| |
− | | ch_computeconfigure.xml || compute.rst || KATO Tomoyuki || https://review.openstack.org/245523/ || Merged
| |
− | |-
| |
− | | ch_config-overview.xml || config-overview.rst || KATO Tomoyuki || https://review.openstack.org/243612/ || Merged
| |
− | |-
| |
− | | ch_dashboardconfigure.xml || dashboard-configure.rst || KATO Tomoyuki || https://review.openstack.org/254129/ || Merged
| |
− | |-
| |
− | | ch_databaseserviceconfigure.xml || databaseservice-configure.rst || Gauvain Pocentek || https://review.openstack.org/254112 || Merged
| |
− | |-
| |
− | | ch_dataprocessingserviceconfigure.xml || dataprocess-configure.rst || Gauvain Pocentek || https://review.openstack.org/254100 || Merged
| |
− | |-
| |
− | | ch_identityconfigure.xml || identity.rst || Gauvain Pocentek || https://review.openstack.org/254093 || Merged
| |
− | |-
| |
− | | ch_imageservice.xml || image-service.rst || Gauvain Pocentek || https://review.openstack.org/254053 || Merged
| |
− | |-
| |
− | | ch_networkingconfigure.xml || networking.rst ||Andreas Jaeger|| https://review.openstack.org/251056 || Merged
| |
− | |-
| |
− | | ch_objectstorageconfigure.xml || object-storage.rst || Gauvain Pocentek || https://review.openstack.org/254275 || Merged
| |
− | |-
| |
− | | ch_orchestrationconfigure.xml || orchestration.rst || Gauvain Pocentek || https://review.openstack.org/253954 || Merged
| |
− | |-
| |
− | | ch_sharedfilesystemsconfigure.xml || shared-file-systems.rst || Gauvain Pocentek || https://review.openstack.org/249613/ || Merged
| |
− | |-
| |
− | | ch_telemetryconfigure.xml || telemetry.rst || Andreas Jaeger ||https://review.openstack.org/251056 || Merged
| |
− | |-
| |
− | | ../common/section_compute_config-api.xml || compute/api.rst || KATO Tomoyuki || https://review.openstack.org/251774/ || Merged
| |
− | |-
| |
− | | ../common/section_compute-configure-ec2.xml || compute/ec2-api.rst || KATO Tomoyuki || https://review.openstack.org/251774/ || Merged
| |
− | |-
| |
− | | ../common/section_dashboard-configure.xml || dashboard/configure.rst || KATO Tomoyuki || https://review.openstack.org/254666/ || Merged
| |
− | |-
| |
− | | ../common/section_dashboard-customizing.xml || dashboard/customize.rst || KATO Tomoyuki || https://review.openstack.org/254697/ || Merged
| |
− | |-
| |
− | | ../common/section_fibrechannel.xml || compute/fibre-channel.rst || KATO Tomoyuki || https://review.openstack.org/252404/ || Merged
| |
− | |-
| |
− | | ../common/section_config_format.xml || config-format.rst || KATO Tomoyuki || https://review.openstack.org/243612/ || Merged
| |
− | |-
| |
− | | compute/samples/cells-resp.json || compute/cells.rst || KATO Tomoyuki || https://review.openstack.org/250828/ || Merged
| |
− | |-
| |
− | | compute/section_compute-cells.xml || compute/cells.rst || KATO Tomoyuki || https://review.openstack.org/250828/ || Merged
| |
− | |-
| |
− | | compute/section_compute-conductor.xml || compute/conductor.rst || KATO Tomoyuki || https://review.openstack.org/250732/ || Merged
| |
− | |-
| |
− | | compute/section_compute-config-samples.xml || compute/config-samples.rst || KATO Tomoyuki || https://review.openstack.org/250605/ || Merged
| |
− | |-
| |
− | | compute/section_compute-configure-db.xml || compute/database-connections.rst || KATO Tomoyuki || https://review.openstack.org/251167/ || Merged
| |
− | |-
| |
− | | compute/section_compute-configure-xapi.xml || compute/hypervisor-xen-api.rst || KATO Tomoyuki || https://review.openstack.org/253384/ || Merged
| |
− | |-
| |
− | | compute/section_compute-configure-backing-storage.xml || compute/hypervisor-kvm.rst || Gauvain Pocentek || https://review.openstack.org/#/c/256643/ || Merged
| |
− | |-
| |
− | | compute/section_compute-hypervisors.xml || compute/hypervisors.rst || KATO Tomoyuki || https://review.openstack.org/252200/ || Merged
| |
− | |-
| |
− | | compute/section_compute-iscsioffload.xml || compute/iscsi-offload.rst || KATO Tomoyuki || https://review.openstack.org/252404/ || Merged
| |
− | |-
| |
− | | compute/section_compute-options-reference.xml || compute/config-options.rst || KATO Tomoyuki || https://review.openstack.org/248453/ || Merged
| |
− | |-
| |
− | | compute/section_compute-sample-configuration-files.xml || compute/config-samples.rst || KATO Tomoyuki || https://review.openstack.org/248453/ || Merged
| |
− | |-
| |
− | | compute/section_compute-scheduler.xml || compute/scheduler.rst || KATO Tomoyuki || https://review.openstack.org/251000/ || Merged
| |
− | |-
| |
− | | compute/section_hypervisor_hyper-v.xml || compute/hyper-v.rst || KATO Tomoyuki || https://review.openstack.org/252408/ || Merged
| |
− | |-
| |
− | | compute/section_hypervisor_kvm.xml || compute/hypervisor-kvm.rst || KATO Tomoyuki || https://review.openstack.org/252427/ || Merged
| |
− | |-
| |
− | | compute/section_hypervisor_lxc.xml || compute/hypervisor-lxc.rst || KATO Tomoyuki || https://review.openstack.org/252997/ || Merged
| |
− | |-
| |
− | | compute/section_hypervisor_qemu.xml || compute/hypervisor-qemu.rst || KATO Tomoyuki || https://review.openstack.org/252714/ || Merged
| |
− | |-
| |
− | | compute/section_hypervisor_vmware.xml || compute/hypervisor-vmware.rst || KATO Tomoyuki || https://review.openstack.org/253341/ || Merged
| |
− | |-
| |
− | | compute/section_hypervisor_xen_api.xml || compute/hypervisor-xen-api.rst || KATO Tomoyuki || https://review.openstack.org/253384/ || Merged
| |
− | |-
| |
− | | compute/section_hypervisor_xen_libvirt.xml || compute/hypervisor-xen-libvirt.rst || KATO Tomoyuki || https://review.openstack.org/253440/ || Merged
| |
− | |-
| |
− | | compute/section_nova-conf.xml || compute/nova-conf.rst|| KATO Tomoyuki || https://review.openstack.org/245523/ || Merged
| |
− | |-
| |
− | | compute/section_nova-log-files.xml || compute/nova-logs.rst || KATO Tomoyuki || https://review.openstack.org/250578/ || Merged
| |
− | |-
| |
− | | compute/section_rpc.xml || compute/rpc.rst || KATO Tomoyuki || https://review.openstack.org/251167/ || Merged
| |
− | |-
| |
− | | compute/section_xapi-ami-setup.xml || compute/hypervisor-xen-api.rst || KATO Tomoyuki || https://review.openstack.org/253384/ || Merged
| |
− | |-
| |
− | | compute/section_xapi-install-plugins.xml || compute/hypervisor-xen-api.rst || KATO Tomoyuki || https://review.openstack.org/253384/ || Merged
| |
− | |-
| |
− | | compute/section_xapi-install.xml || compute/hypervisor-xen-api.rst || KATO Tomoyuki || https://review.openstack.org/253384/ || Merged
| |
− | |-
| |
− | | compute/section_xapi-resize-setup.xml || compute/hypervisor-xen-api.rst || KATO Tomoyuki || https://review.openstack.org/253384/ || Merged
| |
− | |-
| |
− | | conf-changes/ceilometer.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/cinder.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/glance.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/heat.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/ironic.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/keystone.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/manila.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/neutron.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/nova.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/README.txt || || || || Copied
| |
− | |-
| |
− | | conf-changes/sahara.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/swift.xml || || || || Automated
| |
− | |-
| |
− | | conf-changes/trove.xml || || || || Automated
| |
− | |-
| |
− | | dashboard/section_dashboard-log-files.xml || dashboard/log-files.rst || KATO Tomoyuki || https://review.openstack.org/254742/ || Merged
| |
− | |-
| |
− | | dashboard/section_dashboard-sample-configuration-files.xml || dashboard/sample-configuration-files.rst || KATO Tomoyuki || https://review.openstack.org/254742/ || Merged
| |
− | |-
| |
− | | database-service/section-databaseservice-db.xml || database-service/databaseservice_db.rst || Andreas Jaeger ||https://review.openstack.org/251033 || Merged
| |
− | |-
| |
− | | database-service/section-databaseservice-rpc.xml || database-service/databaseservice_api.rst || Andreas Jaeger ||https://review.openstack.org/251033 || Merged
| |
− | |-
| |
− | | identity/section_keystone-sample-conf-files.xml || identity/sample-configuration-files.rst || Gauvain Pocentek || https://review.openstack.org/253953 || Merged
| |
− | |-
| |
− | | image-service/section_image-service-api.xml ||image-service/image_service_api.rst || Andreas Jaeger ||https://review.openstack.org/251037 ||Merged
| |
− | |-
| |
− | | image-service/section_image-service-backends.xml ||image-service/image_service_backends.rst ||Andreas Jaeger || https://review.openstack.org/251037|| Merged
| |
− | |-
| |
− | | image-service/section_image-service-backend-vmware.xml ||image-service/image_service_backends.rst||Andreas Jaeger || https://review.openstack.org/251037|| Merged
| |
− | |-
| |
− | | image-service/section_image-service-ISO-support.xml ||image-service/image_service_ISO_support.rst ||Andreas Jaeger ||https://review.openstack.org/251037 ||Merged
| |
− | |-
| |
− | | image-service/section_image-service-rpc.xml ||image-service/image_service_rpc.rst ||Andreas Jaeger || https://review.openstack.org/251037|| Merged
| |
− | |-
| |
− | | image-service/section_image-service-sample-configuration-files.xml || image-service/sample-configuration-files.rst || Gauvain Pocentek || https://review.openstack.org/253953 || Merged
| |
− | |-
| |
− | | networking/section_networking-log-files.xml ||networking/networking_log.rst || Andreas Jaeger || https://review.openstack.org/251103 || Merged
| |
− | |-
| |
− | | networking/section_networking-options-reference.xml || networking/networking_options_reference.rst || Andreas Jaeger || https://review.openstack.org/251103 || Merged
| |
− | |-
| |
− | | networking/section_networking-plugins-ml2.xml || networking/networking_options_reference.rst || Andreas Jaeger || || Merged
| |
− | |-
| |
− | | networking/section_networking-plugins.xml || networking/networking_options_reference.rst ||Andreas Jaeger || || Merged
| |
− | |-
| |
− | | networking/section_networking-sample-configuration-files.xml || networking/sample-configuration-files.rst || Gauvain Pocentek || https://review.openstack.org/253953 || Merged
| |
− | |-
| |
− | | networking/section_rpc-for-networking.xml || networking/networking_options_reference.rst || Andreas Jaeger|| || Merged
| |
− | |-
| |
− | | object-storage/section_configure_s3.xml || object-storage/configure-s3.rst || Gauvain Pocentek || https://review.openstack.org/254275 || Merged
| |
− | |-
| |
− | | object-storage/section_object-storage-cors.xml || object-storage/cors.rst || Gauvain Pocentek || https://review.openstack.org/254275 || Merged
| |
− | |-
| |
− | | object-storage/section_object-storage-features.xml || object-storage/features.rst || Gauvain Pocentek || https://review.openstack.org/254275 || Merged
| |
− | |-
| |
− | | object-storage/section_object-storage-general-service-conf.xml || object-storage/general-service-conf.rst || Gauvain Pocentek || https://review.openstack.org/254275 || Merged
| |
− | |-
| |
− | | object-storage/section_object-storage-listendpoints.xml || object-storage/listendpoints.rst || Gauvain Pocentek || https://review.openstack.org/254275 || Merged
| |
− | |-
| |
− | | orchestration/section_orchestration-api.xml ||orchestration/orchestration_api.rst || Andreas Jaeger || https://review.openstack.org/250655|| Merged
| |
− | |-
| |
− | | orchestration/section_orchestration-clients.xml ||orchestration/orchestration_clients.rst||Andreas Jaeger ||https://review.openstack.org/250655 ||Merged
| |
− | |-
| |
− | | orchestration/section_orchestration-rpc.xml ||orchestration/orchestration_rpc.rst||Andreas Jaeger ||https://review.openstack.org/250655 ||Merged
| |
− | |-
| |
− | | roadmap.rst || ../roadmap.rst || Andreas Jaeger ||https://review.openstack.org/251099 || Deleted
| |
− | |-
| |
− | | shared-file-systems/drivers/emc-isilon-driver.xml || shared-file-systems/drivers/emc-isilon-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/emc-vnx-driver.xml || shared-file-systems/drivers/emc-vnx-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/generic-driver.xml || shared-file-systems/drivers/generic-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/glusterfs-driver.xml || shared-file-systems/drivers/glusterfs-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/glusterfs-native-driver.xml || shared-file-systems/drivers/glusterfs-native-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/hdfs-native-driver.xml || shared-file-systems/drivers/hdfs-native-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/hp-3par-share-driver.xml || shared-file-systems/drivers/hp-3par-share-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/huawei-nas-driver.xml || shared-file-systems/drivers/huawei-nas-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/ibm-gpfs-driver.xml || shared-file-systems/drivers/ibm-gpfs-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/drivers/netapp-cluster-mode-driver.xml || shared-file-systems/drivers/netapp-cluster-mode-driver.rst || Gauvain Pocentek || https://review.openstack.org/251108 || Merged
| |
− | |-
| |
− | | shared-file-systems/section_manila-log-files.xml || shared-file-systems/log-files.rst || Gauvain Pocentek || https://review.openstack.org/249613/ || Merged
| |
− | |-
| |
− | | shared-file-systems/section_manila-misc.xml || shared-file-systems/misc.rst || Gauvain Pocentek || https://review.openstack.org/249613/ || Merged
| |
− | |-
| |
− | | shared-file-systems/section_manila-sample-configuration-files.xml || shared-file-systems/sample-configuration-files.rst || Gauvain Pocentek || https://review.openstack.org/249613/ || Merged
| |
− | |-
| |
− | | shared-file-systems/section_shared-file-systems-overview.xml || shared-file-systems/overview.rst || Gauvain Pocentek || https://review.openstack.org/249613/ || Merged
| |
− | |-
| |
− | | shared-file-systems/section_share-drivers.xml || shared-file-systems/drivers.rst || Gauvain Pocentek || https://review.openstack.org/249613/ || Merged
| |
− | |-
| |
− | | table_default-ports-peripheral-services.xml || firewalls-default-ports.rst || Gauvain Pocentek || https://review.openstack.org/#/c/245419/ || Merged
| |
− | |-
| |
− | | table_default-ports-primary-services.xml || firewalls-default-ports.rst || Gauvain Pocentek || https://review.openstack.org/#/c/245419/ || Merged
| |
− | |-
| |
− | | telemetry/section_telemetry-alarming-service-config-opts.xml ||telemetry/alarming_service_config_opts.rst ||Andreas Jaeger ||https://review.openstack.org/251034 || Merged
| |
− | |-
| |
− | | telemetry/section_telemetry-sample-configuration-files.xml || telemetry/sampl-configuration-files.rst || Gauvain Pocentek || https://review.openstack.org/251509 || Merged
| |
− | |-
| |
− | | telemetry/section_telemetry-service-config-opts.xml ||telemetry/telemetry_service_config_opts.rst||Andreas Jaeger || https://review.openstack.org/251034|| Merged
| |
− | |-
| |
− | |}
| |
| | | |
| == Completing conversion to RST == | | == Completing conversion to RST == |
Previously, we migrated the <service>-api repos from DocBook to RST. These were API reference documents that were meant for the contributor developer to know what was going into an API. So, the history of that document was forged as a specification. As projects beyond swift and nova were added, projects made similar documents. They're output to HTML at http://docs.openstack.org/api/api-specs.html. However, as we now have a <project>-specs repo, it makes sense to move to those repos. In that move, also it makes sense to migrate to RST rather than DocBook/WADL.
First title in an RST file, use equals signs above and below. Second title, use tilde. Third title, use a series of dashes. Try not to need a Heading 4 if you can help it by rewriting or reorganizing.
As a rule, we want to keep the xml:id identical so that the output HTML files do not need redirection. However, we also at the same time want to get rid of ch_ and section_ nomenclatures while going to a page-based, topical approach. So, first use the XML:ID, and if the XML:ID has ch_ or section_ in it, remove the prefix.
Use :ref: when doing cross references so that you don't have to have the exact title. This means you will have to add markup to create anchors, such as:
.. _dashboard-project-tab:
Please use the existing XML:Ids if possible for these cross references.
Also, while intersphinx is an enabled extension for many of the contributor developer docs, we don't have an intersphinx requirement yet for the end user guide or admin user guide. We'll investigate that as we add more guides.
Store the figures in a /figures/ directory with the deliverable itself.
If the conversion outputs Note as a heading, change it to use the .. note:: directive.
If your file has lots of code blocks, be sure to set up line numbering for the entire file. Each code-block must have :linenos: after the .. code-block:: directive, the code itself must be indented at the same level as the :lineos: line, and you must have at the start of the file this directive:
so that any code-blocks longer than five lines long will have line numbers.
Can you have line breaks in something with inline semantic markup like :guilabel: at the end of the line? For example:
That line is longer than 79 characters, so Attachments`. must be on the second line, but when you do that, the HTML output is incorrect.
Since RST documents impose a 79 character limit when building files in .rst format. When tables exceed that limit, a list table role can help create content in a new table without exceeding the character limit. The issue is when a table is generated by an OpenStack service, and returned as a result of a command. These tables are constructed with +, -, and | characters. The table created by a list table role has solid lines forming rows, columns, and cells. The content is similar, however users might be surprised by a table with solid lines rather than a table built with +, -, and | characters.
Large scale content inside tables.
When building tables with a list table role, some items that appear inside the table cells might exceed the 79 character limit. Is there a solution to recreating this large scale content in a table such that it does not affect the character limit?
The :orphan: role and references.
Files with an :orphan: role at the top of the file, not included in the toc tree, will not link to another file when the :ref: role is used to link to the file from a different file. Is there a solution to this linking issue?
Pandoc conversion problems.
When converting files with Pandoc, some entries in the .xml file will not convert accurately. Procedure titles and sub section titles will not parse correctly, and will be deleted from the converted document. Pandoc also removes procedure numbering. Currently, the solution is to compare the complete .rst file to the built .xml version, and check the headings, subheadings, and procedure numbers to make sure they are correct, and line up with original. This is an issue that could also be discussed.
Because Sphinx builds have dependent requirements it is best to work with in a virtual environment. Fortunately the openstack-manuals project already has tox set up so that you can create a virtualenv that contains the required dependencies. To use it, do this on a Mac or Ubuntu machine with Python and pip already installed:
Your prompt should now have (py27) as a preface.
Now you have all the pre-requisites installed and can run additional tox commands. To see the list of commands, view or edit tox.ini in the openstack-manuals directory. To build the RST docs, run:
This will run sphinx-build doc/playground-user-guide/source/ doc/playground-user-guide/build/html.
When the build is finished, you can open doc/playground-user-guide/build/html/index.html to view the resulting output.
For the Mitaka release, we are migrating the Configuration Reference Guide and the Architecture Design Guide. Refer to the detailed specification for details.
The Juno projects where this document needs to migrate to a specification are:
nova (compute-api) v2, v3
swift (object-api) v1
glance (image-api) v1, v1.1, v2
keystone (identity-api) v2.0, v3
neutron (netconn-api) v1.0, v2.0
cinder (volume-api) v1.0, v2.0
Juno projects that have this type of document in a separate <service>-api repo are:
trove (trove)
Juno projects that do not provide this type of prose-based spec for their API are:
ceilometer
heat
sahara
Incubating projects, this information is just a heads-up so you know how we're thinking about API documentation going forward.
ironic
zaqar (marconi)
barbican
designate
I'm going to do the migration work with pandoc and propose the patch to the project's repo. Be on the lookout for those patches.
Once we have reviewed the draft guide and think it's ready to publish, we need to do the following steps: