Skip to content

Commit 73985b9

Browse files
authored
More Japanese localization (circleci#3011)
Localizing following pages building-docker-images.md caching.md examples.md env-vars.md
1 parent 5a89771 commit 73985b9

File tree

8 files changed

+1154
-52
lines changed

8 files changed

+1154
-52
lines changed

jekyll/_cci2/building-docker-images.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Then, the sample CircleCI `.circleci/config.yml` snippets below populate and bac
215215
docker cp $CACHE_PATH/. $NAME:/backup
216216
docker-compose -f docker-compose.yml -f docker/circle-dockup.yml up --no-recreate $NAME
217217
docker rm -f $NAME
218-
218+
219219
# Back up the same volume to circle cache
220220
- run:
221221
name: Backing up bundler cache from docker volumes
@@ -239,7 +239,8 @@ Thanks to ryansch for contributing this example.
239239

240240
[Docker Layer Caching]({{ site.baseurl }}/2.0/docker-layer-caching/)
241241

242+
[job-space]({{ site.baseurl }}/2.0/glossary/#job-space)
243+
244+
[primary-container]({{ site.baseurl }}/2.0/glossary/#primary-container)
242245

243-
[job-space]: {{ site.baseurl }}/2.0/glossary/#job-space
244-
[primary-container]: {{ site.baseurl }}/2.0/glossary/#primary-container
245-
[docker-layer-caching]: {{ site.baseurl }}/2.0/glossary/#docker-layer-caching
246+
[docker-layer-caching]({{ site.baseurl }}/2.0/glossary/#docker-layer-caching)

jekyll/_cci2/caching.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ categories: [optimization]
77
order: 50
88
---
99

10-
Caching is one of the most effective ways to make jobs faster on CircleCI by reusing the data from expensive fetch operations from previous jobs.
10+
Caching is one of the most effective ways to make jobs faster on CircleCI by reusing the data from expensive fetch operations from previous jobs.
1111

1212
* TOC
1313
{:toc}
1414

15-
After an initial job run, future instances of the job will run faster by not redoing work.
15+
After an initial job run, future instances of the job will run faster by not redoing work.
1616

1717
![caching data flow]( {{ site.baseurl }}/assets/img/docs/Diagram-v3-Cache.png)
1818

@@ -36,9 +36,9 @@ Caching keys are simple to configure. The following example updates a cache if i
3636
## Introduction
3737
{:.no_toc}
3838
39-
Automatic dependency caching is not available in CircleCI 2.0, so it is important to plan and implement your caching strategy to get the best performance. Manual configuration in 2.0 enables more advanced strategies and finer control.
39+
Automatic dependency caching is not available in CircleCI 2.0, so it is important to plan and implement your caching strategy to get the best performance. Manual configuration in 2.0 enables more advanced strategies and finer control.
4040
41-
This document describes the manual caching available, the costs and benefits of a chosen strategy, and tips for avoiding problems with caching. **Note:** The Docker images used for CircleCI 2.0 job runs are automatically cached on the server infrastructure where possible.
41+
This document describes the manual caching available, the costs and benefits of a chosen strategy, and tips for avoiding problems with caching. **Note:** The Docker images used for CircleCI 2.0 job runs are automatically cached on the server infrastructure where possible.
4242
4343
For information about enabling a premium feature to reuse the unchanged layers of your Docker image, see the [Enabling Docker Layer Caching]({{ site.baseurl }}/2.0/docker-layer-caching/) document.
4444
@@ -49,13 +49,13 @@ A cache stores a hierarchy of files under a key. Use the cache to store data tha
4949
5050
Caching is a balance between reliability (not using an out-of-date or inappropriate cache) and getting maximum performance (using a full cache for every build).
5151
52-
In general it is safer to preserve reliability than to risk a corrupted build or to build using stale dependencies very quickly. So, the ideal is to balance performance gains while maintaining high reliability.
52+
In general it is safer to preserve reliability than to risk a corrupted build or to build using stale dependencies very quickly. So, the ideal is to balance performance gains while maintaining high reliability.
5353
54-
## Caching Libraries
54+
## Caching Libraries
5555
5656
The dependencies that are most important to cache during a job are the libraries on which your project depends. For example, cache the libraries that are installed with `pip` in Python or `npm` for Node.js. The various language dependency managers, for example `npm` or `pip`, each have their own paths where dependencies are installed. See our Language guides and demo projects for the specifics for your stack: <https://circleci.com/docs/2.0/demo-apps/>.
5757

58-
Tools that are not explicitly required for your project are best stored on the Docker image. The Docker image(s) pre-built by CircleCI have tools preinstalled that are generic for building projects using the language the image is focused on. For example the `circleci/ruby:2.4.1` image has useful tools like git, openssh-client, and gzip preinstalled.
58+
Tools that are not explicitly required for your project are best stored on the Docker image. The Docker image(s) pre-built by CircleCI have tools preinstalled that are generic for building projects using the language the image is focused on. For example the `circleci/ruby:2.4.1` image has useful tools like git, openssh-client, and gzip preinstalled.
5959

6060
## Source Caching
6161

@@ -70,9 +70,9 @@ As in CircleCI 1.0, it is possible and oftentimes beneficial to cache your git r
7070
- source-v1-{{ .Branch }}-{{ .Revision }}
7171
- source-v1-{{ .Branch }}-
7272
- source-v1-
73-
73+
7474
- checkout
75-
75+
7676
- save_cache:
7777
key: source-v1-{{ .Branch }}-{{ .Revision }}
7878
paths:
@@ -97,13 +97,13 @@ Even with the narrowest `restore_cache` option ({% raw %}`source-v1-{{ .Branch }
9797

9898
That said, it's worth comparing build times with and without source caching; `git clone` is often faster than `restore_cache`.
9999

100-
**NOTE**: The built-in `checkout` command disables git's automatic garbage
100+
**NOTE**: The built-in `checkout` command disables git's automatic garbage
101101
collection. You might choose to manually run `git gc` in a `run` step prior to
102102
running `save_cache` to reduce the size of the saved cache.
103103

104104
## Writing to the Cache in Workflows
105105

106-
Jobs in one workflow can share caches. Note that this makes it possibile to create race conditions in caching across different jobs in workflows.
106+
Jobs in one workflow can share caches. Note that this makes it possible to create race conditions in caching across different jobs in workflows.
107107

108108
Cache is immutable on write: once a cache is written for a particular key like `node-cache-master`, it cannot be written to again. Consider a workflow of 3 jobs, where Job3 depends on Job1 and Job2: {Job1, Job2} -> Job3. They all read and write to the same cache key.
109109

@@ -166,7 +166,7 @@ For example, you may want to clear the cache in the following scenarios by incre
166166

167167
## Basic Example of Dependency Caching
168168

169-
The extra control and power in CircleCI 2.0 manual dependency caching requires that you be explicit about what you cache and how you cache it. See the [save cache section](https://circleci.com/docs/2.0/configuration-reference/#save_cache) of the Configuring CircleCI document for additional examples.
169+
The extra control and power in CircleCI 2.0 manual dependency caching requires that you be explicit about what you cache and how you cache it. See the [save cache section]({{ site.baseurl }}/2.0/configuration-reference/#save_cache) of the Configuring CircleCI document for additional examples.
170170

171171
To save a cache of a file or directory, add the `save_cache` step to a job in your `.circleci/config.yml` file:
172172

@@ -182,7 +182,7 @@ To save a cache of a file or directory, add the `save_cache` step to a job in yo
182182
The path for directories is relative to the `working_directory` of your job. You can specify an absolute path if you choose.
183183

184184
**Note:**
185-
Unlike the special step [`persist_to_workspace`](https://circleci.com/docs/2.0/configuration-reference/#persist_to_workspace),
185+
Unlike the special step [`persist_to_workspace`]({{ site.baseurl }}/2.0/configuration-reference/#persist_to_workspace),
186186
neither `save_cache` nor `restore_cache` support globbing for the `paths` key.
187187

188188
## Using Keys and Templates

jekyll/_cci2/configuration-reference.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ jobs:
259259
aws_secret_access_key: $ECR_AWS_SECRET_ACCESS_KEY # or project UI envar reference
260260
```
261261

262-
It is possible to reuse [declared commands]({{ site.baseurl }}/2.0/reusing-config/) in a job when using version 2.1. The following example invokes the `sayhello` command.
262+
It is possible to reuse [declared commands]({{ site.baseurl }}/2.0/reusing-config/) in a job when using version 2.1. The following example invokes the `sayhello` command.
263263

264264

265265
```
@@ -403,7 +403,7 @@ A job that was not executed due to configured rules will show up in the list of
403403

404404
**Note:** You must [open a support ticket](https://support.circleci.com/hc/en-us/requests/new) to have a CircleCI Sales representative contact you about enabling this feature on your account for an additional fee.
405405

406-
After this feature is added to your paid plan, it is possible to configure CPU and RAM resources for each job as described in the following table. If `resource_class` is not specified or an invalid class is specified, the default `resource_class: medium` will be used. The `resource_class` key is currently only available for use with the `docker` executor.
406+
After this feature is added to your paid plan, it is possible to configure CPU and RAM resources for each job as described in the following table. If `resource_class` is not specified or an invalid class is specified, the default `resource_class: medium` will be used. The `resource_class` key is currently only available for use with the `docker` executor.
407407

408408
Class | vCPUs | RAM
409409
------------|-----------|------
@@ -414,7 +414,7 @@ large | 4 | 8GB
414414
xlarge | 8 | 16GB
415415
{: class="table table-striped"}
416416

417-
Java, Erlang and any other languages that introspect the `/proc` directory for information about CPU count may require additional configuration to prevent them from slowing down when using the CircleCI 2.0 resource class feature. Programs with this issue may request 32 CPU cores and run slower than they would when requesting one core. Users of languages with this issue should pin their CPU count to their guaranteed CPU resources.
417+
Java, Erlang and any other languages that introspect the `/proc` directory for information about CPU count may require additional configuration to prevent them from slowing down when using the CircleCI 2.0 resource class feature. Programs with this issue may request 32 CPU cores and run slower than they would when requesting one core. Users of languages with this issue should pin their CPU count to their guaranteed CPU resources.
418418

419419
#### **`steps`**
420420

@@ -647,13 +647,13 @@ workflows:
647647
jobs:
648648
- job_with_optional_custom_checkout:
649649
custom_checkout: \"any non-empty string is truthy\"
650-
- job_with_optional_custom_checkout
650+
- job_with_optional_custom_checkout
651651
```
652652
653653
##### **`checkout`**
654654
655655
Special step used to check out source code to the configured `path` (defaults to the `working_directory`).
656-
The reason this is a special step is because it is more of a helper function designed to make checking out code easy for you. If you require doing git over HTTPS you should not use this step as it configures git to checkout over ssh.
656+
The reason this is a special step is because it is more of a helper function designed to make checking out code easy for you. If you require doing git over HTTPS you should not use this step as it configures git to checkout over ssh.
657657
658658
Key | Required | Type | Description
659659
----|-----------|------|------------
@@ -720,7 +720,7 @@ Template | Description
720720
{% raw %}`{{ .Revision }}`{% endraw %} | The VCS revision currently being built.
721721
{% raw %}`{{ .CheckoutKey }}`{% endraw %} | The SSH key used to checkout the repo.
722722
{% raw %}`{{ .Environment.variableName }}`{% endraw %} | The environment variable `variableName` (supports any environment variable [exported by CircleCI](https://circleci.com/docs/2.0/env-vars/#circleci-environment-variable-descriptions) or added to a specific [Context](https://circleci.com/docs/2.0/contexts)—not any arbitrary environment variable).
723-
{% raw %}`{{ checksum "filename" }}`{% endraw %} | A base64 encoded SHA256 hash of the given filename's contents. This should be a file committed in your repo and may also be referenced as a path that is absolute or relative from the current working directory. Good candidates are dependency manifests, such as `package.json`, `pom.xml` or `project.clj`. It's important that this file does not change between `restore_cache` and `save_cache`, otherwise the cache will be saved under a cache key different than the one used at `restore_cache` time.
723+
{% raw %}`{{ checksum "filename" }}`{% endraw %} | A base64 encoded SHA256 hash of the given filename's contents. This should be a file committed in your repo and may also be referenced as a path that is absolute or relative from the current working directory. Good candidates are dependency manifests, such as `package.json`, `pom.xml` or `project.clj`. It's important that this file does not change between `restore_cache` and `save_cache`, otherwise the cache will be saved under a cache key different than the one used at `restore_cache` time.
724724
{% raw %}`{{ epoch }}`{% endraw %} | The current time in seconds since the unix epoch.
725725
{% raw %}`{{ arch }}`{% endraw %} | The OS and CPU information. Useful when caching compiled binaries that depend on OS and CPU architecture, for example, `darwin amd64` versus `linux i386/32-bit`.
726726
{: class="table table-striped"}
@@ -927,25 +927,25 @@ baz
927927
- build/*
928928
```
929929

930-
The `paths` list uses `Glob` from Go, and the pattern matches [filepath.Match](https://golang.org/pkg/path/filepath/#Match).
931-
932-
```
933-
pattern:
934-
{ term }
935-
term:
936-
'*' matches any sequence of non-Separator characters
937-
'?' matches any single non-Separator character
938-
'[' [ '^' ] { character-range }
939-
']' character class (must be non-empty)
940-
c matches character c (c != '*', '?', '\\', '[')
941-
'\\' c matches character c
942-
character-range:
943-
c matches character c (c != '\\', '-', ']')
944-
'\\' c matches character c
945-
lo '-' hi matches character c for lo <= c <= hi
946-
```
947-
948-
The Go documentation states that the pattern may describe hierarchical names such as `/usr/*/bin/ed` (assuming the Separator is '/'). **Note:** Everything must be relative to the work space root directory.
930+
The `paths` list uses `Glob` from Go, and the pattern matches [filepath.Match](https://golang.org/pkg/path/filepath/#Match).
931+
932+
```
933+
pattern:
934+
{ term }
935+
term:
936+
'*' matches any sequence of non-Separator characters
937+
'?' matches any single non-Separator character
938+
'[' [ '^' ] { character-range }
939+
']' character class (must be non-empty)
940+
c matches character c (c != '*', '?', '\\', '[')
941+
'\\' c matches character c
942+
character-range:
943+
c matches character c (c != '\\', '-', ']')
944+
'\\' c matches character c
945+
lo '-' hi matches character c for lo <= c <= hi
946+
```
947+
948+
The Go documentation states that the pattern may describe hierarchical names such as `/usr/*/bin/ed` (assuming the Separator is '/'). **Note:** Everything must be relative to the work space root directory.
949949
950950
##### **`attach_workspace`**
951951
@@ -1021,7 +1021,7 @@ version | Y | String | Should currently be `2`
10211021
A unique name for your workflow.
10221022

10231023
#### **`triggers`**
1024-
Specifies which triggers will cause this workflow to be executed. Default behavior is to trigger the workflow when pushing to a branch.
1024+
Specifies which triggers will cause this workflow to be executed. Default behavior is to trigger the workflow when pushing to a branch.
10251025

10261026
Key | Required | Type | Description
10271027
----|-----------|------|------------
@@ -1055,7 +1055,7 @@ cron | Y | String | See the [crontab man page](http://pubs.opengroup.org/onlinep
10551055
{: class="table table-striped"}
10561056

10571057
###### **`filters`**
1058-
Filters can have the key `branches`.
1058+
Filters can have the key `branches`.
10591059

10601060
Key | Required | Type | Description
10611061
----|-----------|------|------------
@@ -1275,20 +1275,20 @@ jobs:
12751275
# Upload test results
12761276
- store_test_results:
12771277
path: /tmp/test-reports
1278-
1278+
12791279
deploy-stage:
12801280
docker:
12811281
- image: ubuntu:14.04
1282-
working_directory: /tmp/my-project
1282+
working_directory: /tmp/my-project
12831283
steps:
12841284
- run:
12851285
name: Deploy if tests pass and branch is Staging
1286-
command: ansible-playbook site.yml -i staging
1287-
1286+
command: ansible-playbook site.yml -i staging
1287+
12881288
deploy-prod:
12891289
docker:
12901290
- image: ubuntu:14.04
1291-
working_directory: /tmp/my-project
1291+
working_directory: /tmp/my-project
12921292
steps:
12931293
- run:
12941294
name: Deploy if tests pass and branch is Master

jekyll/_cci2/examples.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: classic-docs
33
title: "Testing Config Files Locally"
4-
description: "Example CircleCI 2.0 Configuration Files"
4+
description: "Testing Config Files Locally"
55
---
66

77
<div class="alert alert-info" role="alert">
@@ -21,7 +21,7 @@ To add a script that tests your config file locally, complete the following step
2121
- Source for project
2222
- Project name
2323
- Branch from which to build
24-
5. Add those values into your shell script.
24+
5. Add those values into your shell script.
2525

2626
```bash
2727
#!/usr/bin/env bash
@@ -38,4 +38,3 @@ Now you can run the shell script and debug your `config.yml` file without having
3838
## See Also
3939

4040
[Using the Local CircleCI CLI]({{ site.baseurl }}/2.0/local-cli/)
41-

0 commit comments

Comments
 (0)