Skip to content

Commit

Permalink
docs: small improvements
Browse files Browse the repository at this point in the history
Signed-off-by: Aleksei Igrychev <aleksei.igrychev@palark.com>
  • Loading branch information
alexey-igrychev committed Mar 9, 2023
1 parent d71cb02 commit ebdc608
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs_validate.yml
Expand Up @@ -70,7 +70,7 @@ jobs:
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}

- name: Login to GitHub Container Registry
- name: Login to GitHub container registry
uses: docker/login-action@v2
with:
registry: ghcr.io
Expand Down
2 changes: 1 addition & 1 deletion cmd/werf/export/export.go
Expand Up @@ -38,7 +38,7 @@ func NewExportCmd(ctx context.Context) *cobra.Command {
Short: "Export images",
Long: common.GetLongCommandDescription(GetExportDocs().Long),
DisableFlagsInUseLine: true,
Example: ` # Export images to Docker Hub and GitHub Container Registry
Example: ` # Export images to Docker Hub and GitHub container registry
$ werf export --tag=index.docker.io/company/project:%image%-latest --tag=ghcr.io/company/project/%image%:latest`,
Annotations: map[string]string{
common.DisableOptionsInUseLineAnno: "1",
Expand Down
2 changes: 1 addition & 1 deletion docs/_includes/reference/cli/werf_export.md
Expand Up @@ -19,7 +19,7 @@ werf export [IMAGE_NAME...] [options]
{{ header }} Examples

```shell
# Export images to Docker Hub and GitHub Container Registry
# Export images to Docker Hub and GitHub container registry
$ werf export --tag=index.docker.io/company/project:%image%-latest --tag=ghcr.io/company/project/%image%:latest
```

Expand Down
4 changes: 2 additions & 2 deletions docs/pages_en/usage/cleanup/cr_cleanup.md
Expand Up @@ -175,7 +175,7 @@ By default, werf uses the [_Docker Registry API_](https://docs.docker.com/regist
| _JFrog Artifactory_ | **ok** |
| _Nexus_ | **ok** |
| _Quay_ | **ok** |
| _Yandex Container Registry_ | **ok** |
| _Yandex container registry_ | **ok** |
| _Selectel CRaaS_ | [***ok**](#selectel-craas) |

werf tries to automatically detect the type of container registry using the repository address provided (via the `--repo` option). The user can explicitly specify the container registry using the `--repo-container-registry` option or via the `WERF_REPO_CONTAINER_REGISTRY` environment variable.
Expand Down Expand Up @@ -225,7 +225,7 @@ You can use the `--repo-github-token` option or the corresponding environment va

### GitLab Registry

werf uses the _GitLab Container Registry API_ or _Docker Registry API_ (depending on the GitLab version) to delete tags.
werf uses the _GitLab container registry API_ or _Docker Registry API_ (depending on the GitLab version) to delete tags.

> Privileges of the temporary CI job token (`$CI_JOB_TOKEN`) are not enough to delete tags. That is why the user have to create a dedicated token in the Access Token section (select the `api` in the Scope section) and perform authorization using it
Expand Down
6 changes: 3 additions & 3 deletions docs/pages_en/usage/deploy/deployment_scenarios.md
Expand Up @@ -79,11 +79,11 @@ werf build --repo example.org/mycompany/myapp
werf bundle publish --skip-build --tag latest --repo example.org/mycompany/myapp
```

## Deploying without access to an application's Git repository and Container Registry
## Deploying without access to an application's Git repository and container registry

Follow these five steps to deploy an application with no access to the application's Git repository and the container registry:

1. Build images and publish them to the Container Registry of the application.
1. Build images and publish them to the container registry of the application.

2. Add the passed parameters and publish the main chart to the OCI repository. The chart contains pointers to the images published in the first step.

Expand Down Expand Up @@ -240,4 +240,4 @@ cd /anywhere
werf dismiss --use-deploy-report
```

The custom path to the deployment report can be set with the `--deploy-report-path` parameter.
The custom path to the deployment report can be set with the `--deploy-report-path` parameter.
4 changes: 2 additions & 2 deletions docs/pages_en/usage/distribute/bundles.md
Expand Up @@ -145,7 +145,7 @@ Then the newly published bundle (a chart and its images) can be used as usual.

Publishing bundles requires a container registry to support the OCI ([Open Container Initiative](https://github.com/opencontainers/image-spec)) specification. Below is a list of the most popular container registries that have been tested and found to be compatible:

| Container Registry | Supports bundle publishing |
| Container registry | Supports bundle publishing |
|---------------------------|:-------------------------------:|
| AWS ECR | + |
| Azure CR | + |
Expand All @@ -155,6 +155,6 @@ Publishing bundles requires a container registry to support the OCI ([Open Conta
| GitLab Registry | + |
| Harbor | + |
| JFrog Artifactory | + |
| Yandex Container Registry | + |
| Yandex container registry | + |
| Nexus | + |
| Quay | - |
8 changes: 4 additions & 4 deletions docs/pages_ru/quickstart.md
Expand Up @@ -34,7 +34,7 @@ description: Разверните ваше первое приложение с
```
{% endraw %}

> **ВАЖНО.** С параметром `--insecure-registry` мы подготавливаем такое окружение, которое сможет работать с Container Registry без TLS. В нашем случае для упрощения настройка TLS отсутствует.
> **ВАЖНО.** С параметром `--insecure-registry` мы подготавливаем такое окружение, которое сможет работать с container registry без TLS. В нашем случае для упрощения настройка TLS отсутствует.
4. Установка NGINX Ingress Controller:

Expand All @@ -44,15 +44,15 @@ description: Разверните ваше первое приложение с
```
{% endraw %}

5. Установка Container Registry для хранения образов:
5. Установка container registry для хранения образов:

{% raw %}
```shell
minikube addons enable registry
```
{% endraw %}

Создадим Ingress для доступа к Container Registry.
Создадим Ingress для доступа к container registry.

{% raw %}
```shell
Expand Down Expand Up @@ -162,7 +162,7 @@ description: Разверните ваше первое приложение с
```
{% endraw %}

> **ВАЖНО.** С параметром `--insecure-registry` мы подготавливаем такое окружение, которое сможет работать с Container Registry без TLS. В нашем случае для упрощения настройка TLS отсутствует.
> **ВАЖНО.** С параметром `--insecure-registry` мы подготавливаем такое окружение, которое сможет работать с container registry без TLS. В нашем случае для упрощения настройка TLS отсутствует.
4. Установка NGINX Ingress Controller:

Expand Down
4 changes: 2 additions & 2 deletions docs/pages_ru/usage/cleanup/cr_cleanup.md
Expand Up @@ -175,7 +175,7 @@ cleanup:
| _JFrog Artifactory_ | **ок** |
| _Nexus_ | **ок** |
| _Quay_ | **ок** |
| _Yandex Container Registry_ | **ок** |
| _Yandex container registry_ | **ок** |
| _Selectel CRaaS_ | [***ок**](#selectel-craas) |

werf пытается автоматически определить используемый container registry, используя заданный адрес репозитория (опция `--repo`). Пользователь может явно задать container registry опцией `--repo-container-registry` или переменной окружения `WERF_REPO_CONTAINER_REGISTRY`.
Expand Down Expand Up @@ -224,7 +224,7 @@ HUB_TOKEN=$(curl -s -H "Content-Type: application/json" -X POST -d '{"username":

### GitLab Registry

При удалении тегов werf использует _GitLab Container Registry API_ или _Docker Registry API_ в зависимости от версии GitLab.
При удалении тегов werf использует _GitLab container registry API_ или _Docker Registry API_ в зависимости от версии GitLab.

> Для удаления тега прав временного токена CI-задания (`$CI_JOB_TOKEN`) недостаточно, поэтому пользователю необходимо создать специальный токен в разделе Access Token (в секции Scope необходимо выбрать `api`) и выполнить авторизацию с ним
Expand Down
4 changes: 2 additions & 2 deletions docs/pages_ru/usage/distribute/bundles.md
Expand Up @@ -145,7 +145,7 @@ werf bundle copy --from archive:archive.tar.gz --to other.example.org/bundles/my

Для публикации бандлов требуется container registry, поддерживающий спецификацию OCI ([Open Container Initiative](https://github.com/opencontainers/image-spec)). Список наиболее популярных container registries, совместимость с которыми была проверена:

| Container Registry | Поддерживает публикацию бандлов |
| Container registry | Поддерживает публикацию бандлов |
|---------------------------|:-------------------------------:|
| AWS ECR | + |
| Azure CR | + |
Expand All @@ -155,6 +155,6 @@ werf bundle copy --from archive:archive.tar.gz --to other.example.org/bundles/my
| GitLab Registry | + |
| Harbor | + |
| JFrog Artifactory | + |
| Yandex Container Registry | + |
| Yandex container registry | + |
| Nexus | + |
| Quay | - |

0 comments on commit ebdc608

Please sign in to comment.