Various Docs improvements

Author: lukasbischof

docs/introduction/how-deploio-works.md

@@ -28,19 +28,19 @@ Deploio automatically builds your application using the [Heroku Buildpack](https
 
 ##### Release
 
-After a successful build, your application is released. The release includes the build artifact, configuration settings, 
+After a successful build, your application is released. The release includes the build artifact, configuration settings,
 and environment variables. Releases are immutable and versioned.
 Deploio also manages secrets and sensitive data securely, differentiating between build and release environment variables.
-While release ENV variables are exposed to the running application, build ENV variables are only available during the 
+While release ENV variables are exposed to the running application, build ENV variables are only available during the
 build process and are not included in the final release.
 
 ##### Run
 
 Deploio runs your application on a managed Kubernetes cluster, powered by **Nine Kubernetes Engine** (NKE), located in Switzerland. Deployments are automatically rolled out using zero-downtime strategies such as rolling updates and health checks. Applications run in isolated pods, scheduled across nodes provisioned via configurable node pools and machine types. This ensures high availability and scalability.
 
-Apps are exposed to the internet via k8 ingress controllers. Other services are not. All communication is secured with TLS (also internally).
+Apps are exposed to the internet via k8s ingress controllers. Other services are not. All communication is secured with TLS (also internally).
 
-While Deploio runs on a scalable Kubernetes infrastructure, your apps don’t autoscale by default. Most apps can live comfortably with vertical scaling — predictable, easy to manage, and fully under your control via code, CI/CD, or manually in the Cockpit. You probably don’t need horizontal scaling, but if you do, We’ve got you. Because we run on real Kubernetes, and we know how to scale things properly. Do you?
+While Deploio runs on a scalable Kubernetes infrastructure, your apps don’t autoscale by default. Most apps can live comfortably with vertical scaling — predictable, easy to manage, and fully under your control via code, CI/CD, or manually in the Cockpit. You probably don’t need horizontal scaling, but if you do, we’ve got you. Because we run on real Kubernetes, and we know how to scale things properly. Do you?
 
 
 For more details on the infrastructure used to run your app, view the Nine Kubernetes Engine documentation [here](https://docs.nine.ch/docs/managed-kubernetes/nke/nine-kubernetes-engine/).
@@ -55,12 +55,14 @@ See the [Code Repository Setup](/user-guide/code-repository-setup.md) page for m
 
 ##### Build Automation
 
-Use the official Heroku Cloud Native Buildpacks for languages like Node.js, Ruby, Python, and Go — or define a custom Dockerfile. Builds are cached to speed things up. Configuration isn’t limited to environment variables: Deploio uses a **hierarchical system** that lets you define defaults at the company or project level easily, and override them per app — either in the code or directly in the Cockpit.
+Either use the provided official Heroku Cloud Native Buildpacks for languages like Node.js, Ruby, Python, and Go — or define a custom Dockerfile.
+Builds are cached to speed things up.
+Configuration isn’t limited to environment variables: Deploio uses a **hierarchical system** that lets you define defaults at the company or project level easily, and override them per app — either in the code or directly in the Cockpit.
 
 
 ##### Deployment
 
-Deployments are rolled out through Kubernetes using rolling updates and readiness checks to ensure zero downtimme. Each deployment references a specific container image and configuration version.
+Deployments are rolled out through Kubernetes using rolling updates and readiness checks to ensure zero downtime. Each deployment references a specific container image and configuration version.
 
 Deploy jobs can also be configured to execute before a new release is deployed. The rollout of the release will only continue if the deploy job finished successfully. This can be defined in the `.deploio.yaml`. See more information [here](/user-guide/configuring-your-application.md#deploioyaml).
 
@@ -98,7 +100,7 @@ flowchart TD
 
 A project represents a workspace that contains one or more applications and related services such as databases, Redis instances and object storage. It is a logical grouping of applications and services that share the same codebase, configuration, and deployment settings and billing. Projects are isolated from each other, allowing for better organisation and management of resources.
 
-It is typical that a Project will have an Application running for each environment. But be aware; staging apps can access production services unless access controls are explicitly defined - similar to Heroku.
+It is typical that a Project will have an Application running for each environment. But be aware: staging apps can access production services unless access controls are explicitly defined - similar to Heroku.
 
 ##### Deployment
 
@@ -113,4 +115,9 @@ The Deploio web interface, providing a visual dashboard to manage your projects,
 
 The official Deploio CLI tool for developers. It can be used for the whole process; from creating a project to deploying an application. It provides a command-line interface for managing your projects, deployments, and environments. You can use it to trigger builds, manage environments, inspect logs, and control deployments right from your terminal.
 
+##### UI
+
+The Deploio web interface, providing a visual dashboard to manage your resources, view logs, and monitor deployments.
+You can access it over at [cockpit.nine.ch](https://cockpit.nine.ch/).
+
 Learn more about the process on [docs.nine.ch](https://docs.nine.ch).

docs/nodejs/quick-start.md

@@ -63,7 +63,7 @@ nctl create app nextjs \
 This command creates a new application on Deploio using
 the [Node.js buildpack](https://paketo.io/docs/reference/nodejs-reference/). The `--git-url` flag specifies the URL of
 the Git repository where the application is stored. The optional `--git-sub-path` flag specifies the subdirectory in the
-Git repository where the application is located. Finally, the `--env` flag and `--build-env` flag sets the `NODE_ENV`
+Git repository where the application is located. Finally, the `--env` flag and `--build-env` flag set the `NODE_ENV`
 environment variable to `production`.
 
 ::: warning

docs/php/background-jobs.md

@@ -33,7 +33,7 @@ equivalent of the instance types for the application. The available sizes can be
 
 ## Observing a Worker
 
-The worker's logs are aggregated with the application logs. You can view the all the logs using the `nctl logs` command.
+The worker's logs are aggregated with the application logs. You can view all the logs using the `nctl logs` command.
 If you wish to only view the logs for the worker, you can filter the logs using the `-t, --type` flag:
 
 ```bash

docs/php/continuous-deployment.md

@@ -117,8 +117,8 @@ flaws:
 [//]: # (TODO: There are plans to add the functionality into `nctl` to block the update command until the deployment is finished.)
 
 To circumvent these issues, you might want to add a check that waits for the deployment to finish and then check its
-status. A more sophisticated approach including an example of a status check script in Ruby can be found in
-.
+status. A more sophisticated approach including an example of a status check script in Ruby can be found
+[here](/user-guide/ci-cd-integration.md#deployment-feedback-on-the-ci).
 This Ruby script can be adapted for your preferred language and setup.
 
 ### Troubleshooting

docs/php/database.md

@@ -232,8 +232,8 @@ In that shell, run the following command to create the database:
 bin/console doctrine:database:create
 ```
 
-You can verify that this database was created by logging into the database using `psql -U dbadmin -h {FQDN} -d postgres`
-and then running the command `\l` to list the databases on the server.
+You can verify that this database was created by logging into the database (using `mysql -h {FQDN} -u dbadmin -p`)
+and then running the command `SHOW DATABASES;` to list the databases on the server.
 
 > **Alternative:** If you do not use Doctrine or otherwise want to do something differently, make sure that your IP is allowed to connect
 > to the database and then use a MySQL client from your machine to create the database. E.g. with the MySQL CLI:

docs/php/key-value-storage.md

@@ -48,9 +48,11 @@ To fetch information about the key-value store, including the fully qualified do
 $ nctl get kvs {application_name}
 PROJECT       NAME                  FQDN                                                    TLS     MEMORY SIZE
 my-project    {application_name}    {application_name}.1234567.keyvaluestore.nineapis.ch    true    1Gi
+```
 
 Retrieve the password for the key-value store:
 
+```bash
 $ nctl get kvs {application_name} --print-token
 ...password...
 ```

docs/php/object-storage.md

@@ -12,6 +12,9 @@ description: Guide for configuring S3-compatible object storage for PHP applicat
 
 ::: info
 Should you require a file upload or a writeable storage, you can use our S3-compatible object storage.
+You can use Amazon S3 together with Deploio as you would with any other hosting provider.
+If you wish to have a persistent, S3 compatible storage that also runs on Nine's infrastructure
+and is directly connected to Deploio, you can use our S3-compatible object storage.
 You can see the pricing [here](https://docs.nine.ch/docs/object-storage/manage-buckets-and-users#pricing).
 :::
 
@@ -68,7 +71,7 @@ You will need the access key and the secret key, the user name is not used on th
 
 ## Configure your PHP Application
 
-S3 can not be mounted as a local filesystem, so you need a client to let PHP interact with S3. In the example
+S3 cannot be mounted as a local filesystem, so you need a client to let PHP interact with S3. In the example
 application, we use [Flysystem](https://flysystem.thephpleague.com/docs/) with the
 [S3 plugin](https://flysystem.thephpleague.com/docs/adapter/aws-s3-v3/) (which itself uses the AWS SDK for PHP).
 The `league/flysystem-bundle` does not support specifying the connection as DSN, therefore we added

docs/php/symfony.md

@@ -20,7 +20,7 @@ You can deploy it with `nctl`:
 nctl create app symfony \
   --git-url=https://github.com/ninech/deploio-examples \
   --git-sub-path=php/symfony \
-  --env="APP_SECRET=$()echo $RANDOM | md5sum | head -c 16)" \
+  --env="APP_SECRET=$(openssl rand -hex 8 | tr -d '\n')" \
   --build-env=BP_PHP_SERVER=nginx \
   --build-env=BP_PHP_WEB_DIR=public \
   --build-env=BP_COMPOSER_INSTALL_OPTIONS="--ignore-platform-reqs --no-scripts -o"
@@ -30,7 +30,7 @@ nctl create app symfony \
 
 Symfony needs an `APP_SECRET` variable to be defined to a secret value. This is used for security relevant functionality.
 While it could be read from a `.env` file, it is more secure to set it as an environment variable.
-We set it to an initial value when creating the application. Unless when compromised, the secret should not be changed
+We set it to an initial value when creating the application. Unless compromised, the secret should not be changed
 anymore later on, otherwise existing user sessions will become invalid.
 
 ### Configure the Web Directory

docs/python/quick-start.md

@@ -14,7 +14,7 @@ We have a basic Python Django app in our [examples repository](https://github.co
 You can deploy it with `nctl`.
 The example application shows a random message on every page reload.
 The Django admin interface can be used to add messages.
-Just visit `https://<URL of app>/admin` to access it and use the credentials which you pass via the env variables below to login.
+Just visit `https://<URL of app>/admin` to access it and use the credentials which you pass via the env variables below to log in.
 Please also define the `SECRET_KEY` which is needed to secure signed data and should be kept secret.
 
 ```bash

docs/ruby/active-storage.md

@@ -182,7 +182,7 @@ Deploio needs to verify that you really own a domain name before
 it will accept HTTP traffic to your custom host on their side.
 So you need to add two DNS records at your DNS provider:
 * `CNAME` for your domain to `es34.objects.nineapis.ch`
-* `TXT` for record for ownership verification
+* `TXT` record for ownership verification
 
 The verification record can be retrieved via `nctl`:
 
@@ -235,7 +235,7 @@ to replace the host part of the generated and signed URL with your custom host.
 The proxy will pick it up and replace the custom host with the Deploio S3 host.
 The Nutanix S3 service can then verify the complete URL including signature.
 
-If you want to know more about the how this works, have a look at the lightning talk
+If you want to know more about how this works, have a look at the lightning talk
 ["Deploio S3"](https://docs.google.com/presentation/d/1o5LMgcUcVqqZlIQ5mCWJkD9CvYGFML6V7sQxMFkV6wg/edit?slide=id.g3b1e491c942_0_0#slide=id.g3b1e491c942_0_0).
 :::