Update Comment List Docs

[BSFishy]

Signed-off-by: Matt Provost [email protected]

Description

Update docs for comment list to match the changes prescribed in the issue

Issues Resolved

#243

Check List

• New functionality includes testing.
• New functionality has been documented.
• All tests pass
  • yarn lint
  • yarn test-unit
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[KrooshalUX]

LGTM

[seanneumann]

👍

[opensearch-trigger-bot]

The backport to 1.0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.0 1.0
# Navigate to the new working tree
cd .worktrees/backport-1.0
# Create a new branch
git switch --create backport/backport-252-to-1.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 3f136e1531ebea3a52cb680e82d5e08db5db613e
# Push it to GitHub
git push --set-upstream origin backport/backport-252-to-1.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.0

Then, create a pull request where the base branch is 1.0 and the compare/head branch is backport/backport-252-to-1.0.

[opensearch-trigger-bot]

The backport to failed failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-failed failed
# Navigate to the new working tree
cd .worktrees/backport-failed
# Create a new branch
git switch --create backport/backport-252-to-failed
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 3f136e1531ebea3a52cb680e82d5e08db5db613e
# Push it to GitHub
git push --set-upstream origin backport/backport-252-to-failed
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-failed

Then, create a pull request where the base branch is failed and the compare/head branch is backport/backport-252-to-failed.

[joshuarrrr]

backported in #872