OpenSDN master
  • Site
    • Release Documentation
      • Getting Started with OpenSDN and Ansible Deployer
      • Getting Started with tf-devstack
      • Release Notes: OpenSDN R21.12
      • Release Notes: OpenSDN R21.05
      • Release Notes: Tungsten Fabric 5.1
        • Tungsten Fabric Release 5.1
        • Release Notes
        • Introduction
        • New and Changed Features
        • Supported Platforms Tungsten Fabric 5.1
        • Known Behavior
        • Resolved Issues
        • Deprecated Items
        • Revision History
      • Release Notes: Tungsten Fabric 5.0.1
        • Tungsten Fabric Release 5.0.1
        • Release Notes
        • Introduction
        • New and Changed Features
        • Supported Platforms Tungsten Fabric 5.0.1
        • Known Behavior
        • Resolved Issues
        • Deprecated Items
        • Self-Help Online Tools and Resources
      • Release Notes: Tungsten Fabric 5.0
        • Tungsten Fabric Release 5.0
        • Release Notes
        • Introduction
        • New and Changed Features
        • Supported Platforms Tungsten Fabric 5.0
        • Known Behavior
        • Resolved Issues
        • Deprecated Items
        • Self-Help Online Tools and Resources
    • OpenSDN Feature and Architecture Guide
      • Understanding OpenSDN
      • Understanding OpenSDN Components
      • Understanding OpenSDN Containers
      • Understanding OpenSDN microservices architecture
      • Understanding OpenSDN quotas
      • Creating Projects in OpenStack for Configuring Tenants in OpenSDN
      • Creating a Virtual Network with OpenStack OpenSDN
      • Creating an Image for a Project in OpenStack
      • Using Security Groups with Virtual Machines (Instances)
      • Using the OpenSDN Heat Template
      • Quality of Service in OpenSDN
      • Configuring Network QoS Parameters
      • Support for OpenStack LBaaS
      • Configuring Load Balancing as a Service in OpenSDN
      • Multiqueue Virtio Interfaces in Virtual Machines
      • Ceilometer Support in OpenSDN
      • Working with Neutron
    • OpenSDN Cloud-Native User Guide
      • How to Enable Keystone Authentication in a Juju Cluster within a Kubernetes Environment
      • Stickiness for Load-Balanced Flows
      • How to Upgrade OpenSDN Through Kubernetes and/or Red Hat OpenShift
      • How to Enable Virtualization with KubeVirt in Environments Using Kubernetes with a OpenSDN cluster
      • vRouter Dynamic MAC/IP Address Learning and BFD
    • OpenSDN Service Provider Focused Features Guide
      • Optimizing DPDK vRouter Performance Through Full CPU Partitioning and Isolation
      • OpenSDN DPDK vRouter Support for Intel DDP Technology in Fortville NICs
      • OpenSDN vRouter MAC Address - IP Address Learning and Bidirectional Forwarding and Detection Health Checking for Pods on Virtual Machines
      • Layer 3 Multihoming
      • Remote Compute
      • Routing Policy
      • Retaining the AS Path Attribute in a Service Chain
      • Fast Routing Convergence with OpenSDN
    • OpenSDN Networking and Security User Guide
      • OpenSDN vRouter Next Hop Configuration
      • Using Static Routes with Services
    • OpenSDN Operator
      • Working with Kubernetes Operators 101
      • Deploying OpenSDN Operator
      • Development of OpenSDN Operator
      • OpenSDN Operator with Openshift 4.x
      • Testing and Debugging OpenSDN Operator
    • OpenSDN Installation and Upgrade Guide
      • Server Requirements and Supported Platforms
      • Understanding Red Hat OpenStack Platform Director
      • Setting Up the Infrastructure
      • Setting Up the Undercloud
      • Setting Up the Overcloud
      • Understanding Red Hat OpenStack Platform Director
      • Setting Up the Infrastructure
      • Setting Up the Undercloud
      • Setting Up the Overcloud
      • Using Netronome SmartNIC vRouter with OpenSDN
      • Installing OpenStack Octavia LBaaS with RHOSP in OpenSDN
      • Installing OpenSDN with OpenStack by Using Juju Charms
      • Installing OpenSDN with Kubernetes by Using Juju Charms
      • Installing OpenSDN with Kubernetes in Nested Mode by Using Juju Charms
      • Installing OpenStack Octavia LBaaS with Juju Charms in OpenSDN
      • Using Netronome SmartNIC vRouter with OpenSDN and Juju Charms
      • Configuring Role and Resource-Based Access Control
      • Configuring Role-Based Access Control for Analytics
      • Configuring the Control Node with BGP
      • Configuring MD5 Authentication for BGP Sessions
      • Configuring Transport Layer Security-Based XMPP in OpenSDN
      • Configuring Graceful Restart and Long-lived Graceful Restart
      • How to Backup and Restore OpenSDN databases in JSON Format
      • Installing OpenStack Octavia LBaaS with Juju Charms in OpenSDN
      • Configuring the Control Node with BGP
      • Installing OpenSDN with Kubernetes by Using Juju Charms
      • Installing OpenSDN with OpenStack by Using Juju Charms
      • Configuring Graceful Restart and Long-lived Graceful Restart
      • Server Requirements and Supported Platforms
      • Upgrading OpenSDN with Red Hat Openstack 13 using ISSU
      • Updating OpenSDN using the Zero Impact Upgrade Process in an Environment using Red Hat Openstack
      • How to Perform a Zero Impact OpenSDN Upgrade using the Ansible Deployer
      • Installing OpenSDN with Kubernetes in Nested Mode by Using Juju Charms
      • Configuring MD5 Authentication for BGP Sessions
      • Provisioning of Kubernetes Clusters
      • Configuring Role-Based Access Control for Analytics
      • Installing OpenStack Octavia LBaaS with RHOSP in OpenSDN
      • Configuring Role and Resource-Based Access Control
      • Setting Up the Infrastructure
      • Understanding Red Hat OpenStack Platform Director
      • Setting Up the Overcloud
      • Setting Up the Undercloud
      • Setting Up the Infrastructure
      • Understanding Red Hat OpenStack Platform Director
      • Setting Up the Overcloud
      • Setting Up the Undercloud
      • Using Netronome SmartNIC vRouter with OpenSDN
      • Updating OpenSDN using the Zero Impact Upgrade Procedure in a Canonical Openstack Deployment with Juju Charms
      • Upgrading OpenSDN using OpenSDN-ansible Deployer
      • Upgrading OpenSDN using In-Place Upgrade Procedure
      • How to Perform a Zero Impact OpenSDN Upgrade using the Ansible Deployer
      • Updating OpenSDN using the Zero Impact Upgrade Process in an Environment using Red Hat Openstack
      • Updating OpenSDN using the Zero Impact Upgrade Procedure in a Canonical Openstack Deployment with Juju Charms
      • Upgrading OpenSDN using OpenSDN-ansible Deployer
      • Upgrading OpenSDN using In-Place Upgrade Procedure
      • Upgrading OpenSDN Release 19xx with RHOSP13 to OpenSDN Release 2011 with RHOSP16.1
      • How to Backup and Restore OpenSDN databases in JSON Format
    • OpenSDN Analytics and Troubleshooting Guide
      • Encryption Between Analytics API Servers and Client Servers
      • vRouter Command Line Utilities
      • Using Contrail-Tools
      • Using Sandump Tool​
      • Using the Wireshark Plugin to Analyze Packets Between vRouter and vRouter Agent on pkt0 Interface
    • Contributing to OpenSDN
      • Contribute to OpenSDN
      • Getting Started as a Contributor
        • Getting started as a contributor
      • Processes before submitting a blueprint
      • Blueprint Submission
      • Code Submission
      • Test plan Submission
      • OpenSDN JIRA workflow
      • How to review a patch in Gerrit
      • RST conventions
        • General guidelines
        • File naming and structure
        • Titles
        • Inline elements
        • Lists
        • Specific information blocks
        • Code samples
        • References
        • Tables
        • Figures
        • Profiling
        • Comments
        • Decorations
      • Writing style
        • General writing guidelines
        • Word choice
        • Punctuation
        • Headings
        • Lists
        • URLs
        • Numbers and units of measure
        • Naming convention
        • Release names
        • Standard UI terminology
        • Code conventions
    • Infrastructure
      • OpenSDN CI
      • Infra details
      • Support of https://gerrit.opensdn.io
      • Used tools
  • Page
    • Writing style
  • « Decorations
  • General writi... »
  • Site
    • Release Documentation
      • Getting Started with OpenSDN and Ansible Deployer
      • Getting Started with tf-devstack
      • Release Notes: OpenSDN R21.12
      • Release Notes: OpenSDN R21.05
      • Release Notes: Tungsten Fabric 5.1
        • Tungsten Fabric Release 5.1
        • Release Notes
        • Introduction
        • New and Changed Features
        • Supported Platforms Tungsten Fabric 5.1
        • Known Behavior
        • Resolved Issues
        • Deprecated Items
        • Revision History
      • Release Notes: Tungsten Fabric 5.0.1
        • Tungsten Fabric Release 5.0.1
        • Release Notes
        • Introduction
        • New and Changed Features
        • Supported Platforms Tungsten Fabric 5.0.1
        • Known Behavior
        • Resolved Issues
        • Deprecated Items
        • Self-Help Online Tools and Resources
      • Release Notes: Tungsten Fabric 5.0
        • Tungsten Fabric Release 5.0
        • Release Notes
        • Introduction
        • New and Changed Features
        • Supported Platforms Tungsten Fabric 5.0
        • Known Behavior
        • Resolved Issues
        • Deprecated Items
        • Self-Help Online Tools and Resources
    • OpenSDN Feature and Architecture Guide
      • Understanding OpenSDN
      • Understanding OpenSDN Components
      • Understanding OpenSDN Containers
      • Understanding OpenSDN microservices architecture
      • Understanding OpenSDN quotas
      • Creating Projects in OpenStack for Configuring Tenants in OpenSDN
      • Creating a Virtual Network with OpenStack OpenSDN
      • Creating an Image for a Project in OpenStack
      • Using Security Groups with Virtual Machines (Instances)
      • Using the OpenSDN Heat Template
      • Quality of Service in OpenSDN
      • Configuring Network QoS Parameters
      • Support for OpenStack LBaaS
      • Configuring Load Balancing as a Service in OpenSDN
      • Multiqueue Virtio Interfaces in Virtual Machines
      • Ceilometer Support in OpenSDN
      • Working with Neutron
    • OpenSDN Cloud-Native User Guide
      • How to Enable Keystone Authentication in a Juju Cluster within a Kubernetes Environment
      • Stickiness for Load-Balanced Flows
      • How to Upgrade OpenSDN Through Kubernetes and/or Red Hat OpenShift
      • How to Enable Virtualization with KubeVirt in Environments Using Kubernetes with a OpenSDN cluster
      • vRouter Dynamic MAC/IP Address Learning and BFD
    • OpenSDN Service Provider Focused Features Guide
      • Optimizing DPDK vRouter Performance Through Full CPU Partitioning and Isolation
      • OpenSDN DPDK vRouter Support for Intel DDP Technology in Fortville NICs
      • OpenSDN vRouter MAC Address - IP Address Learning and Bidirectional Forwarding and Detection Health Checking for Pods on Virtual Machines
      • Layer 3 Multihoming
      • Remote Compute
      • Routing Policy
      • Retaining the AS Path Attribute in a Service Chain
      • Fast Routing Convergence with OpenSDN
    • OpenSDN Networking and Security User Guide
      • OpenSDN vRouter Next Hop Configuration
      • Using Static Routes with Services
    • OpenSDN Operator
      • Working with Kubernetes Operators 101
      • Deploying OpenSDN Operator
      • Development of OpenSDN Operator
      • OpenSDN Operator with Openshift 4.x
      • Testing and Debugging OpenSDN Operator
    • OpenSDN Installation and Upgrade Guide
      • Server Requirements and Supported Platforms
      • Understanding Red Hat OpenStack Platform Director
      • Setting Up the Infrastructure
      • Setting Up the Undercloud
      • Setting Up the Overcloud
      • Understanding Red Hat OpenStack Platform Director
      • Setting Up the Infrastructure
      • Setting Up the Undercloud
      • Setting Up the Overcloud
      • Using Netronome SmartNIC vRouter with OpenSDN
      • Installing OpenStack Octavia LBaaS with RHOSP in OpenSDN
      • Installing OpenSDN with OpenStack by Using Juju Charms
      • Installing OpenSDN with Kubernetes by Using Juju Charms
      • Installing OpenSDN with Kubernetes in Nested Mode by Using Juju Charms
      • Installing OpenStack Octavia LBaaS with Juju Charms in OpenSDN
      • Using Netronome SmartNIC vRouter with OpenSDN and Juju Charms
      • Configuring Role and Resource-Based Access Control
      • Configuring Role-Based Access Control for Analytics
      • Configuring the Control Node with BGP
      • Configuring MD5 Authentication for BGP Sessions
      • Configuring Transport Layer Security-Based XMPP in OpenSDN
      • Configuring Graceful Restart and Long-lived Graceful Restart
      • How to Backup and Restore OpenSDN databases in JSON Format
      • Installing OpenStack Octavia LBaaS with Juju Charms in OpenSDN
      • Configuring the Control Node with BGP
      • Installing OpenSDN with Kubernetes by Using Juju Charms
      • Installing OpenSDN with OpenStack by Using Juju Charms
      • Configuring Graceful Restart and Long-lived Graceful Restart
      • Server Requirements and Supported Platforms
      • Upgrading OpenSDN with Red Hat Openstack 13 using ISSU
      • Updating OpenSDN using the Zero Impact Upgrade Process in an Environment using Red Hat Openstack
      • How to Perform a Zero Impact OpenSDN Upgrade using the Ansible Deployer
      • Installing OpenSDN with Kubernetes in Nested Mode by Using Juju Charms
      • Configuring MD5 Authentication for BGP Sessions
      • Provisioning of Kubernetes Clusters
      • Configuring Role-Based Access Control for Analytics
      • Installing OpenStack Octavia LBaaS with RHOSP in OpenSDN
      • Configuring Role and Resource-Based Access Control
      • Setting Up the Infrastructure
      • Understanding Red Hat OpenStack Platform Director
      • Setting Up the Overcloud
      • Setting Up the Undercloud
      • Setting Up the Infrastructure
      • Understanding Red Hat OpenStack Platform Director
      • Setting Up the Overcloud
      • Setting Up the Undercloud
      • Using Netronome SmartNIC vRouter with OpenSDN
      • Updating OpenSDN using the Zero Impact Upgrade Procedure in a Canonical Openstack Deployment with Juju Charms
      • Upgrading OpenSDN using OpenSDN-ansible Deployer
      • Upgrading OpenSDN using In-Place Upgrade Procedure
      • How to Perform a Zero Impact OpenSDN Upgrade using the Ansible Deployer
      • Updating OpenSDN using the Zero Impact Upgrade Process in an Environment using Red Hat Openstack
      • Updating OpenSDN using the Zero Impact Upgrade Procedure in a Canonical Openstack Deployment with Juju Charms
      • Upgrading OpenSDN using OpenSDN-ansible Deployer
      • Upgrading OpenSDN using In-Place Upgrade Procedure
      • Upgrading OpenSDN Release 19xx with RHOSP13 to OpenSDN Release 2011 with RHOSP16.1
      • How to Backup and Restore OpenSDN databases in JSON Format
    • OpenSDN Analytics and Troubleshooting Guide
      • Encryption Between Analytics API Servers and Client Servers
      • vRouter Command Line Utilities
      • Using Contrail-Tools
      • Using Sandump Tool​
      • Using the Wireshark Plugin to Analyze Packets Between vRouter and vRouter Agent on pkt0 Interface
    • Contributing to OpenSDN
      • Contribute to OpenSDN
      • Getting Started as a Contributor
        • Getting started as a contributor
      • Processes before submitting a blueprint
      • Blueprint Submission
      • Code Submission
      • Test plan Submission
      • OpenSDN JIRA workflow
      • How to review a patch in Gerrit
      • RST conventions
        • General guidelines
        • File naming and structure
        • Titles
        • Inline elements
        • Lists
        • Specific information blocks
        • Code samples
        • References
        • Tables
        • Figures
        • Profiling
        • Comments
        • Decorations
      • Writing style
        • General writing guidelines
        • Word choice
        • Punctuation
        • Headings
        • Lists
        • URLs
        • Numbers and units of measure
        • Naming convention
        • Release names
        • Standard UI terminology
        • Code conventions
    • Infrastructure
      • OpenSDN CI
      • Infra details
      • Support of https://gerrit.opensdn.io
      • Used tools
  • Source

    Writing style¶

    This section describes general writing style guidelines that documentation contributors should follow to ensure consistency throughout all technical publications.

    • General writing guidelines
      • Use standard English
      • Write in active voice
      • Use the present simple tense
      • Write in second person
      • Use appropriate mood
      • Keep sentences short
      • Avoid ambiguous titles
      • Be clear and concise
      • Write objectively
      • Describe the most common use case first
      • Do not humanize inanimate objects
      • Write positively
      • Avoid prepositions at the end of sentences
      • Do not overuse this, that, these, and it
      • Do not split infinitives
      • Avoid personification
      • Do not use contractions
      • Eliminate needless politeness
      • Use consistent terminology
      • Use spelling and grammar checking tools
    • Word choice
    • Punctuation
    • Headings
      • General guidelines
      • Section titles
      • Subsection titles
      • Topic titles
      • Figure and table titles
    • Lists
      • Punctuation in lists
    • URLs
    • Numbers and units of measure
    • Naming convention
      • Using OpenSDNs full name and abbreviation
      • Upper- and lowercase in OpenSDN’ service and modules names
    • Release names
    • Standard UI terminology
      • Command-line interface guidelines
      • Web user interfaces guidelines
    • Code conventions

    This documentation, is a derivative of Writing style by OpenStack, used under CC BY.

    Back to top

    Source

    © Copyright 2024, OpenSDN.
    Created using Sphinx 7.2.6.