Skip to content

Commit

Permalink
docs: post-merge fixup and another pass
Browse files Browse the repository at this point in the history
  • Loading branch information
tobybellwood committed May 21, 2024
1 parent cb1b5c8 commit 2a6364b
Show file tree
Hide file tree
Showing 18 changed files with 30 additions and 33 deletions.
8 changes: 4 additions & 4 deletions docs/applications/drupal/first-deployment-of-drupal.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,12 @@ You should see something like:

```bash title="Drush sql-sync results"
[drupal-example]cli-drupal:/app$ drush sql-sync @self @develop
You will destroy data in ssh.lagoon.amazeeio.cloud/drupal and replace with data from drupal.
You will destroy data in {{ defaults.sshhostname }}/drupal and replace with data from drupal.
Do you really want to continue? (y/n): y
Starting to dump database on Source. [ok]
Database dump saved to /home/drush-backups/drupal/20180227075813/drupal_20180227_075815.sql.gz [success]
Starting to discover temporary files directory on Destination. [ok]
You will delete files in drupal-example-develop@ssh.lagoon.amazeeio.cloud:/tmp/drupal_20180227_075815.sql.gz and replace with data from /home/drush-backups/drupal/20180227075813/drupal_20180227_075815.sql.gz
You will delete files in drupal-example-develop@{{ defaults.sshhostname }}:/tmp/drupal_20180227_075815.sql.gz and replace with data from /home/drush-backups/drupal/20180227075813/drupal_20180227_075815.sql.gz
Do you really want to continue? (y/n): y
Copying dump file from Source to Destination. [ok]
Starting to import dump file onto Destination database.
Expand Down Expand Up @@ -103,15 +103,15 @@ It should show you something like:

```bash title="Drush rsync results"
[drupal-example]cli-drupal:/app$ drush rsync @self:%files @develop:%files
You will delete files in drupal-example-develop@ssh.lagoon.amazeeio.cloud:/app/web/sites/default/files and replace with data from /app/web/sites/default/files/
You will delete files in drupal-example-develop@{{ defaults.sshhostname }}:/app/web/sites/default/files and replace with data from /app/web/sites/default/files/
Do you really want to continue? (y/n): y
```

In some cases, though, it might not look correct, like here:

```bash title="Drush rsync results"
[drupal-example]cli-drupal:/app$ drush rsync @self:%files @develop:%files
You will delete files in drupal-example-develop@ssh.lagoon.amazeeio.cloud:'/app/web/%files' and replace with data from '/app/web/%files'/
You will delete files in drupal-example-develop@{{ defaults.sshhostname }}:'/app/web/%files' and replace with data from '/app/web/%files'/
Do you really want to continue? (y/n):
```

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts-advanced/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This section covers some of the more advanced concepts in Lagoon. If you're new to Lagoon, start with [Basic Lagoon Concepts](../concepts-basics/index.md).

If you need help, contact your Lagoon administrator or reach out to the community and maintainers in our [Discord](../community/discord.md).
If you need help, contact {{ defaults.helpstring }} or reach out to the community and maintainers in our [Discord](../community/discord.md).
2 changes: 1 addition & 1 deletion docs/concepts-basics/building-blocks/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

_Groups_ are made up of users who have roles. An organization can have one or more groups. Each project can be assigned one or more groups. Groups can be assigned to multiple projects. Groups are created independently of projects, and then assigned to them.

Organizations have a quota to limit the number of groups assigned to it. If you need to change the quota, please contact your Lagoon administrator.
Organizations have a quota to limit the number of groups assigned to it. If you need to change the quota, please contact {{ defaults.helpstring }}.
2 changes: 1 addition & 1 deletion docs/concepts-basics/building-blocks/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ An _organization_ is an entity which can contain one or more projects, groups, u

Organizations add a layer of structure to help imitate life - for example, you may be a project manager who creates an organization to reflect the team working on a specific site. So that organization would contain the project or projects that make up that site, all of the people who need access to work on the site as users in a group called _developers_, and maybe another group of people who just need access to Lagoon to view the site and any issues, called _viewers_, each with the appropriate roles.

Organizations have a quota to limit the number of projects, groups, notifications, and environments that can be assigned to it. If you need to change this quota, please contact your Lagoon administrator.
Organizations have a quota to limit the number of projects, groups, notifications, and environments that can be assigned to it. If you need to change this quota, please contact {{ defaults.helpstring }}.

[Learn more about how to interact with Organizations](../../interacting/organizations.md).
2 changes: 1 addition & 1 deletion docs/concepts-basics/building-blocks/roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Members of organizations can be given the following roles:

!!! info inline end "Changing Quotas"

If you need to change quotas, please contact your Lagoon administrator.
If you need to change quotas, please contact {{ defaults.helpstring }}.

An _organization owner_ can do everything to do with administering an organization aside from changing quotas. They can add and delete users, groups, projects, deploy targets, and notifcations

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts-basics/docker-compose-yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ In many cases, Lagoon knows where that persistent storage needs to go. For examp

* `lagoon.persistent` - The **absolute** path where the persistent storage should be mounted (the above example uses `/app/web/sites/default/files/` which is where Drupal expects its persistent storage).
* `lagoon.persistent.name` - Tells Lagoon to not create a new persistent storage for that service, but instead mounts the persistent storage of another defined service into this service.
* `lagoon.persistent.size` - The size of persistent storage you require \(Lagoon usually gives you minimum 5G of persistent storage, if you need more, define it here\).
* `lagoon.persistent.class` - By default Lagoon automatically assigns the right storage class for your service \(like SSDs for MySQL, bulk storage for Nginx, etc.\). If you need to overwrite this, you can do so here. This is highly dependent on the underlying Kubernetes/OpenShift that Lagoon runs on. Contact {{ defaults.helpstring }} for this.
* `lagoon.persistent.size` - The size of persistent storage you require (Lagoon usually gives you minimum 5G of persistent storage, if you need more, define it here).
* `lagoon.persistent.class` - By default Lagoon automatically assigns the right storage class for your service (like SSDs for MySQL, bulk storage for Nginx, etc.). If you need to overwrite this, you can do so here. This is highly dependent on the underlying Kubernetes/OpenShift that Lagoon runs on. Contact {{ defaults.helpstring }} for this.

### Auto-generated Routes

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts-basics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This section covers some of the basic concepts in Lagoon. If you're already familiar with these, move on to [Advanced Lagoon Concepts](../concepts-advanced/index.md).

If you need help, contact your Lagoon administrator or reach out to the community and maintainers in our [Discord](../community/discord.md).
If you need help, contact {{ defaults.helpstring }} or reach out to the community and maintainers in our [Discord](../community/discord.md).
5 changes: 1 addition & 4 deletions docs/concepts-basics/lagoon-yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,10 +271,7 @@ that's important!):
!!! Info
If you plan to switch from a SSL certificate signed by a Certificate
Authority (CA) to a Let's Encrypt certificate, it's best to get in touch
with {{ defaults.helpstring }} to oversee the transition. There are [known
issues](https://github.com/tnozicka/openshift-acme/issues/68) during the
transition. The workaround would be manually removing the CA certificate and
then triggering the Let's Encrypt process.
with {{ defaults.helpstring }} to oversee the transition.

### Monitoring a specific path

Expand Down
2 changes: 1 addition & 1 deletion docs/interacting/lagoon-ui.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# The Lagoon UI

The Lagoon UI can be accessed at https://ui-lagoon-master.ch.amazee.io. If you have any issues with access, please contact your Lagoon administrator.
The Lagoon UI is your first point of call with Lagoon. If you have any issues with access, please contact {{ defaults.helpstring }}.

The UI allows you to complete a variety of tasks with your projects and organizations. [Learn more about organizations here](../concepts-basics/building-blocks/organizations.md). and [what you can do with organizations in the UI here](../interacting/organizations.md).
2 changes: 1 addition & 1 deletion docs/interacting/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The organization owner role allows for the creation and deletion of projects, gr

They can add users to groups, change the roles of users within those groups, and associate projects with groups. This gives the organization owner the ability to clearly see who has access, and quickly add and remove users.

Organization owners now also have the ability to create Slack or other notifications directly, and associate those notifications with a project without requiring help from a Lagoon administrator.
Organization owners now also have the ability to create Slack or other notifications directly, and associate those notifications with a project without requiring help from {{ defaults.helpstring }}.

!!! Warning "NOTE"
By default this role does not allow organization owners to create environments or trigger deployments within a project. They can add themselves to a group with a role that does grant them this permission. When creating a project, an organization owner can opt to be added as an owner of the project default group.
Expand Down
12 changes: 6 additions & 6 deletions docs/lagoonizing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ If you don’t have one already, you’ll need a Git client of some kind. Comman
- [GitHub Desktop](https://desktop.github.com/) (Mac, Windows)
- [GitKraken](https://www.gitkraken.com/git-client) (Mac, Windows, Linux - free for public repositories)

## What Your Lagoon Administrator Needs
## What {{ defaults.helpstring }} Needs

Your Lagoon administrator, the person who is setting up your Lagoon, will need some information, [which is detailed here](../using-lagoon-the-basics/setup-project.md).
The person setting up your Lagoon, usually {{ defaults.helpstring }} will need some information, [which is detailed here](../using-lagoon-the-basics/setup-project.md).

## Configure Webhooks

Expand Down Expand Up @@ -379,7 +379,7 @@ The simplest route is the `example.com` example in our sample `.lagoon.yml` abov
#### Annotations

!!! info
Route/Ingress annotations are only supported by projects that deploy into clusters that run nginx-ingress controllers! Check with your Lagoon administrator if this is supported.
Route/Ingress annotations are only supported by projects that deploy into clusters that run nginx-ingress controllers! Check with {{ defaults.helpstring }} if this is supported.

Annotations can be a YAML map of annotations supported by the `nginx-ingress` controller, this is specifically useful for easy redirects:

Expand Down Expand Up @@ -426,7 +426,7 @@ You can of course also redirect to any other URL not hosted on Lagoon. This will
- Only the `max-age` parameter is required. The required max-age parameter indicates the length of time, in seconds, the HSTS policy is in effect for.

!!! info
If you plan to switch from a SSL certificate signed by a Certificate Authority (CA) to a Let's Encrypt certificate, it's best to get in touch with your Lagoon administrator to oversee the transition.
If you plan to switch from a SSL certificate signed by a Certificate Authority (CA) to a Let's Encrypt certificate, it's best to get in touch with {{ defaults.helpstring }} to oversee the transition.

#### `environments.[name].types`

Expand Down Expand Up @@ -693,8 +693,8 @@ A Drupal site also consists of the files directory. To migrate your files from y

## Deploy

If you’ve done everything in this guide, and your amazee.io administrator has everything set up, you are now ready to deploy your site!
If you’ve done everything in this guide, and {{ defaults.helpstring }} has everything set up, you are now ready to deploy your site!

If you are deploying a Drupal site, [follow this deployment guide](../applications/drupal/first-deployment-of-drupal.md).

For all other deployments, [follow this deployment guide](../using-lagoon-the-basics/first-deployment.md).
For all other deployments, [follow this deployment guide](../using-lagoon-the-basics/first-deployment.md).
4 changes: 2 additions & 2 deletions docs/logging/kibana-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ Running the query above will give you a general look at all the traffic to your
We are going to start off with the same query as above, but we are going to add a couple of things.

* First, add the following fields: `client_ip` and `http_request`.
* This will show you a list of all IP addresses and the page they requested. Here is what we see for the Amazee.io page:
* This will show you a list of all IP addresses and the page they requested. Here is what we see for the amazee.io website:

![All IP addresses and the page they requested.](../images/kibana_example2.png)

That looks good, but what if we wanted to just show requests from a specific IP address? You can filter for the address by adding it to your search criteria.

* We are going to add: `AND client_ip: "IP address"`.
* That will filter the results to just show you hits from that specific IP address, and the page they were requesting. Here is what it looks like for our Amazee.io website:
* That will filter the results to just show you hits from that specific IP address, and the page they were requesting. Here is what it looks like for our amazee.io website:

![Hits from a specific IP address.](../images/kibana_example3.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ This typically indicates an issue with Pygmy. You can find our troubleshooting d
## How do I remove a route?
Lagoon will detect the removal of routes from your `.lagoon.yml` during a deployment. Check the deployment logs to confirm that the routes were removed automatically or for instructions on how to remove them. You may also contact {{ defaults.helpstring }} if you need to remove a route.
Lagoon will detect the removal of routes from your `.lagoon.yml` during a deployment. Check the deployment logs to confirm that the routes were removed automatically or for instructions on how to remove them.
## When I run `pygmy status`, no keys are loaded
Expand Down Expand Up @@ -137,8 +137,8 @@ Once you've added a runtime environment variable to your production environment
For cloud hosting customers, you can SFTP to your Lagoon environment by using the following information:
* Server Hostname: `ssh.lagoon.amazeeio.cloud`
* Port: 32222
* Server Hostname: `{{ defaults.sshhostname }}`
* Port: {{ defaults.sshport }}
* Username: <Project-Environment-Name>
Your username is going to be the name of the environment you are connecting to, most commonly in the pattern _`PROJECTNAME-ENVIRONMENT`_.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ description: >-
| Puppet | An open-source software configuration management and deployment tool. |
| PV | PersistentVolume - a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes.|
| PVC | Persistent Volume Claim - a request for storage by a user. |
| Pygmy | An amazee.io flavored local development system. |
| Pygmy | A Lagoon flavored local development system. |
| Python | Python is an open-source, interpreted, high-level, general-purpose programming language. |
| RabbitMQ | An open-source message-broker software. |
| RBAC | Role-Based Access Control |
Expand Down
2 changes: 1 addition & 1 deletion docs/using-lagoon-advanced/custom-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The values that the user selects will be available as environment variables in t

### System wide tasks

Platform administrators are able to register system wide tasks. These tasks will appear for all environments, subject to the user's permission to invoke them.
Only {{ defaults.helpstring }} is able to register system wide tasks. These tasks will appear for all environments, subject to the user's permission to invoke them.

Creating a system wide task is almost exactly the same as other task types, with two exceptions.

Expand Down
2 changes: 1 addition & 1 deletion docs/using-lagoon-advanced/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This section covers some of the more advanced features and functionality of Lagoon. If you're new to Lagoon, start with [Using Lagoon - the Basics](../using-lagoon-the-basics/index.md).

If you need help, contact your Lagoon administrator or reach out to the community and maintainers in our [Discord](../community/discord.md).
If you need help, contact {{ defaults.helpstring }} or reach out to the community and maintainers in our [Discord](../community/discord.md).
2 changes: 1 addition & 1 deletion docs/using-lagoon-the-basics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This section covers some of the basic features and functionality in Lagoon. If you're familiar with these, move on to [Using Lagoon - Advanced](../using-lagoon-advanced/index.md).

If you need help, contact your Lagoon administrator or reach out to the community and maintainers in our [Discord](../community/discord.md).
If you need help, contact {{ defaults.helpstring }} or reach out to the community and maintainers in our [Discord](../community/discord.md).

## Requirements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Newer releases of Lagoon have the capability to identify potential issues with t

For example, if the Lagoon team makes a change to a setting in `lagoon.yml`, and there’s something that users need to change, the warning will mention it, so users will be able to change it before it becomes a breaking change. They should be resolved ASAP wherever possible, as future releases of Lagoon may not be able to handle the errors, but they shouldn't stop your build.

If you aren't sure how to resolve these errors, please reach out to your Lagoon administrator, or ask a question in the [Lagoon community](../community/discord.md).
If you aren't sure how to resolve these errors, please reach out to {{ defaults.helpstring }}, or ask a question in the [Lagoon community](../community/discord.md).

## Docker Compose Errors

Expand Down

0 comments on commit 2a6364b

Please sign in to comment.