Docs: Clean up the nodejs package installation instructions

RESOLVED FIXED

Status

Tree Management
Treeherder: Docs & Development
P3
normal
RESOLVED FIXED
3 years ago
2 years ago

People

(Reporter: emorley, Assigned: wlach)

Tracking

Details

Attachments

(1 attachment)

(Reporter)

Description

3 years ago
The leftover bits from bug 1060312:

(In reply to Ed Morley [:edmorley] from comment #2)
> The npm parts also could do with being cleaned up:
> * aiui it's best practice to install grunt-cli globally, and then the runner
> itself locally. The docs don't mention the global install.
> * the docs say to install karma globally, but I think this should be local?
> * The install instructions prefix everything with sudo, when this isn't
> necessary for non-global and is also not correct for say Windows.
> * The "build" section says to "Install the devDependencies in package.json",
> when presumably we can just |npm install| to do that for us.
(Reporter)

Comment 1

3 years ago
See also:
https://github.com/mozilla/treeherder-ui/pull/486#issuecomment-96843927

There was confusion there figuring out how to install the deps and run the UI tests.
(Reporter)

Updated

2 years ago
Summary: Docs: More cleanup of the treeherder-ui installation docs → Docs: Clean up the nodejs package installation instructions
Created attachment 8613013 [details] [review]
PR

I think some of these were already addressed, all that remained to be done was fix the instructions for running unit tests.
Attachment #8613013 - Flags: review?(emorley)
(Reporter)

Updated

2 years ago
Attachment #8613013 - Flags: review?(emorley) → review+
(Reporter)

Updated

2 years ago
Assignee: nobody → wlachance

Comment 3

2 years ago
Commit pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/8eee644a0017facfe5d9e204ec97c4a0a0bd9484
Bug 1139998 - Make it more clear in docs how to set things up to run UI tests
Status: NEW → RESOLVED
Last Resolved: 2 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.