Skip to content

Commit 8a6b4e2

Browse files
authored
chore: tiny documentation updates and fix docker compose version warning (#1808)
- Updates documentation to reflect that we no longer encourage WSL development. - Updated references to Node 22 and PHP 7.4 - Removed the docker compose version from the yml file because that was causing a warning message.
1 parent 80ade38 commit 8a6b4e2

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

docker-compose.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# https://docs.docker.com/compose/compose-file
22
# https://github.com/compose-spec/compose-spec/blob/master/spec.md
3-
version: '3.5'
43

54
# networks:
65
# lexbox:

docs/DEVELOPER.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,13 @@ Welcome! We're glad that you are interested in helping develop Language Forge.
3030

3131
### Supported Development Environments
3232

33-
Development of Language Forge is supported using [VS Code](https://code.visualstudio.com/download) on Linux, MacOS or Windows using WSL ([`wsl --install`](https://learn.microsoft.com/en-us/windows/wsl/install)).
34-
35-
On Windows, the project should be opened with the [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) VS Code extension, so that all commands and extensions run on WSL.
33+
Development of Language Forge is supported using [VS Code](https://code.visualstudio.com/download) on Linux, MacOS or Windows
3634

3735
### IDE Developer Experience (DX)
3836

3937
While Docker is great way to encapsulate all of the dependencies, build tools and run-time environment of the application, IDEs usually require locally installed extensions, tools and runtimes in order to provide type checking, code hints, and debugging capabilities that make for a better developer experience. To this end, the following locally installed tools/dependencies may be installed for good DX:
4038

41-
- PHP 7.3
39+
- PHP 7.4
4240
- Composer
4341
- Node and npm
4442
- .Net SDK
@@ -52,9 +50,8 @@ While Docker is great way to encapsulate all of the dependencies, build tools an
5250
2. Permit your user (and not just "sudo") to contact the Docker daemon: `sudo usermod -aG docker yourUsername && sudo chmod 666 /var/run/docker.sock`.
5351
3. (Optional) Configure docker to start on boot: `printf '[boot]\ncommand="service docker start"\n' | sudo tee /etc/wsl.conf` (assuming `/etc/wsl.conf` is currently unused).
5452
2. Install [Make](https://www.gnu.org/software/make/): `sudo apt install make`.
55-
3. Install [Node 16.14.0](https://nodejs.org/en/download/). We recommend using [nvm](https://github.com/nvm-sh/nvm#installation-and-update).
53+
3. Install [Node 22](https://nodejs.org/en/download/). We recommend using [nvm](https://github.com/nvm-sh/nvm#installation-and-update) or [nvm on Windows](https://github.com/coreybutler/nvm-windows).
5654
4. Clone the repo: `git clone https://github.com/sillsdev/web-languageforge`.
57-
1. Windows users, be sure to clone the project to the WSL file system (to keep VS Code, Git and the file system in sync)
5855
5. Run `npm install` (required for git pre-commit hook with Prettier)
5956

6057
### Running the App Locally

0 commit comments

Comments
 (0)