Add warning about truncation to ML documentation#11981
Conversation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
requested review from
AMoo-Miki,
dlvenable,
epugh,
natebower and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
|
@ylwu-amzn Could you review this PR? |
peterzhuamazon
left a comment
peterzhuamazon
left a comment
There was a problem hiding this comment.
Since all these three paragraph are talking about similar things, shall we have a unified paragraph for all of them?
These 3 paragraphs are formatted as a warning and placed in 3 different pages so users are aware of this limitation no matter where in the documentation they are. The alternative is to use one warning and link to it from the 2 other files, but this creates a disjointed experience for the users because they have to navigate between several pages. I think it's better to leave the 3 warnings as is. |
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
|
@peterzhuamazon I unified the text of all 3 warnings. |
* Add warning about truncation to ML documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestion from @kolchfa-aws Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> (cherry picked from commit 2ed960b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
…11981) * Add warning about truncation to ML documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestion from @kolchfa-aws Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
3 participants
Closes #7365
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.