Skip to content

Commit b956c20

Browse files
committed
docs: remove dev containers info and unused links
1 parent 67d6b07 commit b956c20

File tree

1 file changed

+4
-67
lines changed

1 file changed

+4
-67
lines changed

README.md

Lines changed: 4 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Out of the box, this template provides a minimal WordPress theme with basic supp
3838

3939
## Quickstart
4040

41-
This project requires [Docker][docker] and [Node.js][node] for local development. For a better editing experience for PHP and Twig files, it's useful to have [PHP installed][php-install] on your system as well. If you are on Windows and use VS Code, you may find it helpful to [run VS Code in a container][vs-code-container] so that you can more easily work with PHP (see more details in the [Local Development Setup section](#running-vs-code-in-a-container)).
41+
This project requires [Docker][docker] and [Node.js][node] for local development. For a better editing experience for PHP and Twig files, it's useful to have [PHP installed][php-install] on your system as well, but it isn't required.
4242

4343
To run the project for the first time, do the following:
4444

@@ -205,11 +205,11 @@ If you use [VS Code][vs-code], you can create a `settings.json` file inside a `.
205205

206206
We recommend these extensions to make working with PHP and Twig easier.
207207

208-
- [PHP Sniffer & Beautifier][phpsab-vscode]
208+
- [PHP Sniffer & Beautifier][phpsab-vscode] (may not work on Windows)
209209
- [Twig][twig-vscode]
210-
- [twigcs][twigcs-vscode]
210+
- [twigcs][twigcs-vscode] (may not work on Windows)
211211

212-
Note: you will need to have vendor files available on your host machine (not the container they're installed in) for the linters to highlight code while you're working. You can run `npm run map-vendor-files` to make them available at the paths specified in the example `settings.json` below, and as long as you have PHP installed on your system, they _should_ work. Windows has limited support for PHP, though, so you may want to run VS Code in a container so that PHP will be more easily available (or you can choose to live without real-time error highlighting).
212+
Note: you will need to have vendor files available on your host machine (not the container they're installed in) for the linters to highlight code while you're working. You can run `npm run map-vendor-files` to make them available at the paths specified in the example `settings.json` below, and as long as you have PHP installed on your system, they _should_ work. Windows has limited support for PHP, though, so you may not be able to get real-time error highlighting on PHP/Twig files.
213213

214214
```json
215215
{
@@ -226,62 +226,6 @@ Note: you will need to have vendor files available on your host machine (not the
226226
}
227227
```
228228

229-
##### Running VS Code in a Container
230-
231-
The [Dev Containers extension][dev-containers-vscode] allows you to run VS Code inside a container, giving you access to a consistent environment that you can configure to include the dependencies you need. For this project, we recommend an Ubuntu container with the same PHP version as in the [Dockerfile](./Dockerfile), the LTS version of Node.js, and Docker (docker-in-docker).
232-
233-
After installing the Dev Containers extension, you can manually create the container through the extension's UI, or you can add a configuration file at `.devcontainer/devcontainer.json`, like so:
234-
235-
```json
236-
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
237-
// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
238-
{
239-
"name": "Ubuntu",
240-
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
241-
"image": "mcr.microsoft.com/devcontainers/base:jammy",
242-
"features": {
243-
"ghcr.io/devcontainers/features/node:1": {
244-
"nodeGypDependencies": true,
245-
"version": "lts",
246-
"nvmVersion": "latest"
247-
},
248-
"ghcr.io/shyim/devcontainers-features/php:0": {
249-
"installComposer": true,
250-
"version": "8.1"
251-
},
252-
"ghcr.io/devcontainers/features/docker-in-docker:2": {
253-
"moby": true,
254-
"azureDnsAutoDetection": true,
255-
"installDockerBuildx": true,
256-
"version": "latest",
257-
"dockerDashComposeVersion": "v2"
258-
}
259-
},
260-
"customizations": {
261-
"vscode": {
262-
"extensions": ["ValeryanM.vscode-phpsab", "whatwedo.twig", "cerzat43.twigcs"]
263-
}
264-
}
265-
266-
// Features to add to the dev container. More info: https://containers.dev/features.
267-
// "features": {},
268-
269-
// Use 'forwardPorts' to make a list of ports inside the container available locally.
270-
// "forwardPorts": [],
271-
272-
// Use 'postCreateCommand' to run commands after the container is created.
273-
// "postCreateCommand": "uname -a",
274-
275-
// Configure tool-specific properties.
276-
// "customizations": {},
277-
278-
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
279-
// "remoteUser": "root"
280-
}
281-
```
282-
283-
Note: after restarting in the containerized VS Code, you will need to run `npm ci` and `docker compose build` again. You may also need to delete the `theme` and `plugins` folders so that the build process can recreate them with the right file permissions for the container.
284-
285229
## WordPress
286230

287231
### Upgrading WordPress
@@ -752,12 +696,8 @@ Deployment to Pantheon requires setting the following variables and secrets in G
752696
<!-- Links: -->
753697

754698
[advanced-custom-fields]: https://www.advancedcustomfields.com/
755-
[babel]: https://babeljs.io
756-
[bem]: http://getbem.com
757699
[bemit]: https://csswizardry.com/2015/08/bemit-taking-the-bem-naming-convention-a-step-further/
758-
[composer]: https://getcomposer.org/download/
759700
[contact-form-7]: https://contactform7.com/
760-
[dev-containers-vscode]: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
761701
[docker]: https://www.docker.com
762702
[gh-personal-access-token]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic
763703
[gh-secrets]: https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository
@@ -772,14 +712,11 @@ Deployment to Pantheon requires setting the following variables and secrets in G
772712
[phpsab-vscode]: https://marketplace.visualstudio.com/items?itemName=ValeryanM.vscode-phpsab
773713
[rollbar]: https://docs.rollbar.com/docs/wordpress
774714
[sass]: https://sass-lang.com/
775-
[sb-eslint]: https://github.com/sparkbox/eslint-config-sparkbox
776-
[sb-stylelint]: https://github.com/sparkbox/stylelint-config-sparkbox
777715
[string-extension]: https://github.com/twigphp/string-extra
778716
[timber]: https://timber.github.io/docs/
779717
[twig-vscode]: https://marketplace.visualstudio.com/items?itemName=whatwedo.twig
780718
[twig]: https://twig.symfony.com/
781719
[twigcs-vscode]: https://marketplace.visualstudio.com/items?itemName=cerzat43.twigcs
782-
[vs-code-container]: https://code.visualstudio.com/docs/devcontainers/tutorial
783720
[vs-code]: https://code.visualstudio.com/
784721
[widgets]: https://developer.wordpress.org/themes/functionality/sidebars/
785722
[wpcs]: https://github.com/WordPress/WordPress-Coding-Standards

0 commit comments

Comments
 (0)