Skip to content
logo
Percona Documentation Style Guide
Code descriptions
Initializing search
    percona/doc-style-guide
    percona/doc-style-guide
    • Home
    • Storytelling
      • Voice and Tone
      • Keep the Structure Simple
      • Use Cross-References Appropriately
    • Text
      • Hyphens
      • Paragraphs
      • Lists
      • Headings
      • Tables
      • Graphics
      • Callouts and admonitions
      • Code descriptions
        • Rules
        • Examples
      • SQL statement conventions
      • Links
      • Legal information
      • None
    • Grammar
      • Capitalization
      • Punctuation
      • Spelling
      • Word usage
      • Numbers
    • Writing
      • Rules for specific documentation types
    • Guidelines
    • Markup
    • Copyright and licensing
    • Trademark policy
    • Rules
    • Examples

    Code descriptions¶

    It’s recommended to split the command and its output into separate blocks

    Rules¶

    • Write code samples for package installation without -y flag
    • Don’t use screenshots for code samples. Give the ability for users to copy & paste the code
    • Use spaces, instead of tabs for indentation
    • Remove white space from the end of lines (= no trailing tabs or spaces)
    • For code samples, use the following prompts:

    Examples¶

    $> type a command here
    #> type command as root here
    mysql> type a Percona Server for MySQL statement here
    

    Contact Us

    For free technical help, visit the Percona Community Forum.

    To report bugs or submit feature requests, open a JIRA ticket.

    For paid support and managed or consulting services , contact Percona Sales.


    Last update: February 10, 2023
    Created: February 10, 2023
    Percona LLC and/or its affiliates, © 2023
    Made with Material for MkDocs