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

Add a developer tutorial for displaying notices #13703

Merged
merged 6 commits into from
Feb 7, 2019

Conversation

danielbachhuber
Copy link
Member

Fixes #13592

mkaz
mkaz previously requested changes Feb 6, 2019
Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

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

The question I have is where to put the JavaScript code? The tutorial should include a small part of enqueue and dependencies, it might even need to include a dependency beyond wp.data so it runs after the editor is instantiated.

If it is to be a tutorial it probably should be more explicit with all steps. I would also be fine with moving it as an example part of the data-core-notices.md but the tutorial is probably more useful since the same question on where to put the code would come up.

@danielbachhuber
Copy link
Member Author

The tutorial should include a small part of enqueue and dependencies, it might even need to include a dependency beyond wp.data so it runs after the editor is instantiated.

Couple of questions:

  1. Is it necessary to have this for each tutorial, or could each tutorial link to a common reference point to avoid duplication?
  2. Can you suggest what text I might use, to avoid back and forth? I don't have a strong preference.

Also, as a point of process, is there a way of knowing what's required of a tutorial before I submit it as a pull request? There's been a Paper doc sitting in #13592 for a week that I never received any feedback on.

@chrisvanpatten
Copy link
Contributor

chrisvanpatten commented Feb 6, 2019

I agree w/ Daniel that it will get duplicative if we keep including enqueue code in every tutorial. I think it's fine to add a note along the lines of "Make sure you have a JavaScript file available and enqueued" and link to the appropriate page in the JS tutorial.

@danielbachhuber In terms of process, we've been starting from PRs rather than working in other contexts. If you have something that you'd specifically like reviewed before getting a PR up I'd almost even prefer that you just open a PR that maybe adds the blank markdown file and links to the doc in the contents of the PR text, so we can consolidate as much discussion as possible in PRs.

EDIT: That is to say… I see PRs as the place for revision and collaboration on a specific/extent piece of proposed content or code.

@danielbachhuber
Copy link
Member Author

If you have something that you'd specifically like reviewed before getting a PR up I'd almost even prefer that you just open a PR that maybe adds the blank markdown file and links to the doc in the contents of the PR text, so we can consolidate as much discussion as possible in PRs.

Fair enough, although I didn't know where to put the document originally.

Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

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

I only have two hopefully small changes. I think this is otherwise fine to land without any major changes. Would be great to expand in the future but obviously that requires the Notices API to expand too, which I'm excited for it to do :)

* Hook into the 'admin_notices' action to render
* a generic HTML notice.
*/
add_action( 'admin_notices', function() {
Copy link
Contributor

Choose a reason for hiding this comment

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

So personally I have no issues with using closures inside actions (in fact I love them myself and almost hate that I'm commenting about this)… but I think, at least until the day core officially drops 5.2, this should be written with a full function name and all that nonsense.

Sigh.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

FINGERS ALL THE WAY CROSSED

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed to a function in 07e8a60

@chrisvanpatten
Copy link
Contributor

@danielbachhuber Totally fair. And it wasn't helped by my ongoing issue backlog. In the future hopefully I can be faster about feedback there.

@mkaz
Copy link
Member

mkaz commented Feb 7, 2019

I'm fine with not duplicating the enqueue code for each tutorial, but I feel including a sentence that it should be included and a link to the JS tutorial would be sufficient.

I think having a documentation labeled as a tutorial it should have all the steps necessary to get from point A to point B. It doesn't necessarily have to include every step, but should refer to spots that it is included. Otherwise, it could be just an example in the data-notices documentation and not as a tutorial.

As far as process, this showed up in my "requested for review" and the other didn't - I think this is due to the new ownership process.

@mkaz
Copy link
Member

mkaz commented Feb 7, 2019

I won't even try this one as a suggestion :-)
Here's a potential for the JavaScript Tutorial link: https://wordpress.org/gutenberg/handbook/designers-developers/developers/tutorials/javascript/loading-javascript/

In the documentation the link would be: /docs/designers-developers/developers/tutorials/javascript/loading-javascript.md

@danielbachhuber
Copy link
Member Author

I think having a documentation labeled as a tutorial it should have all the steps necessary to get from point A to point B. It doesn't necessarily have to include every step, but should refer to spots that it is included. Otherwise, it could be just an example in the data-notices documentation and not as a tutorial.

Fair enough.

Here's a potential for the JavaScript Tutorial link: https://wordpress.org/gutenberg/handbook/designers-developers/developers/tutorials/javascript/loading-javascript/

Added in d887d23

Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

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

I dig. 🚢

@chrisvanpatten chrisvanpatten dismissed mkaz’s stale review February 7, 2019 00:18

Change was accommodated 👍

@danielbachhuber danielbachhuber added [Type] Enhancement A suggestion for improvement. [Type] Developer Documentation Documentation for developers labels Feb 7, 2019
@danielbachhuber danielbachhuber added this to the 5.1 (Gutenberg) milestone Feb 7, 2019
@danielbachhuber danielbachhuber merged commit c763c03 into master Feb 7, 2019
@danielbachhuber danielbachhuber deleted the 13592-notices-tutorial branch February 7, 2019 01:24
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Add a developer tutorial for displaying notices

* Update `manifest.json` with new document

* Fix link to available actions and selectors

Co-Authored-By: danielbachhuber <[email protected]>

* Avoid closures per feedback

* Use 'core' to distinguish between WordPress, themes, and plugins

* Link to the "How to JavaScript" tutorial for further detail
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Add a developer tutorial for displaying notices

* Update `manifest.json` with new document

* Fix link to available actions and selectors

Co-Authored-By: danielbachhuber <[email protected]>

* Avoid closures per feedback

* Use 'core' to distinguish between WordPress, themes, and plugins

* Link to the "How to JavaScript" tutorial for further detail
This was referenced Apr 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants