Skip to content

Commit

Permalink
docs: initial i18n commit with poc ja text
Browse files Browse the repository at this point in the history
  • Loading branch information
tobybellwood committed Jun 3, 2024
1 parent 4531336 commit 7063f3d
Show file tree
Hide file tree
Showing 393 changed files with 11,711 additions and 204 deletions.
16 changes: 16 additions & 0 deletions docs/_data/defaults.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: example.com
webhookhandler: webhook.example.com
sshport: 22
sshhostname: ssh.example.com
apiaddress: api.example.com
helpstring: your Lagoon administrator
helpstring_ja: Lagoon 管理者

## Comment out any of the above, and uncomment the corresponding below to see the variables in action
# name: amazee.io
# webhookhandler: webhook.amazeeio.cloud
# sshport: 32222
# sshhostname: ssh.amazeeio.cloud
# apiaddress: api.amazeeio.cloud
# helpstring: "[amazee.io support](https://support.amazee.io)"
# helpstring: "[amazee.io support](mailto:[email protected])"
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ git push

This will trigger a push, and the Git hosting will inform Lagoon about this push via the configured webhook.

If all is correct, you will see a notification in your configured chat system (this is configured by your friendly Lagoon administrator):
If all is correct, you will see a notification in your configured chat system \(Contact {{ defaults.helpstring }} to configure this\):

![Slack notification of a deployment starting.](../../images/first_deployment_slack_start.jpg)

This tells you that Lagoon has just started to deploy your code. Depending on the size of the codebase and amount of containers, this will take a couple of seconds. Just relax. If you'd like to know what's happening now, check out the [Build and Deploy Process of Lagoon](../../concepts-basics/build-and-deploy-process.md).

You can also check your Lagoon UI to see the progress of any deployment (your Lagoon administrator has the info).
You can also check your Lagoon UI to see the progress of any deployment \(Contact {{ defaults.helpstring }} for the URL if you don't have it\).

## 3. A fail

Expand Down 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 Expand Up @@ -141,4 +141,4 @@ That's the beauty of Lagoon: it's exactly the same: Push the branch name you def
Did the deployment fail? Oh no! But we're here to help:

1. Click on the `logs` link in the error notification. It will tell you where in the deployment process the failure happened.
2. If you can't figure it out, ask your Lagoon administrator, they are here to help!
2. If you can't figure it out, contact {{ defaults.helpstring }}, they are here to help!
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Lagoon can utilize the [Aergia controller](https://github.com/amazeeio/aergia-co

### How does an environment get idled?

The environment idler has many different configuration capabilities. Here are the defaults of a standard Lagoon installation \(these could be quite different in your Lagoon, check with your Lagoon administrator!\)
The environment idler has many different configuration capabilities. Here are the defaults of a standard Lagoon installation \(these could be quite different in your Lagoon, Contact {{ defaults.helpstring }}!\)

* Idling is tried every 4 hours.
* Production environments are never idled.
Expand All @@ -25,4 +25,4 @@ The un-idling will take a couple of seconds, as the Kubernetes cluster needs to
Yes, there is a field `autoIdle` on the project \(impacts all environments\) and environment \(if you need to target just one environment\), as to whether idling is allowed to take place. A value of `1` indicates the project/environment is eligible for idling. If the project is set to `0` the environments will never be idled, even if the environment is set to `0`
The default is always `1`\(idling is enabled\).

Talk to your Lagoon administrator if you are unsure how to set these project/environment fields.
Contact {{ defaults.helpstring }} if you are unsure how to set these project/environment fields.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ But that's it. Lagoon itself handles `development` and `production` environments

There are a couple of things that will use this information:

* By default, `development` environments are idled after 4 hours with no hits \(don't worry, they wake up automatically\). It is also possible for your Lagoon administrator to disable auto-idling on a per-environment basis, just ask!
* By default, `development` environments are idled after 4 hours with no hits \(don't worry, they wake up automatically\). It is also possible for {{ defaults.helpstring }} to disable auto-idling on a per-environment basis, just ask!
* Our default Drupal `settings.php` files load additional settings files for `development.settings.php` and `production.settings.php` so you can define settings and configurations different per environment type.
* If you try to delete an environment that is defined as the production environment \(either via webhooks or REST\), Lagoon will politely refuse to delete the production environment, as it tries to prevent you from making a mistake. In order to delete a production environment, you can either change the `productionEnvironment` in the API or use the secret `forceDeleteProductionEnvironment: true` POST payload for the REST API.
* The Lagoon administrator might use the production environment information for some additional things. For example, at amazee.io we're calculating only the hits of the production environments to calculate the price of the hosting.
* {{ defaults.helpstring }} might use the production environment information for some additional things, such as calculating only the hits of the production environments to calculate the price of the hosting.
File renamed without changes.
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).
File renamed without changes.
File renamed without changes.
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 }}.
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).
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
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ 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. Ask your Lagoon administrator about this.
* `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
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).
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +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 your Lagoon administrator to oversee the transition.
with {{ defaults.helpstring }} to oversee the transition.

### Monitoring a specific path

Expand All @@ -285,7 +285,7 @@ When [UptimeRobot](https://uptimerobot.com/) is configured for your cluster \(Ku
### Ingress annotations

!!! Warning
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](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/). This is specifically useful for easy redirects and other configurations.

Expand Down Expand Up @@ -510,14 +510,14 @@ poly-project2:
???+ Info
If you run directly on amazee.io hosted Lagoon you will not need this key set.

With the key `api` you can define another URL that should be used by the Lagoon CLI and `drush` to connect to the Lagoon GraphQL API. This needs to be a full URL with a scheme, like: `http://localhost:3000` This usually does not need to be changed, but there might be situations where your Lagoon administrator tells you to do so.
With the key `api` you can define another URL that should be used by the Lagoon CLI and `drush` to connect to the Lagoon GraphQL API. This needs to be a full URL with a scheme, like: `http://localhost:3000` This usually does not need to be changed, but there might be situations where {{ defaults.helpstring }} tells you to do so.

### `ssh`

???+ Info
If you run directly on amazee.io hosted Lagoon you will not need this key set.

With the key `ssh` you can define another SSH endpoint that should be used by the Lagoon CLI and `drush` to connect to the Lagoon remote shell service. This needs to be a hostname and a port separated by a colon, like: `localhost:2020` This usually does not need to be changed, but there might be situations where your Lagoon administrator tells you to do so.
With the key `ssh` you can define another SSH endpoint that should be used by the Lagoon CLI and `drush` to connect to the Lagoon remote shell service. This needs to be a hostname and a port separated by a colon, like: `localhost:2020` This usually does not need to be changed, but there might be situations where {{ defaults.helpstring }} tells you to do so.

### `container-registries`

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions docs/interacting/graphql.md → docs/en/interacting/graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ To generate this token, use the remote shell via the `token` command:
ssh -p [PORT] -t lagoon@[HOST] token
```

Example for amazee.io:
{{ defaults.name }} connection string:

```bash title="Get amazee.io token"
ssh -p 32222 -t lagoon@ssh.lagoon.amazeeio.cloud token
```bash title="Get {{ defaults.name }} token"
ssh -p {{ defaults.sshport }} -t lagoon@{{ defaults.sshhostname }} token
```

This will return a long string, which is the JWT token.

We also need the URL of the API endpoint. Ask your Lagoon administrator for this.
We also need the URL of the API endpoint. {{ defaults.helpstring }} for this.
<!-- markdown-link-check-disable-next-line -->
On amazee.io this is [`https://api.lagoon.amazeeio.cloud/graphql`](https://api.lagoon.amazeeio.cloud/graphql).
For {{ defaults.name }} this is [`https://{{ defaults.apiaddress }}/graphql`](https://{{ defaults.apiaddress }}/graphql/graphql).

Now we need a GraphQL client! Technically this is just HTTP, but we suggest GraphiQL. It has a nice UI that allows you to write GraphQL requests with autocomplete. Download, install and start it. \[[GraphiQL App](https://github.com/skevy/graphiql-app)\]

Expand Down
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).
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/interacting/rbac.md → docs/en/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
Loading

0 comments on commit 7063f3d

Please sign in to comment.