Skip to content

/ gutenberg Public

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

Jump to bottom

Update LinkControl documentation with additional examples #35199

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from
Open

Update LinkControl documentation with additional examples #35199

wants to merge 4 commits into from
+40 −14

Conversation

@mkaz
Copy link
Member

@mkaz mkaz commented Sep 29, 2021 •
edited

Description

  • Remove history section, no longer needed and the relationship to
    <URLInput> section has the details a developer would need when using
    the control.

  • Add example for disable settings

  • Add example for suggestionQuery

  • Clarify docs that it works with Posts and Pages

How has this been tested?

Documentation. Confirm examples work and make sense.
@mkaz
Update LinkControl documentation with additional examples
5edb944 
- Remove history section, no longer needed and the relationship to
  `<URLInput>` section has the details a developer would need when using
  the control.

- Add example for disable settings

- Add example for suggestionQuery

- Clarify docs that it works with Posts and Pages
@mkaz mkaz requested a review from getdave Sep 29, 2021
@mkaz mkaz requested a review from ellatrix as a code owner Sep 29, 2021
getdave
getdave requested changes Sep 29, 2021
View changes
Copy link
Contributor

@getdave getdave left a comment

Thanks for following up. Left some nits and suggestions (and one plea 🙏 ).

packages/block-editor/src/components/link-control/README.md Outdated Show resolved Hide resolved
packages/block-editor/src/components/link-control/README.md Outdated Show resolved Hide resolved
packages/block-editor/src/components/link-control/README.md Show resolved Hide resolved
packages/block-editor/src/components/link-control/README.md Show resolved Hide resolved
packages/block-editor/src/components/link-control/README.md Outdated Show resolved Hide resolved
mkaz and others added 3 commits Sep 29, 2021
@mkaz @getdave
Apply suggestions from code review
4648ad9 
Co-authored-by: Dave Smith <[email protected]>
@mkaz
Add history section back at bottom, with reference
7088da6
@mkaz
Switch phrase to post-type entities to cover beyond just Post/Page
55f7b7f
@mkaz
Copy link
Member Author

@mkaz mkaz commented Sep 29, 2021

@getdave I updated with your suggestions and added back the History section at the bottom. 👍

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

@getdave getdave

@ellatrix ellatrix

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
[Package] Block editor [Type] Documentation
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
@mkaz @getdave