Skip to content

Add support for *-version attributes in the docs #737

Open
@bmorelli25

Description

@bmorelli25

Summary

We need a way to globally add product versions to the docs. The product versions are primarily used in code blocks for installation instructions. Using a variable in these instructions allows us to easily update code commands as we release product updates.

This tasks requires:

  • The ability to add and enable variable substitution in code blocks
  • The ability to globally update these variables

Products identified as needing version variables:

  • {{context.stack_version}}
  • {{context.eck_version}}
  • {{context.ece_version}}
  • {{context.apm-android_version}}
  • {{context.apm-go_version}}
  • {{context.apm-os_version}}
  • {{context.apm-java_version}}
  • {{context.apm-dotnet_version}}
  • {{context.apm-nodejs_version}}
  • {{context.apm-php_version}}
  • {{context.apm-python_version}}
  • {{context.apm-ruby_version}}
  • {{context.apm-rum_version}}

Release date variables

  • {{context.90_release_date}}

Questions from writers:

  • Should writers use docset.yml variables in the meantime? The downside of this approach is that we will need to update docset.yml files in at least 30 repositories when 9.0 releases, and then again for every subsequent release.
  • Can we standardize on the above variable names (or other var names) so that writers can start updating code blocks to (1) enable substitution and (2) update to the correct variable names?

Helpful regex

This may help you find version attributes that need to be updated: \{\{([^}]*version[^}]*)\}\}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions