From ebdc60878220e5bf7e062098ea48305fa08a5d12 Mon Sep 17 00:00:00 2001 From: Aleksei Igrychev Date: Thu, 9 Mar 2023 13:41:35 +0000 Subject: [PATCH] docs: small improvements Signed-off-by: Aleksei Igrychev --- .github/workflows/docs_validate.yml | 2 +- cmd/werf/export/export.go | 2 +- docs/_includes/reference/cli/werf_export.md | 2 +- docs/pages_en/usage/cleanup/cr_cleanup.md | 4 ++-- docs/pages_en/usage/deploy/deployment_scenarios.md | 6 +++--- docs/pages_en/usage/distribute/bundles.md | 4 ++-- docs/pages_ru/quickstart.md | 8 ++++---- docs/pages_ru/usage/cleanup/cr_cleanup.md | 4 ++-- docs/pages_ru/usage/distribute/bundles.md | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 2691b35f8d..53c988e5d1 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -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 diff --git a/cmd/werf/export/export.go b/cmd/werf/export/export.go index 7cd9ba8e13..02c6ded8de 100644 --- a/cmd/werf/export/export.go +++ b/cmd/werf/export/export.go @@ -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", diff --git a/docs/_includes/reference/cli/werf_export.md b/docs/_includes/reference/cli/werf_export.md index fa7d4b5e2c..598d646cf9 100644 --- a/docs/_includes/reference/cli/werf_export.md +++ b/docs/_includes/reference/cli/werf_export.md @@ -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 ``` diff --git a/docs/pages_en/usage/cleanup/cr_cleanup.md b/docs/pages_en/usage/cleanup/cr_cleanup.md index b36329d6fc..d87934cc0c 100644 --- a/docs/pages_en/usage/cleanup/cr_cleanup.md +++ b/docs/pages_en/usage/cleanup/cr_cleanup.md @@ -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. @@ -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 diff --git a/docs/pages_en/usage/deploy/deployment_scenarios.md b/docs/pages_en/usage/deploy/deployment_scenarios.md index e6902b66fe..6c169ed12e 100644 --- a/docs/pages_en/usage/deploy/deployment_scenarios.md +++ b/docs/pages_en/usage/deploy/deployment_scenarios.md @@ -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. @@ -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. \ No newline at end of file +The custom path to the deployment report can be set with the `--deploy-report-path` parameter. diff --git a/docs/pages_en/usage/distribute/bundles.md b/docs/pages_en/usage/distribute/bundles.md index 767fe84ee2..f6f768953b 100644 --- a/docs/pages_en/usage/distribute/bundles.md +++ b/docs/pages_en/usage/distribute/bundles.md @@ -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 | + | @@ -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 | - | diff --git a/docs/pages_ru/quickstart.md b/docs/pages_ru/quickstart.md index 10d66f5675..008a39e6e8 100644 --- a/docs/pages_ru/quickstart.md +++ b/docs/pages_ru/quickstart.md @@ -34,7 +34,7 @@ description: Разверните ваше первое приложение с ``` {% endraw %} - > **ВАЖНО.** С параметром `--insecure-registry` мы подготавливаем такое окружение, которое сможет работать с Container Registry без TLS. В нашем случае для упрощения настройка TLS отсутствует. + > **ВАЖНО.** С параметром `--insecure-registry` мы подготавливаем такое окружение, которое сможет работать с container registry без TLS. В нашем случае для упрощения настройка TLS отсутствует. 4. Установка NGINX Ingress Controller: @@ -44,7 +44,7 @@ description: Разверните ваше первое приложение с ``` {% endraw %} -5. Установка Container Registry для хранения образов: +5. Установка container registry для хранения образов: {% raw %} ```shell @@ -52,7 +52,7 @@ description: Разверните ваше первое приложение с ``` {% endraw %} - Создадим Ingress для доступа к Container Registry. + Создадим Ingress для доступа к container registry. {% raw %} ```shell @@ -162,7 +162,7 @@ description: Разверните ваше первое приложение с ``` {% endraw %} - > **ВАЖНО.** С параметром `--insecure-registry` мы подготавливаем такое окружение, которое сможет работать с Container Registry без TLS. В нашем случае для упрощения настройка TLS отсутствует. + > **ВАЖНО.** С параметром `--insecure-registry` мы подготавливаем такое окружение, которое сможет работать с container registry без TLS. В нашем случае для упрощения настройка TLS отсутствует. 4. Установка NGINX Ingress Controller: diff --git a/docs/pages_ru/usage/cleanup/cr_cleanup.md b/docs/pages_ru/usage/cleanup/cr_cleanup.md index b4d17c4330..b79539da9a 100644 --- a/docs/pages_ru/usage/cleanup/cr_cleanup.md +++ b/docs/pages_ru/usage/cleanup/cr_cleanup.md @@ -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`. @@ -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`) и выполнить авторизацию с ним diff --git a/docs/pages_ru/usage/distribute/bundles.md b/docs/pages_ru/usage/distribute/bundles.md index 6d4a1c5481..255e59f3bb 100644 --- a/docs/pages_ru/usage/distribute/bundles.md +++ b/docs/pages_ru/usage/distribute/bundles.md @@ -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 | + | @@ -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 | - |