Skip to content

[Docs] ES UI form library#78654

Closed
sebelga wants to merge 39 commits intoelastic:masterfrom
sebelga:docs/es-ui-shared-2
Closed

[Docs] ES UI form library#78654
sebelga wants to merge 39 commits intoelastic:masterfrom
sebelga:docs/es-ui-shared-2

Conversation

@sebelga
Copy link
Copy Markdown
Contributor

@sebelga sebelga commented Sep 28, 2020

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

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

Copy link
Copy Markdown
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/style_fields.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/style_fields.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/style_fields.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/style_fields.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/validation.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/validation.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/validation.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/react_to_changes.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/react_to_changes.md Outdated
Copy link
Copy Markdown
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/fields_composition.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/fields_composition.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/fields_composition.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/fields_composition.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/fields_composition.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/dynamic_fields.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/serializers_deserializers.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/serializers_deserializers.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md
Copy link
Copy Markdown
Contributor

@alisonelizabeth alisonelizabeth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/default_value.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/field_hook.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/field_hook.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/field_hook.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/form_hook.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/form_hook.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/form_hook.md
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/use_array.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/use_array.md Outdated
Copy link
Copy Markdown
Contributor

@alisonelizabeth alisonelizabeth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/use_field.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/use_field.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/use_field.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/use_field.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/use_field.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/dynamic_fields.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/react_to_changes.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/react_to_changes.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/serializers_deserializers.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/getting_started/about.md Outdated
Copy link
Copy Markdown
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 🍻

Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/about.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/core/default_value.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/style_fields.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/examples/validation.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/helpers/components.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/helpers/components.md Outdated
Comment thread src/plugins/es_ui_shared/docs/docs/form_lib/helpers/validators.md Outdated
sebelga and others added 18 commits October 5, 2020 16:20
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>
@cjcenizal cjcenizal mentioned this pull request Nov 6, 2020
@lukeelmers lukeelmers added the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// label Dec 30, 2020
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/es-ui (Team:Elasticsearch UI)

Copy link
Copy Markdown
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. 👏

sebelga and others added 5 commits February 18, 2021 12:18
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>
@sebelga
Copy link
Copy Markdown
Contributor Author

sebelga commented Feb 18, 2021

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.

@sebelga sebelga closed this Feb 18, 2021
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 18, 2021

💔 Build Failed

Failed CI Steps

Metrics [docs]

‼️ ERROR: metrics for 422479b were not reported

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t//

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants