Skip to content
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

Document updating the consent string to unlock private APIs. #55235

Merged

Conversation

peterwilsoncc
Copy link
Contributor

What?

Documenting the process for updating the consent string to unlock access to private APIs.

Why?

The consent string is intended to be updated on a regular basis.

How?

I've put it in the package's readme file for now, please advise if it should be moved elsewhere.

Testing Instructions

N/A: Docs change.

Testing Instructions for Keyboard

N/A: Docs change.

Screenshots or screencast

N/A: Docs change.

@peterwilsoncc peterwilsoncc added [Type] Developer Documentation Documentation for developers [Type] Copy Issues or PRs that need copy editing assistance [Package] Private APIs /packages/private-apis labels Oct 11, 2023
@peterwilsoncc peterwilsoncc self-assigned this Oct 11, 2023
@github-actions
Copy link

Warning: Type of PR label error

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
  • Labels found: [Type] Developer Documentation, [Type] Copy, [Package] Private APIs.

Read more about Type labels in Gutenberg.

@peterwilsoncc peterwilsoncc removed the [Type] Copy Issues or PRs that need copy editing assistance label Oct 11, 2023
@peterwilsoncc peterwilsoncc marked this pull request as ready for review October 11, 2023 01:04
Copy link
Contributor

@andrewserong andrewserong 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 updating the docs for this! This is reading well for me and matches the discussions in #49784 and #55182.

Just left a couple of tiny comments related to numbering of the lists, but otherwise LGTM! ✨

packages/private-apis/README.md Outdated Show resolved Hide resolved
packages/private-apis/README.md Outdated Show resolved Hide resolved
Co-authored-by: Andrew Serong <14988353+andrewserong@users.noreply.github.com>
@github-actions
Copy link

Flaky tests detected in 53552fe.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6488677634
📝 Reported issues:

Copy link
Contributor

@adamziel adamziel left a comment

Choose a reason for hiding this comment

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

Looks great to me and I think this is the right place for this note. It's for Gutenberg maintainers working with the private-apis package and not for folks just looking for usage examples in handbook. Thank you!

Perhaps this could also be documented in the release checklist at https://make.wordpress.org/core/handbook/about/release-cycle/block-editor-release-process-for-major-releases/?

@peterwilsoncc
Copy link
Contributor Author

Perhaps this could also be documented in the release checklist at https://make.wordpress.org/core/handbook/about/release-cycle/block-editor-release-process-for-major-releases/?

I'll add something to the private APIs section of the page.

Am I correct in thinking the page is managed directly in the handbook rather than via a markdown to HTML converter?

@peterwilsoncc peterwilsoncc merged commit b1b2974 into trunk Oct 15, 2023
49 checks passed
@peterwilsoncc peterwilsoncc deleted the docs/document-updating-private-api-consent-string branch October 15, 2023 22:19
@github-actions github-actions bot added this to the Gutenberg 16.9 milestone Oct 15, 2023
@adamziel
Copy link
Contributor

Am I correct in thinking the page is managed directly in the handbook rather than via a markdown to HTML converter?

Yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Private APIs /packages/private-apis [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants