Conversation
cjcenizal
left a comment
There was a problem hiding this comment.
Thanks for putting so much effort into this, Seb! These docs have already helped me gain a much better understanding of the form lib than I previously had. I'm still working my way through the docs though, page by page, but I have a number of comments, suggestions, and questions so far.
cjcenizal
left a comment
There was a problem hiding this comment.
I just finished Core > Getting Started and wanted to share my feedback so far with you, since I will need to pause my review and shift focus to something else for the day.
alisonelizabeth
left a comment
There was a problem hiding this comment.
These docs are looking awesome @sebelga! Great work. I've left a few comments of what I've reviewed so far (mostly typo fixes). I'll continue reviewing later today and tomorrow.
alisonelizabeth
left a comment
There was a problem hiding this comment.
I finished reading through the docs! 🎉 I left a few more comments/suggestions.
jloleysens
left a comment
There was a problem hiding this comment.
Great work @sebelga !
I left comments for improvements, but don't feel you need to block on them - I like CJ's points about simplifying/clarifying some of the examples and gave one suggestion of linking to the existing "default values" documentation that I think would be nice to add.
One other comment I made was about setting of "defaultValues" and that this is something we don't want users of the library to misuse. I'd like to get your thoughts on that as perhaps you have a different view regarding that API capability.
Cheers 🍻
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com> Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
|
Pinging @elastic/es-ui (Team:Elasticsearch UI) |
cjcenizal
left a comment
There was a problem hiding this comment.
Thanks for going through all of my feedback! I will take another pass once we are using the new docs system. Great work driving this forward, Seb. 👏
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com> Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
…changes.md Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
…changes.md Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
|
Thanks for the great feedback @alisonelizabeth @cjcenizal and @jloleysens ! I addressed most of your comments and committed your suggested changes. I will now close this PR and start integrating the docs in the new doc system. |
💔 Build Failed
Failed CI Steps
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
This PR adds the documentation for the form lib.
Meanwhile I wait for the instruction from @snide for the new documentation website these are the steps to launch the current docs locally and be able to review them
yarn kbn bootstrapcd src/plugins/es_ui_shared/docs && yarnyarn docsNote: Only review the documentation of the form lib as all the rest will be discarted in favor of the new docs website.