WordPress.org

Make WordPress Core

Opened 2 years ago

Closed 19 months ago

#43732 closed enhancement (fixed)

Improve wording on notice preventing development from src directory.

Reported by: omarreiss Owned by: pento
Milestone: 5.1 Priority: normal
Severity: normal Version:
Component: Build/Test Tools Keywords: has-patch needs-refresh
Focuses: ui, javascript Cc:

Description (last modified by SergeyBiryukov)

Splitting this out of #43055 as a future, yet necessary iteration.

The wording on the notice we plan to serve to devs who are running WordPress develop from the src directory isn't very accessible or user friendly. We need to improve it and with it the documentation.

Attachments (3)

34698565-0a2cf5d0-f4d9-11e7-981f-6f64b15a0c79.png (99.3 KB) - added by SergeyBiryukov 2 years ago.
43732.diff (2.6 KB) - added by arcturusink 2 years ago.
More instructions
43732-after-44359.png (145.0 KB) - added by ocean90 19 months ago.

Download all attachments as: .zip

Change History (11)

#1 @netweb
2 years ago

  • Keywords needs-patch added
  • Milestone changed from Awaiting Review to 5.0

Related: #44228 "Read more about setting up your local development environment" needs to link somewhere useful

#2 @SergeyBiryukov
2 years ago

  • Component changed from General to Build/Test Tools
  • Description modified (diff)

@arcturusink
2 years ago

More instructions

#3 @arcturusink
2 years ago

I installed WordPress last week, and this page gave me a lot of trouble. I could not find many documentation on WordPress or information via Google Search on how to proceed from this page. Took around 2.5 hours to figure things out. I hope my input/experience is helpful for anyone who has to come across this page, and they have a better experience on knowing how to proceed. I know its not perfect, so any feedback is welcomed.
I used <br> to break up the lines. Is there a more elegant way of doing it? I did not want to introduce html for the unordered list in the php code, so I hard-coded the dash.

#4 @arcturusink
2 years ago

  • Keywords needs-testing added

#5 @jorbin
22 months ago

  • Milestone changed from 5.0 to 5.1

#6 @nielslange
19 months ago

  • Keywords has-patch added; needs-patch removed

#7 @ocean90
19 months ago

  • Keywords needs-refresh added; needs-testing removed
  • Type changed from defect (bug) to enhancement

43732-after-44359.png is the current version after [44359].

Instead of adding the installation instructions, why not link to https://www.npmjs.com/get-npm and https://gruntjs.com/getting-started?

#8 @pento
19 months ago

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

In 44664:

Dev Tools: Load the wp-admin build instructions from src.

This de-duplicates the content, so it only needs to be modified in one place.

Additionally, we now link to the NPM/Grunt install guides on the build instructions page.

Props pento, ocean90.
Fixes #43732.

Note: See TracTickets for help on using tickets.