WordPress.org

Making WordPress.org

Opened 2 years ago

Last modified 12 months ago

#3000 assigned defect

More info about grunt patch

Reported by: michalzuber Owned by: dryanpress
Milestone: Priority: normal
Component: Handbooks Keywords: good-first-bug
Cc:

Description

On site https://make.wordpress.org/core/handbook/tutorials/working-with-patches/#applying-a-patch I miss the information about grunt patch command which is very handy. Could be a link to https://make.wordpress.org/core/handbook/testing/patch/#using-grunt

On site https://make.wordpress.org/core/handbook/testing/patch/#using-grunt is a mention, but only the number version. Why not list the whole help from grunt patch, e.g.

1) have a diff or patch in your WordPress Directory
2) enter a ticket number, e.g. grunt patch:15705
3) enter a ticket url, e.g. grunt patch:https://core.trac.wordpress.org/ticket/15705
4) enter a patch url, e.g. grunt patch:https://core.trac.wordpress.org/attachment/ticket/11817/13711.diff

Change History (10)

#1 @obenland
13 months ago

  • Keywords good-first-bug added

This ticket was mentioned in Slack in #core-committers by netweb. View the logs.


13 months ago

#3 @obenland
12 months ago

  • Owner set to dryanpress
  • Status changed from new to assigned

This ticket was mentioned in Slack in #meta by dryanpress. View the logs.


12 months ago

This ticket was mentioned in Slack in #docs by dryanpress. View the logs.


12 months ago

#6 @flixos90
12 months ago

@dryanpress So I recently modified https://make.wordpress.org/core/handbook/tutorials/working-with-patches/ for the same reason this ticket exists. I had not seen it before, apologies for that. I've added one paragraph about grunt upload_patch under https://make.wordpress.org/core/handbook/tutorials/working-with-patches/#creating-a-patch, and a paragraph about grunt patch under https://make.wordpress.org/core/handbook/tutorials/working-with-patches/#applying-a-patch.

It might be good to link to the other resource, either to complement or instead of having the text in there that I added. Generally, I'd like to ask for a review of the new sections on the Grunt commands I added, and then we can see whether that is sufficient or needs improvements.

#7 follow-up: @dryanpress
12 months ago

@flixos90 Those look like a great start! I'm fine waiting for review before we do more.

I do think this re-highlights a pain point identified in #1866 and ignites my interest in #3593.

At minimum, I think a Handbook page about "Contributing to Handbooks" (or the present inability) would be helpful, and I think either ticket above could help Handbook contribution/quality/coverage.

#8 in reply to: ↑ 7 @flixos90
12 months ago

Replying to dryanpress:

@flixos90 Those look like a great start! I'm fine waiting for review before we do more.

Oh, I meant I'm generally happy for any review. If you think that my changes sufficiently address this ticket here, I think it can be closed.

I do think this re-highlights a pain point identified in #1866 and ignites my interest in #3593.

Those would be separate problems, I certainly agree they are sub-optimal at the moment. Let's focus on only the Grunt command documentation in here.

#9 @dryanpress
12 months ago

@flixos90 I think @michalzuber's point about highlighting the trio of 1) ticket uid 2) ticket URL and 3) patch URL is worth fully detailing / linking off to before closing.

That section under Applying a Patch seems like it's grown organically and could be re-organized and/or clarified with subheadings -- I think putting Grunt commands first as the recommended workflow could help.

Applying a Patch

  • Apply using Grunt (Recommended)
  • Download from Trac
  • Download using CLI

This ticket was mentioned in Slack in #docs by dryanpress. View the logs.


12 months ago

Note: See TracTickets for help on using tickets.