Making WordPress.org

Opened 5 weeks ago

Last modified 5 weeks ago

#7668 new defect (bug)

Broken link to VVV howto

Reported by: threadi's profile threadi Owned by:
Milestone: Priority: low
Component: Handbooks Keywords:
Cc:

Description

Issue Description

There is a broken link on https://make.wordpress.org/core/handbook/tutorials/getting-started/ to "how to install", link target: https://make.wordpress.org/core/handbook/tutorials/installing-a-local-server/installing-vvv/

URL of the Page with the Issue

https://make.wordpress.org/core/handbook/tutorials/getting-started/

Section of Page with the issue

Setting up a local server

Why is this a problem?

Missing information how to start with VVV for Core Development.

Hint

I would be referred here from this issue from: https://github.com/WordPress/Documentation-Issue-Tracker/issues/1562 - I assume by now it concerns Meta as it is the Contributor handbook.

Change History (4)

This ticket was mentioned in Slack in #core by dd32. View the logs.


5 weeks ago

#2 @dd32
5 weeks ago

Handbooks are controlled/worked on by the individual teams, as such, this falls back to the Core team - and by extension, the Docs team :)

Meta isn't the correct place for this, but I'm going to leave this open, as there's no point in closing it (Although I've flagged it for the #core team, see above).

All references to VVV need to be removed from that page, which necessitates rewriting the entire guide IMHO.

#3 @TJNowell
5 weeks ago

You could use VVV for this but it's no longer the official route so mileage may vary, a lot of the VVV references were already removed from the handbook. As the VVV project lead we decided to keep just the core development template and deprecate the rest, namely the meta environment for contributing to wordpress.org itself (forums/Make blog theme/etc) as none of the VVV maintainers had a .org sandbox and those who would have helped us went in a different direction with dedicated docker setups.

Our last big push to adjust the .org docs was to make sure they linked to ours instead of duplicating install instructions that would become out of date.

If you did want to continue with VVV, you'd install VVV via:

https://varyingvagrantvagrants.org/docs/en-US/installation/

Then use the WP Core development site template:

https://github.com/Varying-Vagrant-Vagrants/custom-site-template-develop

@dd32 I'd suggest for now that the "Setting up a local server" section is all that needs rewriting, possibly even merging with the following paragraph. As someone arriving on that page being told the specific official method would be best but that's always been deliberatley muddied in the past. Perhaps it would be best to use that text to link to here: https://github.com/WordPress/wordpress-develop/?tab=readme-ov-file#local-development

I would note though, if you're going to make the decision to remove VVV it would be nice to be told! We have documentation that needs updating too!

#4 @threadi
5 weeks ago

I already decided to use Docker after my first post over at github. It works perfectly. Freeing the documentation from VVV if it is no longer used anyway would be perfect. Others who come across the current documentation might be as confused as I am. That could be a bit frustrating.

Note: See TracTickets for help on using tickets.