[Docs] ES UI form library #78654

sebelga · 2020-09-28T17:56:35Z

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 bootstrap
cd src/plugins/es_ui_shared/docs && yarn
From the root of the repo yarn docs
Access the form lib docs at http://localhost:3000/docs/form_lib/getting_started/about

Note: Only review the documentation of the form lib as all the rest will be discarted in favor of the new docs website.

cjcenizal

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.

src/plugins/es_ui_shared/docs/docs/form_lib/examples/style_fields.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/validation.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/react_to_changes.md

cjcenizal

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.

src/plugins/es_ui_shared/docs/docs/form_lib/examples/fields_composition.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/dynamic_fields.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/serializers_deserializers.md

src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md

alisonelizabeth

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.

src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md

src/plugins/es_ui_shared/docs/docs/form_lib/core/default_value.md

src/plugins/es_ui_shared/docs/docs/form_lib/core/field_hook.md

src/plugins/es_ui_shared/docs/docs/form_lib/core/form_hook.md

src/plugins/es_ui_shared/docs/docs/form_lib/core/use_array.md

alisonelizabeth

I finished reading through the docs! 🎉 I left a few more comments/suggestions.

src/plugins/es_ui_shared/docs/docs/form_lib/core/use_field.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/dynamic_fields.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/react_to_changes.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/serializers_deserializers.md

src/plugins/es_ui_shared/docs/docs/form_lib/getting_started/about.md

jloleysens

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 🍻

src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md

src/plugins/es_ui_shared/docs/docs/form_lib/core/default_value.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/style_fields.md

src/plugins/es_ui_shared/docs/docs/form_lib/examples/validation.md

src/plugins/es_ui_shared/docs/docs/form_lib/helpers/components.md

src/plugins/es_ui_shared/docs/docs/form_lib/helpers/validators.md

Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>