Bug Tracker

Modify

Ticket #11789 (closed bug: fixed)

Opened 2 years ago

Last modified 23 months ago

Update README to describe grunt build system

Reported by: dmethvin Owned by:
Priority: high Milestone: 1.8
Component: build Version: 1.7.2
Keywords: Cc:
Blocking: Blocked by:

Description

For someone who just wants to get up and running building jQuery, the grunt docs aren't clear at all. It's yet not a common enough build system to assume that everyone knows how to get and use it.

The grunt project  README assumes the first thing you want to do is set up your own gruntfile, which isn't the case if you just need it to build jQuery. I didn't see any obvious reference to the npm install grunt that's needed, not even in the "Getting Started" guide!

Ideally we'd be able to delegate at least some of this to the grunt README, it really should be there.

Change History

comment:1 Changed 2 years ago by rwaldron

Confirmed. I definitely need some help with this - but had completely forgotten that it needed to be addressed.

comment:2 Changed 2 years ago by dmethvin

Oh, I see npm install grunt is the *last* thing discussed in the README, probably just needs to be up top.

comment:3 Changed 2 years ago by rwaldron

Right, I didn't want to boot the existing instructions yet, so I threw it in later. Sorry for the completely lack of clarity :D

comment:4 Changed 2 years ago by dmethvin

Actually, if jaubourg is going to land JHP that will require more docs so we might as well do them together; sounds like a good topic for tomorrow's meeting. Scott pointed out that npm install does most of the work but I do think we should have a quick-start. That will become more important if we're going to have people building custom versions.

comment:5 Changed 23 months ago by dmethvin

  • Status changed from new to closed
  • Resolution set to fixed

comment:6 Changed 23 months ago by dmethvin

  • Priority changed from undecided to high
  • Summary changed from README doesn't reflect current build system to Update README to describe grunt build system
  • Component changed from unfiled to build
  • Milestone changed from None to 1.8

Please follow the  bug reporting guidlines and use  jsFiddle when providing test cases and demonstrations instead of pasting the code in the ticket.

View

Add a comment

Modify Ticket

Action
as closed
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.