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.

Sign up for GitHub

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

Fix type docs for Notices #17206

Merged
merged 3 commits into from
Aug 30, 2019
Merged

Fix type docs for Notices #17206

merged 3 commits into from
Aug 30, 2019

Conversation

simono
Copy link
Contributor

@simono simono commented Aug 26, 2019 •
edited
Loading

Description

Fix documentation errors as explained in #17203.

Types of changes

  • fixes docs

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.

@simono simono mentioned this pull request Aug 26, 2019
Closed
@simono simono changed the title Fix/17203 notices type docs Fix #17203 Notices type docs Aug 26, 2019
@simono simono changed the title Fix #17203 Notices type docs Fix type docs for Notices Aug 26, 2019
@gziolo gziolo added [Type] Developer Documentation Documentation for developers [Package] Notices /packages/notices First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository labels Aug 27, 2019
@gziolo gziolo requested review from dsifford and ocean90 August 27, 2019 05:24
dsifford
dsifford approved these changes Aug 27, 2019
View reviewed changes
Copy link
Contributor

@dsifford dsifford left a comment

Choose a reason for hiding this comment

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

See comments.

packages/notices/src/store/actions.js Outdated Show resolved Hide resolved
@gziolo
Copy link
Member

gziolo commented Aug 30, 2019

Travis job fails. It looks like you need to run “npm run docs:build” to refresh docs.

@simono
Copy link
Contributor Author

simono commented Aug 30, 2019

Thanks for the heads-up @gziolo
The build passed now.

Just out of curiosity: Why are those generated docs in version control?

@gziolo
Copy link
Member

gziolo commented Aug 30, 2019

Just out of curiosity: Why are those generated docs in version control?

We use GitHub source to power developer docs: https://developer.wordpress.org/block-editor/data/data-core-notices/ but at the same time, you can browse them on GitHub. Ideally, bot should run npm run docs:build and add a commit to your PR when necessary. I hope we will get there one day :)

@gziolo gziolo added this to the Gutenberg 6.5 milestone Aug 30, 2019
@gziolo gziolo merged commit 1abf936 into WordPress:master Aug 30, 2019
@gziolo
Copy link
Member

gziolo commented Aug 30, 2019

Congrats on your first code contribution to Gutenberg 🎉

@simono simono deleted the fix/17203-notices-type-docs branch August 30, 2019 09:03
@simono
Copy link
Contributor Author

simono commented Aug 30, 2019

Thanks for the merge and all the help @gziolo

@chihsuan chihsuan mentioned this pull request Feb 17, 2022
Merged
@snyk-bot snyk-bot mentioned this pull request Mar 3, 2022
Open
@MaxMood96 MaxMood96 mentioned this pull request Oct 27, 2022
Open
@MaxMood96 MaxMood96 mentioned this pull request Nov 5, 2022
Open
@MaxMood96 MaxMood96 mentioned this pull request Nov 16, 2022
Open
@MaxMood96 MaxMood96 mentioned this pull request Nov 29, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dsifford dsifford dsifford approved these changes

@ocean90 ocean90 ocean90 approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra

@chrisvanpatten chrisvanpatten Awaiting requested review from chrisvanpatten

@jorgefilipecosta jorgefilipecosta Awaiting requested review from jorgefilipecosta

@mkaz mkaz Awaiting requested review from mkaz

@talldan talldan Awaiting requested review from talldan

@youknowriad youknowriad Awaiting requested review from youknowriad

Assignees
No one assigned
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Package] Notices /packages/notices [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 6.5
Development

Successfully merging this pull request may close these issues.
4 participants
@simono @gziolo @ocean90 @dsifford