From 498e2d7fd1ae22436625a2e1b37ed4710bac72c9 Mon Sep 17 00:00:00 2001 From: jld3103 Date: Wed, 13 Dec 2023 06:32:38 +0100 Subject: [PATCH] chore(docs): Fix typos and grammar Signed-off-by: jld3103 --- README.md | 8 ++++---- docs/basics/getting-started.md | 8 ++++---- docs/basics/hostnames.md | 6 +++--- docs/basics/overview.md | 6 +++--- docs/basics/stable-versions.md | 6 +++--- docs/basics/standalone.md | 2 +- docs/basics/troubleshooting.md | 2 +- docs/basics/update.md | 2 +- docs/customizing/build.md | 2 +- docs/services/database.md | 2 +- docs/tools/blackfire.md | 4 ++-- 11 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 06fd2d7..54396d9 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [Documentation](https://juliushaertl.github.io/nextcloud-docker-dev/) | [Nextcloud Developer Portal](https://nextcloud.com/developer/) -Nextcloud development environment using docker-compose providing a large variety of services for Nextcloud server and app development and testing. +Nextcloud's development environment using docker-compose providing a large variety of services for Nextcloud server and app development and testing. ⚠ **DO NOT USE THIS IN PRODUCTION** Various settings in this setup are considered insecure and default passwords and secrets are used all over the place @@ -18,7 +18,7 @@ Nextcloud development environment using docker-compose providing a large variety ## Tutorial -You can find a step by step tutorial on how to use this setup in the [Nextcloud Developer Portal](https://nextcloud.com/developer/). It will guide you through the setup and show you how to use it for app development: https://cloud.nextcloud.com/s/iyNGp8ryWxc7Efa?path=%2F1%20Setting%20up%20a%20development%20environment +You can find a step-by-step tutorial on how to use this setup in the [Nextcloud Developer Portal](https://nextcloud.com/developer/). It will guide you through the setup and show you how to use it for app development: https://cloud.nextcloud.com/s/iyNGp8ryWxc7Efa?path=%2F1%20Setting%20up%20a%20development%20environment In detail explanation of the setup and its features and configuration options can be found in the [nextcloud-docker-dev documentation](https://juliushaertl.github.io/nextcloud-docker-dev/). @@ -29,7 +29,7 @@ In detail explanation of the setup and its features and configuration options ca > [!TIP] > This is the recommended way to run the setup for development. You will have a local clone of all required source code. -To start the setup run the following commands to clone the repository and bootstrap the setup. This will prepare your setp and clone the Nextcloud server repository and required apps into the `workspace` folder. +To start the setup run the following commands to clone the repository and bootstrap the setup. This will prepare your setup and clone the Nextcloud server repository and required apps into the `workspace` folder. ```bash git clone https://github.com/juliushaertl/nextcloud-docker-dev cd nextcloud-docker-dev @@ -81,7 +81,7 @@ For app development you can mount your app directly into the container: docker run --rm -p 8080:80 -v ~/path/to/appid:/var/www/html/apps-extra/appid ghcr.io/juliushaertl/nextcloud-dev-php80:latest ``` -The `SERVER_BRANCH` environment variable can be used to run different versions of Nextcloud by specificing either a server branch or git tag. +The `SERVER_BRANCH` environment variable can be used to run different versions of Nextcloud by specifying either a server branch or git tag. ```bash docker run --rm -p 8080:80 -e SERVER_BRANCH=v24.0.1 ghcr.io/juliushaertl/nextcloud-dev-php80:latest diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index b304ade..747eeb3 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -2,7 +2,7 @@ ## Tutorial -You can find a [step by step tutorial on how to use this setup](https://cloud.nextcloud.com/s/iyNGp8ryWxc7Efa?path=%2F1%20Setting%20up%20a%20development%20environment) in the [Nextcloud Developer Portal](https://nextcloud.com/developer/). It will guide you through the setup and show you how to use it for app development. +You can find a [step-by-step tutorial on how to use this setup](https://cloud.nextcloud.com/s/iyNGp8ryWxc7Efa?path=%2F1%20Setting%20up%20a%20development%20environment) in the [Nextcloud Developer Portal](https://nextcloud.com/developer/). It will guide you through the setup and show you how to use it for app development. There are two ways of using this setup. **A persistent setup is the most common one** where you have a local git clone of all required repositories. The other one is a standalone setup that can be used to quickly run parts of the Nextcloud ecosystem source code without having to clone everything. @@ -11,7 +11,7 @@ There are two ways of using this setup. **A persistent setup is the most common !!! note This is the recommended way to run the setup for development. You will have a local clone of all required source code. -To start the setup run the following commands to clone the repository and bootstrap the setup. This will prepare your setp and clone the Nextcloud server repository and required apps into the `workspace` folder. +To start the setup run the following commands to clone the repository and bootstrap the setup. This will prepare your setup and clone the Nextcloud server repository and required apps into the `workspace` folder. ```bash git clone https://github.com/juliushaertl/nextcloud-docker-dev cd nextcloud-docker-dev @@ -64,7 +64,7 @@ For app development you can mount your app directly into the container: docker run --rm -p 8080:80 -v ~/path/to/appid:/var/www/html/apps-extra/appid ghcr.io/juliushaertl/nextcloud-dev-php80:latest ``` -The `SERVER_BRANCH` environment variable can be used to run different versions of Nextcloud by specificing either a server branch or git tag. +The `SERVER_BRANCH` environment variable can be used to run different versions of Nextcloud by specifying either a server branch or git tag. ```bash docker run --rm -p 8080:80 -e SERVER_BRANCH=v24.0.1 ghcr.io/juliushaertl/nextcloud-dev-php80:latest @@ -74,4 +74,4 @@ You can also mount your local server source code into the container to run a loc ```bash docker run --rm -p 8080:80 -e SERVER_BRANCH=v24.0.1 -v /tmp/server:/var/www/html ghcr.io/juliushaertl/nextcloud-dev-php80:latest -``` \ No newline at end of file +``` diff --git a/docs/basics/hostnames.md b/docs/basics/hostnames.md index 8272b7f..da63e78 100644 --- a/docs/basics/hostnames.md +++ b/docs/basics/hostnames.md @@ -4,7 +4,7 @@ In order to use the hostnames provided by the environment you need to add them to the /etc/hosts file (which is the simplest method). -You can do this by running the following command, which will automatically update entires: +You can do this by running the following command, which will automatically update entries: ```bash ./scripts/update-hosts.sh @@ -33,9 +33,9 @@ docker run --rm -it \ drpsychick/dnsmasq:latest ``` -## Use DNS Service Discovery on MacOS +## Use DNS Service Discovery on macOS -You can also use the `dns-sd` tool on MacOS to advertise the container domains on the network. This is especially useful if you try to connect from an iPhone or iPad, since those devices do not allow to edit the `/etc/hosts` file. Use the tool like this: +You can also use the `dns-sd` tool on macOS to advertise the container domains on the network. This is especially useful if you try to connect from an iPhone or iPad, since those devices do not allow to edit the `/etc/hosts` file. Use the tool like this: ``` dns-sd -P nextcloud _http._tcp local 80 nextcloud.local 192.168.0.10 diff --git a/docs/basics/overview.md b/docs/basics/overview.md index 6c6123f..51db2ce 100644 --- a/docs/basics/overview.md +++ b/docs/basics/overview.md @@ -2,7 +2,7 @@ ## Nextcloud containers -There are multiple containers that can be started for Nextcloud. The main `nextcloud` container is targetting the main workspace directly (usually for running the master/main branch of Nextcloud server and apps) of the latest development version. In addition there are stable containers for running the stable major version branches in parallel. +There are multiple containers that can be started for Nextcloud. The main `nextcloud` container is targeting the main workspace directly (usually for running the master/main branch of Nextcloud server and apps) of the latest development version. In addition, there are stable containers for running the stable major version branches in parallel. Additional services like databases, redis cache, minio object storage and others are provided as separate containers and are shared between the different Nextcloud containers. They still isolate data of the individual Nextcloud containers from each other. @@ -32,7 +32,7 @@ The Nextcloud containers are configured to use multiple app directories. The cronjobs are configured to run every 5 minutes in the individual containers. -For testing you can also run them manually: +For testing, you can also run them manually: ```bash docker-compose exec nextcloud php cron.php @@ -40,7 +40,7 @@ docker-compose exec nextcloud php cron.php ### occ -Run inside of the Nextcloud container: +Run inside the Nextcloud container: ``` set XDEBUG_CONFIG=idekey=PHPSTORM diff --git a/docs/basics/stable-versions.md b/docs/basics/stable-versions.md index 755917b..71f0c45 100644 --- a/docs/basics/stable-versions.md +++ b/docs/basics/stable-versions.md @@ -1,12 +1,12 @@ # Stable Nextcloud versions -As described in the [overview](overview.md) there are multiple Nextcloud containers available. The main `nextcloud` container is targetting the main workspace directly (usually for running the master/main branch of Nextcloud server and apps) of the latest development version. In addition there are stable containers for running the stable major version branches in parallel. +As described in the [overview](overview.md) there are multiple Nextcloud containers available. The main `nextcloud` container is targeting the main workspace directly (usually for running the master/main branch of Nextcloud server and apps) of the latest development version. In addition, there are stable containers for running the stable major version branches in parallel. ## Prepare your git checkouts for running a stable version In order to run a stable version you need to have the corresponding git checkouts available. Using [git worktree](https://blog.juliushaertl.de/index.php/2018/01/24/how-to-checkout-multiple-git-branches-at-the-same-time/) makes it easy to have different branches checked out in parallel in separate directories and is the recommended way to work with stable branches in parallel. -Assuimg you have already cloned the repository into `~/nextcloud-docker-dev/workspace/server` you can run the following commands to create a new worktree for the stable28 branch: +Assuming you have already cloned the repository into `~/nextcloud-docker-dev/workspace/server` you can run the following commands to create a new worktree for the stable28 branch: ```bash # create a new worktree for the stable28 branch @@ -34,4 +34,4 @@ docker-compose up -d stable28 ## Apps without stable branches -Some apps do not have stable branches or cover multiple Nextcloud version. You can use the `ADDITIONAL_APPS_PATH` variable in your `.env` file to add add a cloned app to all Nextcloud containers. By default this is set to `./data/apps-extra` +Some apps do not have stable branches or cover multiple Nextcloud version. You can use the `ADDITIONAL_APPS_PATH` variable in your `.env` file to add a cloned app to all Nextcloud containers. By default, this is set to `./data/apps-extra` diff --git a/docs/basics/standalone.md b/docs/basics/standalone.md index 5247af2..a1bf932 100644 --- a/docs/basics/standalone.md +++ b/docs/basics/standalone.md @@ -20,7 +20,7 @@ docker run --rm -p 8080:80 \ ghcr.io/juliushaertl/nextcloud-dev-php80:latest ``` -The `SERVER_BRANCH` environment variable can be used to run different versions of Nextcloud by specificing either a server branch or git tag. +The `SERVER_BRANCH` environment variable can be used to run different versions of Nextcloud by specifying either a server branch or git tag. ```bash docker run --rm -p 8080:80 -e SERVER_BRANCH=v24.0.1 ghcr.io/juliushaertl/nextcloud-dev-php80:latest diff --git a/docs/basics/troubleshooting.md b/docs/basics/troubleshooting.md index 2ff8375..6528535 100644 --- a/docs/basics/troubleshooting.md +++ b/docs/basics/troubleshooting.md @@ -1,6 +1,6 @@ # Troubleshooting -- If your setup isn't working and you can not figure out the reason why, running +- If your setup isn't working, and you can not figure out the reason why, running `docker-compose down -v` will remove the relevant containers and volumes, allowing you to run `docker-compose up` again from a clean slate. - You can run `./bootstrap.sh` again to check the setup and detected paths for your source code destination diff --git a/docs/basics/update.md b/docs/basics/update.md index 4e71432..3aa6550 100644 --- a/docs/basics/update.md +++ b/docs/basics/update.md @@ -19,4 +19,4 @@ docker-compose exec nextcloud occ upgrade In case Nextcloud server bumps the major version, you will need to pull all repositories again to the latest state to get the compatibility changes. -You might want to take the opportunity to then setup the previous version as a new stable version setup. See [stable versions](stable-versions.md) for more information. \ No newline at end of file +You might want to take the opportunity to then set up the previous version as a new stable version setup. See [stable versions](stable-versions.md) for more information. diff --git a/docs/customizing/build.md b/docs/customizing/build.md index a340e84..183dcae 100644 --- a/docs/customizing/build.md +++ b/docs/customizing/build.md @@ -10,4 +10,4 @@ make docker/Dockerfile.php81 make docker/Dockerfile.php80 ``` -Afterwards you can recrate the container with `docker-compose up -d --force-recreate nextcloud` to run the new image or use `docker-compose down -v` before to also reinstall Nextcloud. +Afterward you can recreate the container with `docker-compose up -d --force-recreate nextcloud` to run the new image or use `docker-compose down -v` before to also reinstall Nextcloud. diff --git a/docs/services/database.md b/docs/services/database.md index 413d73f..c13280a 100644 --- a/docs/services/database.md +++ b/docs/services/database.md @@ -2,7 +2,7 @@ ## Introduction -By default MySQL will be used as database backend. You can change this by setting the `SQL` variable in the `.env` file. The following databases are supported: +By default, MySQL will be used as database backend. You can change this by setting the `SQL` variable in the `.env` file. The following databases are supported: - `mysql` - `pgsql` diff --git a/docs/tools/blackfire.md b/docs/tools/blackfire.md index df76d9a..a478295 100644 --- a/docs/tools/blackfire.md +++ b/docs/tools/blackfire.md @@ -1,8 +1,8 @@ # Blackfire -Blackfire needs to use a hostname/ip that is resolvable from within the Blackfire container. Their free version is [limited to local profiling](https://support.blackfire.io/troubleshooting/hack-edition-users-cannot-profile-non-local-http-applications) so we need to browse Nextcloud though its local docker IP or add the hostname to `/etc/hosts`. +Blackfire needs to use a hostname/ip that is resolvable from within the Blackfire container. Their free version is [limited to local profiling](https://support.blackfire.io/troubleshooting/hack-edition-users-cannot-profile-non-local-http-applications), so we need to browse Nextcloud though its local docker IP or add the hostname to `/etc/hosts`. -By default the PHP module for Blackfire is disabled, but you can enable or disable this through the following script: +By default, the PHP module for Blackfire is disabled, but you can enable or disable this through the following script: ``` ./scripts/php-mod-config nextcloud blackfire on