Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to chart node in depth doc #14057

Merged
merged 1 commit into from
Jun 6, 2023
Merged

Conversation

hwahlstrom
Copy link
Collaborator

Purpose

Improving chart node documentation for all six chart nodes based on findings from user testing. Improvements include clarifying confusing wording, adding more comprehensive information and examples, and describing input data in more detail.

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated
  • This PR contains no files larger than 50 MB

Release Notes

Improved chart node in-depth documentation by adding more detail, providing examples, and clarifying input data structures

Reviewers

@QilongTang

FYIs

@Amoursol @lillismith

@hwahlstrom hwahlstrom requested a review from QilongTang June 6, 2023 19:30
@QilongTang QilongTang added this to the 2.19.0 milestone Jun 6, 2023
@QilongTang QilongTang merged commit af4c57c into master Jun 6, 2023
@QilongTang QilongTang deleted the chart-node-doc-updates branch June 6, 2023 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants