Skip to content

Commit 0f60262

Browse files
committed
docs: remove dev containers info and unused links
1 parent de58a3a commit 0f60262

File tree

1 file changed

+5
-67
lines changed

1 file changed

+5
-67
lines changed

README.md

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

3838
## Quickstart
3939

40-
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)).
40+
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.
4141

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

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

162162
We recommend these extensions to make working with PHP and Twig easier.
163163

164-
- [PHP Sniffer & Beautifier][phpsab-vscode]
164+
- [PHP Sniffer & Beautifier][phpsab-vscode] (may not work on Windows)
165165
- [Twig][twig-vscode]
166-
- [twigcs][twigcs-vscode]
166+
- [twigcs][twigcs-vscode] (may not work on Windows)
167167

168-
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).
168+
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.
169169

170170
```json
171171
{
@@ -182,62 +182,6 @@ Note: you will need to have vendor files available on your host machine (not the
182182
}
183183
```
184184

185-
##### Running VS Code in a Container
186-
187-
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).
188-
189-
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:
190-
191-
```json
192-
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
193-
// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
194-
{
195-
"name": "Ubuntu",
196-
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
197-
"image": "mcr.microsoft.com/devcontainers/base:jammy",
198-
"features": {
199-
"ghcr.io/devcontainers/features/node:1": {
200-
"nodeGypDependencies": true,
201-
"version": "lts",
202-
"nvmVersion": "latest"
203-
},
204-
"ghcr.io/shyim/devcontainers-features/php:0": {
205-
"installComposer": true,
206-
"version": "8.1"
207-
},
208-
"ghcr.io/devcontainers/features/docker-in-docker:2": {
209-
"moby": true,
210-
"azureDnsAutoDetection": true,
211-
"installDockerBuildx": true,
212-
"version": "latest",
213-
"dockerDashComposeVersion": "v2"
214-
}
215-
},
216-
"customizations": {
217-
"vscode": {
218-
"extensions": ["ValeryanM.vscode-phpsab", "whatwedo.twig", "cerzat43.twigcs"]
219-
}
220-
}
221-
222-
// Features to add to the dev container. More info: https://containers.dev/features.
223-
// "features": {},
224-
225-
// Use 'forwardPorts' to make a list of ports inside the container available locally.
226-
// "forwardPorts": [],
227-
228-
// Use 'postCreateCommand' to run commands after the container is created.
229-
// "postCreateCommand": "uname -a",
230-
231-
// Configure tool-specific properties.
232-
// "customizations": {},
233-
234-
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
235-
// "remoteUser": "root"
236-
}
237-
```
238-
239-
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.
240-
241185
## WordPress
242186

243187
### Upgrading WordPress
@@ -282,6 +226,7 @@ This will uncheck "Allow comments" on individual posts going forward by default,
282226
1. Scroll to the bottom and hit "Save Changes"
283227

284228
#### Comments for Pages
229+
285230
By default, comments are turned off for pages, but can be enabled for pages individually:
286231

287232
1. From the admin dashboard, navigate to "Edit Page"
@@ -664,12 +609,8 @@ Deployment to Pantheon requires setting the following variables and secrets in G
664609
<!-- Links: -->
665610

666611
[advanced-custom-fields]: https://www.advancedcustomfields.com/
667-
[babel]: https://babeljs.io
668-
[bem]: http://getbem.com
669612
[bemit]: https://csswizardry.com/2015/08/bemit-taking-the-bem-naming-convention-a-step-further/
670-
[composer]: https://getcomposer.org/download/
671613
[contact-form-7]: https://contactform7.com/
672-
[dev-containers-vscode]: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
673614
[docker]: https://www.docker.com
674615
[google-site-kit]: https://sitekit.withgoogle.com/
675616
[html-extension]: https://github.com/twigphp/html-extra
@@ -681,14 +622,11 @@ Deployment to Pantheon requires setting the following variables and secrets in G
681622
[phpsab-vscode]: https://marketplace.visualstudio.com/items?itemName=ValeryanM.vscode-phpsab
682623
[rollbar]: https://docs.rollbar.com/docs/wordpress
683624
[sass]: https://sass-lang.com/
684-
[sb-eslint]: https://github.com/sparkbox/eslint-config-sparkbox
685-
[sb-stylelint]: https://github.com/sparkbox/stylelint-config-sparkbox
686625
[string-extension]: https://github.com/twigphp/string-extra
687626
[timber]: https://timber.github.io/docs/
688627
[twig-vscode]: https://marketplace.visualstudio.com/items?itemName=whatwedo.twig
689628
[twig]: https://twig.symfony.com/
690629
[twigcs-vscode]: https://marketplace.visualstudio.com/items?itemName=cerzat43.twigcs
691-
[vs-code-container]: https://code.visualstudio.com/docs/devcontainers/tutorial
692630
[vs-code]: https://code.visualstudio.com/
693631
[widgets]: https://developer.wordpress.org/themes/functionality/sidebars/
694632
[wpcs]: https://github.com/WordPress/WordPress-Coding-Standards

0 commit comments

Comments
 (0)