diff --git a/translations/ja-JP/content/actions/creating-actions/index.md b/translations/ja-JP/content/actions/creating-actions/index.md index 7ed06229d7..1d91ced73d 100644 --- a/translations/ja-JP/content/actions/creating-actions/index.md +++ b/translations/ja-JP/content/actions/creating-actions/index.md @@ -6,7 +6,7 @@ redirect_from: - /github/automating-your-workflow-with-github-actions/building-actions - /actions/automating-your-workflow-with-github-actions/building-actions - /actions/building-actions - - /articles/creating-a-github-action/ + - /articles/creating-a-github-action versions: fpt: '*' ghes: '*' diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md new file mode 100644 index 0000000000..8133adef88 --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md @@ -0,0 +1,153 @@ +--- +title: Deploying Docker to Azure App Service +intro: You can deploy a Docker container to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Containers + - Docker + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Docker container to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +1. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --deployment-container-image-name nginx:latest + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +1. Set registry credentials for your web app. + + Create a personal access token with the `repo` and `read:packages` scopes. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + + Set `DOCKER_REGISTRY_SERVER_URL` to `https://ghcr.io`, `DOCKER_REGISTRY_SERVER_USERNAME` to the GitHub username or organization that owns the repository, and `DOCKER_REGISTRY_SERVER_PASSWORD` to your personal access token from above. This will give your web app credentials so it can pull the container image after your workflow pushes a newly built image to the registry. You can do this with the following Azure CLI command: + + ```shell + az webapp config appsettings set \ + --name MY_WEBAPP_NAME \ + --resource-group MY_RESOURCE_GROUP \ + --settings DOCKER_REGISTRY_SERVER_URL=https://ghcr.io DOCKER_REGISTRY_SERVER_USERNAME=MY_REPOSITORY_OWNER DOCKER_REGISTRY_SERVER_PASSWORD=MY_PERSONAL_ACCESS_TOKEN +``` + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a Docker container to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy a container to an Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + +on: + push: + branches: + - main + +permissions: + contents: 'read' + packages: 'write' + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v1 + + - name: Log in to GitHub container registry + uses: docker/login-action@v1.10.0 + with: + registry: ghcr.io + username: {% raw %}${{ github.actor }}{% endraw %} + password: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + + - name: Lowercase the repo name + run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV} + + - name: Build and push container image to registry + uses: docker/build-push-action@v2 + with: + push: true + tags: ghcr.io/{% raw %}${{ env.REPO }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %} + file: ./Dockerfile + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Lowercase the repo name + run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV} + + - name: Deploy to Azure Web App + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + images: 'ghcr.io/{% raw %}${{ env.REPO }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %}' +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-container-webapp.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-container-webapp.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md new file mode 100644 index 0000000000..7959f41764 --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md @@ -0,0 +1,134 @@ +--- +title: Deploying Java to Azure App Service +intro: You can deploy your Java project to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Java + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Java project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +1. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a Java runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "JAVA|11-java11" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a Java project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If you want to use a Java version other than `11`, change `JAVA_VERSION`. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy JAR app to Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + JAVA_VERSION: '11' # set this to the Java version to use + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up Java version + uses: actions/setup-java@v2.3.1 + with: + java-version: {% raw %}${{ env.JAVA_VERSION }}{% endraw %} + cache: 'maven' + + - name: Build with Maven + run: mvn clean install + + - name: Upload artifact for deployment job + uses: actions/upload-artifact@v2 + with: + name: java-app + path: '{% raw %}${{ github.workspace }}{% endraw %}/target/*.jar' + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: java-app + + - name: Deploy to Azure Web App + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + package: '*.jar' +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-java-jar.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-java-jar.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md new file mode 100644 index 0000000000..2da7e39ce0 --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md @@ -0,0 +1,144 @@ +--- +title: Deploying .NET to Azure App Service +intro: You can deploy your .NET project to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a .NET project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +2. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a .NET runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "DOTNET|5.0" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a .NET project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH`. If you use a version of .NET other than `5`, change `DOTNET_VERSION`. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy ASP.Net Core app to an Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root + DOTNET_VERSION: '5' # set this to the .NET Core version to use + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up .NET Core + uses: actions/setup-dotnet@v1 + with: + dotnet-version: {% raw %}${{ env.DOTNET_VERSION }}{% endraw %} + + - name: Set up dependency caching for faster builds + uses: actions/cache@v2 + with: + path: ~/.nuget/packages + key: {% raw %}${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}{% endraw %} + restore-keys: | + {% raw %}${{ runner.os }}-nuget-{% endraw %} + + - name: Build with dotnet + run: dotnet build --configuration Release + + - name: dotnet publish + run: dotnet publish -c Release -o {% raw %}${{env.DOTNET_ROOT}}{% endraw %}/myapp + + - name: Upload artifact for deployment job + uses: actions/upload-artifact@v2 + with: + name: .net-app + path: {% raw %}${{env.DOTNET_ROOT}}{% endraw %}/myapp + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: .net-app + + - name: Deploy to Azure Web App + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + package: {% raw %}${{ env.AZURE_WEBAPP_PACKAGE_PATH }}{% endraw %} +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-dotnet-core.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-dotnet-core.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md new file mode 100644 index 0000000000..e6f8f08b7c --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md @@ -0,0 +1,141 @@ +--- +title: Deploying Node.js to Azure App Service +intro: You can deploy your Node.js project to Azure App Service as part of your continuous deployment (CD) workflows. +redirect_from: + - /actions/guides/deploying-to-azure-app-service + - /actions/deployment/deploying-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure-app-service +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Node + - JavaScript + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build, test, and deploy a Node.js project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +2. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a Node.js runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "NODE|14-lts" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH` to your project path. If you use a version of Node.js other than `10.x`, change `NODE_VERSION` to the version that you use. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + push: + branches: + - main + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root + NODE_VERSION: '14.x' # set this to the node version to use + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Set up Node.js + uses: actions/setup-node@v2 + with: + node-version: {% raw %}${{ env.NODE_VERSION }}{% endraw %} + cache: 'npm' + + - name: npm install, build, and test + run: | + npm install + npm run build --if-present + npm run test --if-present + - name: Upload artifact for deployment job + uses: actions/upload-artifact@v2 + with: + name: node-app + path: . + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: node-app + + - name: 'Deploy to Azure WebApp' + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + package: {% raw %}${{ env.AZURE_WEBAPP_PACKAGE_PATH }}{% endraw %} +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-node.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-node.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the +[actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. +* The "[Create a Node.js web app in Azure](https://docs.microsoft.com/azure/app-service/quickstart-nodejs)" quickstart in the Azure web app documentation demonstrates using VS Code with the [Azure App Service extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice). diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md new file mode 100644 index 0000000000..3931a1c6eb --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md @@ -0,0 +1,155 @@ +--- +title: Deploying PHP to Azure App Service +intro: You can deploy your PHP project to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a PHP project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +2. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a PHP runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "php|7.4" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a PHP project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH` to the path to your project. If you use a version of PHP other than `8.x`, change`PHP_VERSION` to the version that you use. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy PHP app to Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root + PHP_VERSION: '8.x' # set this to the PHP version to use + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: {% raw %}${{ env.PHP_VERSION }}{% endraw %} + + - name: Check if composer.json exists + id: check_files + uses: andstor/file-existence-action@v1 + with: + files: 'composer.json' + + - name: Get Composer Cache Directory + id: composer-cache + if: steps.check_files.outputs.files_exists == 'true' + run: | + echo "::set-output name=dir::$(composer config cache-files-dir)" + + - name: Set up dependency caching for faster installs + uses: actions/cache@v2 + if: steps.check_files.outputs.files_exists == 'true' + with: + path: {% raw %}${{ steps.composer-cache.outputs.dir }}{% endraw %} + key: {% raw %}${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}{% endraw %} + restore-keys: | + {% raw %}${{ runner.os }}-composer-{% endraw %} + + - name: Run composer install if composer.json exists + if: steps.check_files.outputs.files_exists == 'true' + run: composer validate --no-check-publish && composer install --prefer-dist --no-progress + + - name: Upload artifact for deployment job + uses: actions/upload-artifact@v2 + with: + name: php-app + path: . + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: php-app + + - name: 'Deploy to Azure Web App' + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} + package: . +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-php.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-php.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md new file mode 100644 index 0000000000..f7001b459c --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md @@ -0,0 +1,151 @@ +--- +title: Deploying Python to Azure App Service +intro: You can deploy your Python project to Azure App Service as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Python + - Azure App Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Python project to [Azure App Service](https://azure.microsoft.com/services/app-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +{% data reusables.actions.create-azure-app-plan %} + +1. Create a web app. + + For example, you can use the Azure CLI to create an Azure App Service web app with a Python runtime: + + ```bash{:copy} + az webapp create \ + --name MY_WEBAPP_NAME \ + --plan MY_APP_SERVICE_PLAN \ + --resource-group MY_RESOURCE_GROUP \ + --runtime "python|3.8" + ``` + + In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app. + +{% data reusables.actions.create-azure-publish-profile %} + +1. Add an app setting called `SCM_DO_BUILD_DURING_DEPLOYMENT` and set the value to `1`. + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +{% endif %} + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a Python project to Azure App Service when there is a push to the `main` branch. + +Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If you use a version of Python other than `3.8`, change `PYTHON_VERSION` to the version that you use. + +{% data reusables.actions.delete-env-key %} + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy Python app to Azure Web App + +env: + AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name + PYTHON_VERSION: '3.8' # set this to the Python version to use + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up Python version + uses: actions/setup-python@v2.2.2 + with: + python-version: {% raw %}${{ env.PYTHON_VERSION }}{% endraw %} + + - name: Create and start virtual environment + run: | + python -m venv venv + source venv/bin/activate + + - name: Set up dependency caching for faster installs + uses: actions/cache@v2 + with: + path: ~/.cache/pip + key: {% raw %}${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}{% endraw %} + restore-keys: | + {% raw %}${{ runner.os }}-pip-{% endraw %} + + - name: Install dependencies + run: pip install -r requirements.txt + + # Optional: Add a step to run tests here (PyTest, Django test suites, etc.) + + - name: Upload artifact for deployment jobs + uses: actions/upload-artifact@v2 + with: + name: python-app + path: | + . + !venv/ + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: 'production' + url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %} + + steps: + - name: Download artifact from build job + uses: actions/download-artifact@v2 + with: + name: python-app + path: . + + - name: 'Deploy to Azure Web App' + id: deploy-to-webapp + uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e + with: + app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %} + publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %} +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-webapps-python.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-python.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service.md new file mode 100644 index 0000000000..f6ab7573d2 --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service.md @@ -0,0 +1,126 @@ +--- +title: Deploying to Azure Kubernetes Service +intro: You can deploy your project to Azure Kubernetes Service (AKS) as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Azure Kubernetes Service +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a project to [Azure Kubernetes Service](https://azure.microsoft.com/services/kubernetes-service/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +1. Create a target AKS cluster and an Azure Container Registry (ACR). For more information, see "[Quickstart: Deploy an AKS cluster by using the Azure portal - Azure Kubernetes Service](https://docs.microsoft.com/azure/aks/kubernetes-walkthrough-portal)" and "[Quickstart - Create registry in portal - Azure Container Registry](https://docs.microsoft.com/azure/container-registry/container-registry-get-started-portal)" in the Azure documentation. + +1. Create a secret called `AZURE_CREDENTIALS` to store your Azure credentials. For more information about how to find this information and structure the secret, see [the `Azure/login` action documentation](https://github.com/Azure/login#configure-a-service-principal-with-a-secret). + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy a project to Azure Kubernetes Service when code is pushed to your repository. + +Under the workflow `env` key, change the the following values: +- `AZURE_CONTAINER_REGISTRY` to the name of your container registry +- `PROJECT_NAME` to the name of your project +- `RESOURCE_GROUP` to the resource group containing your AKS cluster +- `CLUSTER_NAME` to the name of your AKS cluster + +This workflow uses the `helm` render engine for the [`azure/k8s-bake` action](https://github.com/Azure/k8s-bake). If you will use the `helm` render engine, change the value of `CHART_PATH` to the path to your helm file. Change `CHART_OVERRIDE_PATH` to an array of override file paths. If you use a different render engine, update the input parameters sent to the `azure/k8s-bake` action. + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Build and deploy to Azure Kubernetes Service + +env: + AZURE_CONTAINER_REGISTRY: MY_REGISTRY_NAME # set this to the name of your container registry + PROJECT_NAME: MY_PROJECT_NAME # set this to your project's name + RESOURCE_GROUP: MY_RESOURCE_GROUP # set this to the resource group containing your AKS cluster + CLUSTER_NAME: MY_CLUSTER_NAME # set this to the name of your AKS cluster + REGISTRY_URL: MY_REGISTRY_URL # set this to the URL of your registry + # If you bake using helm: + CHART_PATH: MY_HELM_FILE # set this to the path to your helm file + CHART_OVERRIDE_PATH: MY_OVERRIDE_FILES # set this to an array of override file paths + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + + - name: Azure Login + uses: azure/login@89d153571fe9a34ed70fcf9f1d95ab8debea7a73 + with: + creds: {% raw %}${{ secrets.AZURE_CREDENTIALS }}{% endraw %} + + - name: Build image on ACR + uses: azure/CLI@7378ce2ca3c38b4b063feb7a4cbe384fef978055 + with: + azcliversion: 2.29.1 + inlineScript: | + az configure --defaults acr={% raw %}${{ env.AZURE_CONTAINER_REGISTRY }}{% endraw %} + az acr build -t -t {% raw %}${{ env.REGISTRY_URL }}{% endraw %}/{% raw %}${{ env.PROJECT_NAME }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %} + + - name: Gets K8s context + uses: azure/aks-set-context@4e5aec273183a197b181314721843e047123d9fa + with: + creds: {% raw %}${{ secrets.AZURE_CREDENTIALS }}{% endraw %} + resource-group: {% raw %}${{ env.RESOURCE_GROUP }}{% endraw %} + cluster-name: {% raw %}${{ env.CLUSTER_NAME }}{% endraw %} + id: login + + - name: Configure deployment + uses: azure/k8s-bake@773b6144a3732e3bf4c78b146a0bb9617b2e016b + with: + renderEngine: 'helm' + helmChart: {% raw %}${{ env.CHART_PATH }}{% endraw %} + overrideFiles: {% raw %}${{ env.CHART_OVERRIDE_PATH }}{% endraw %} + overrides: | + replicas:2 + helm-version: 'latest' + id: bake + + - name: Deploys application + - uses: Azure/k8s-deploy@c8fbd76ededaad2799c054a9fd5d0fa5d4e9aee4 + with: + manifests: {% raw %}${{ steps.bake.outputs.manifestsBundle }}{% endraw %} + images: | + {% raw %}${{ env.AZURE_CONTAINER_REGISTRY }}{% endraw %}.azurecr.io/{% raw %}${{ env.PROJECT_NAME }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %} + imagepullsecrets: | + {% raw %}${{ env.PROJECT_NAME }}{% endraw %} +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-kubernetes-service.yml `](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The actions used to in this workflow are the official Azure [`Azure/login`](https://github.com/Azure/login),[`Azure/aks-set-context`](https://github.com/Azure/aks-set-context), [`Azure/CLI`](https://github.com/Azure/CLI), [`Azure/k8s-bake`](https://github.com/Azure/k8s-bake), and [`Azure/k8s-deploy`](https://github.com/Azure/k8s-deploy)actions. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md new file mode 100644 index 0000000000..cc6a363133 --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md @@ -0,0 +1,113 @@ +--- +title: Deploying to Azure Static Web App +intro: You can deploy your web app to Azure Static Web App as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - CD + - Azure Static Web Apps +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + + +## Introduction + +This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a web app to [Azure Static Web Apps](https://azure.microsoft.com/services/app-service/static/). + +{% ifversion fpt or ghec or ghae-issue-4856 %} + +{% note %} + +**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)." + +{% endnote %} + +{% endif %} + +## Prerequisites + +Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: + +1. Create an Azure Static Web App using the 'Other' option for deployment source. For more information, see "[Quickstart: Building your first static site in the Azure portal](https://docs.microsoft.com/azure/static-web-apps/get-started-portal)" in the Azure documentation. + +2. Create a secret called `AZURE_STATIC_WEB_APPS_API_TOKEN` with the value of your static web app deployment token. For more information about how to find your deployment token, see "[Reset deployment tokens in Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/deployment-token-management)" in the Azure documentation. + +## Creating the workflow + +Once you've completed the prerequisites, you can proceed with creating the workflow. + +The following example workflow demonstrates how to build and deploy an Azure static web app when there is a push to the `main` branch or when a pull request targeting `main` is opened, synchronized, or reopened. The workflow also tears down the corresponding pre-production deployment when a pull request targeting `main` is closed. + +Under the workflow `env` key, change the following values: +- `APP_LOCATION` to the location of your client code +- `API_LOCATION` to the location of your API source code. If `API_LOCATION` is not relevant, you can delete the variable and the lines where it is used. +- `APP_ARTIFACT_LOCATION` to the location of your client code build output + +For more information about these values, see "[Build configuration for Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/build-configuration?tabs=github-actions)" in the Azure documentation. + +```yaml{:copy} +{% data reusables.actions.actions-not-certified-by-github-comment %} + +name: Deploy web app to Azure Static Web Apps + +env: + APP_LOCATION: "/" # location of your client code + API_LOCATION: "api" # location of your api source code - optional + APP_ARTIFACT_LOCATION: "build" # location of client code build output + + on: + push: + branches: + - main + pull_request: + types: [opened, synchronize, reopened, closed] + branches: + - main + +permissions: + issues: write + +jobs: + build_and_deploy: + if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed') + runs-on: ubuntu-latest + name: Build and Deploy + steps: + - uses: actions/checkout@v2 + with: + submodules: true + - name: Build And Deploy + uses: Azure/static-web-apps-deploy@1a947af9992250f3bc2e68ad0754c0b0c11566c9 + with: + azure_static_web_apps_api_token: {% raw %}${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }}{% endraw %} + repo_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + action: "upload" + app_location: {% raw %}${{ env.APP_LOCATION }}{% endraw %} + api_location: {% raw %}${{ env.API_LOCATION }}{% endraw %} + app_artifact_location: {% raw %}${{ env.APP_ARTIFACT_LOCATION }}{% endraw %} + + close: + if: github.event_name == 'pull_request' && github.event.action == 'closed' + runs-on: ubuntu-latest + name: Close + steps: + - name: Close + uses: Azure/static-web-apps-deploy@1a947af9992250f3bc2e68ad0754c0b0c11566c9 + with: + azure_static_web_apps_api_token: {% raw %}${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }}{% endraw %} + action: "close" +``` + +## Additional resources + +The following resources may also be useful: + +* For the original starter workflow, see [`azure-staticwebapp.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-staticwebapp.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. +* The action used to deploy the web app is the official Azure [`Azure/static-web-apps-deploy`](https://github.com/Azure/static-web-apps-deploy) action. +* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/index.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/index.md new file mode 100644 index 0000000000..293638875e --- /dev/null +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/index.md @@ -0,0 +1,19 @@ +--- +title: Deploying to Azure +shortTitle: Deploy to Azure +intro: Learn how to deploy to Azure App Service, Azure Kubernetes, and Azure Static Web App as part of your continuous deployment (CD) workflows. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +children: + - /deploying-nodejs-to-azure-app-service + - /deploying-python-to-azure-app-service + - /deploying-java-to-azure-app-service + - /deploying-net-to-azure-app-service + - /deploying-php-to-azure-app-service + - /deploying-docker-to-azure-app-service + - /deploying-to-azure-static-web-app + - /deploying-to-azure-kubernetes-service +--- diff --git a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/index.md b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/index.md index 156f6e6eed..56c61d9b6d 100644 --- a/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/index.md +++ b/translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/index.md @@ -4,11 +4,11 @@ shortTitle: Deploying to your cloud provider intro: 'You can deploy to various cloud providers, such as AWS, Azure, and GKE.' versions: fpt: '*' - ghae: issue-4856 + ghae: '*' ghec: '*' + ghes: '*' children: - /deploying-to-amazon-elastic-container-service - - /deploying-to-azure-app-service + - /deploying-to-azure - /deploying-to-google-kubernetes-engine --- - diff --git a/translations/ja-JP/content/actions/guides.md b/translations/ja-JP/content/actions/guides.md index 2c15577f19..3a445c387b 100644 --- a/translations/ja-JP/content/actions/guides.md +++ b/translations/ja-JP/content/actions/guides.md @@ -43,7 +43,6 @@ includeGuides: - /actions/using-containerized-services/creating-redis-service-containers - /actions/using-containerized-services/creating-postgresql-service-containers - /actions/deployment/deploying-to-amazon-elastic-container-service - - /actions/deployment/deploying-to-azure-app-service - /actions/deployment/deploying-to-google-kubernetes-engine - /actions/learn-github-actions/essential-features-of-github-actions - /actions/security-guides/security-hardening-for-github-actions @@ -64,5 +63,13 @@ includeGuides: - /actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app + - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service --- diff --git a/translations/ja-JP/content/actions/index.md b/translations/ja-JP/content/actions/index.md index 5eff35a61d..874053eb2b 100644 --- a/translations/ja-JP/content/actions/index.md +++ b/translations/ja-JP/content/actions/index.md @@ -30,10 +30,10 @@ changelog: examples_source: data/product-examples/actions/code-examples.yml product_video: 'https://www.youtube-nocookie.com/embed/cP0I9w2coGU' redirect_from: - - /articles/automating-your-workflow-with-github-actions/ - - /articles/customizing-your-project-with-github-actions/ + - /articles/automating-your-workflow-with-github-actions + - /articles/customizing-your-project-with-github-actions - /github/automating-your-workflow-with-github-actions - - /actions/automating-your-workflow-with-github-actions/ + - /actions/automating-your-workflow-with-github-actions - /categories/automating-your-workflow-with-github-actions - /marketplace/actions - /actions/reference diff --git a/translations/ja-JP/content/actions/learn-github-actions/contexts.md b/translations/ja-JP/content/actions/learn-github-actions/contexts.md index 88c17692f1..6fd4f39039 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/contexts.md +++ b/translations/ja-JP/content/actions/learn-github-actions/contexts.md @@ -221,7 +221,7 @@ The following table indicates where each context and special function can be use | Path | Context | Special functions | | ---- | ------- | ----------------- | -| concurrency | github | | +| concurrency | github, inputs | | | env | github, secrets, inputs | | | jobs.<job_id>.concurrency | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.container | github, needs, strategy, matrix, inputs | | diff --git a/translations/ja-JP/content/actions/learn-github-actions/index.md b/translations/ja-JP/content/actions/learn-github-actions/index.md index f69e68338e..e45322bcff 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/index.md +++ b/translations/ja-JP/content/actions/learn-github-actions/index.md @@ -11,7 +11,7 @@ redirect_from: - /actions/getting-started-with-github-actions/overview - /actions/getting-started-with-github-actions/getting-started-with-github-actions - /actions/configuring-and-managing-workflows/configuring-a-workflow - - /articles/creating-a-workflow-with-github-actions/ + - /articles/creating-a-workflow-with-github-actions - /articles/configuring-a-workflow - /github/automating-your-workflow-with-github-actions/configuring-a-workflow - /actions/automating-your-workflow-with-github-actions/configuring-a-workflow diff --git a/translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md b/translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md index 02d81d360f..9bf5bb7bdf 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md +++ b/translations/ja-JP/content/actions/learn-github-actions/reusing-workflows.md @@ -18,9 +18,9 @@ topics: ## Overview -Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow. +Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow. -Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. +Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. The diagram below shows three build jobs on the left of the diagram. After each of these jobs completes successfully a dependent job called "Deploy" runs. This job calls a reusable workflow that contains three jobs: "Staging", "Review", and "Production." The "Production" deployment job only runs after the "Staging" job has completed successfully. Using a reusable workflow to run deployment jobs allows you to run those jobs for each build without duplicating code in workflows. @@ -67,7 +67,6 @@ Called workflows can access self-hosted runners from caller's context. This mean * Reusable workflows can't call other reusable workflows. * Reusable workflows stored within a private repository can only be used by workflows within the same repository. * Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." -* You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs..concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)." * The `strategy` property is not supported in any job that calls a reusable workflow. ## Creating a reusable workflow @@ -77,13 +76,13 @@ Reusable workflows are YAML-formatted files, very similar to any other workflow For a workflow to be reusable, the values for `on` must include `workflow_call`: ```yaml -on: +on: workflow_call: ``` ### Using inputs and secrets in a reusable workflow -You can define inputs and secrets, which can be passed from the caller workflow and then used within the called workflow. There are three stages to using an input or a secret in a reusable workflow. +You can define inputs and secrets, which can be passed from the caller workflow and then used within the called workflow. There are three stages to using an input or a secret in a reusable workflow. 1. In the reusable workflow, use the `inputs` and `secrets` keywords to define inputs or secrets that will be passed from a caller workflow. {% raw %} @@ -112,10 +111,10 @@ You can define inputs and secrets, which can be passed from the caller workflow - uses: ./.github/actions/my-action@v1 with: username: ${{ inputs.username }} - token: ${{ secrets.envPAT }} + token: ${{ secrets.envPAT }} ``` {% endraw %} - In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job. + In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job. {% note %} @@ -153,7 +152,7 @@ jobs: - uses: ./.github/actions/my-action@v1 with: username: ${{ inputs.username }} - token: ${{ secrets.token }} + token: ${{ secrets.token }} ``` {% endraw %} @@ -163,7 +162,7 @@ You call a reusable workflow by using the `uses` keyword. Unlike when you are us [`jobs..uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses) -You reference reusable workflow files using the syntax: +You reference reusable workflow files using the syntax: `{owner}/{repo}/{path}/{filename}@{ref}` @@ -191,7 +190,7 @@ When you call a reusable workflow, you can only use the following keywords in th {% note %} - **Note:** + **Note:** * If `jobs..permissions` is not specified in the calling job, the called workflow will have the default permissions for the `GITHUB_TOKEN`. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." * The `GITHUB_TOKEN` permissions passed from the caller workflow can be only downgraded (not elevated) by the called workflow. @@ -226,7 +225,7 @@ jobs: ## Using outputs from a reusable workflow -A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow. +A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow. The following reusable workflow has a single job containing two steps. In each of these steps we set a single word as the output: "hello" and "world." In the `outputs` section of the job, we map these step outputs to job outputs called: `output1` and `output2`. In the `on.workflow_call.outputs` section we then define two outputs for the workflow itself, one called `firstword` which we map to `output1`, and one called `secondword` which we map to `output2`. @@ -243,12 +242,12 @@ on: value: ${{ jobs.example_job.outputs.output1 }} secondword: description: "The second output string" - value: ${{ jobs.example_job.outputs.output2 }} - + value: ${{ jobs.example_job.outputs.output2 }} + jobs: example_job: name: Generate output - runs-on: ubuntu-latest + runs-on: ubuntu-latest # Map the job outputs to step outputs outputs: output1: ${{ steps.step1.outputs.firstword }} diff --git a/translations/ja-JP/content/actions/learn-github-actions/using-workflow-templates.md b/translations/ja-JP/content/actions/learn-github-actions/using-workflow-templates.md index 8bdb52e763..f7685fa3f0 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/using-workflow-templates.md +++ b/translations/ja-JP/content/actions/learn-github-actions/using-workflow-templates.md @@ -25,9 +25,9 @@ topics: ## About workflow templates -{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests. +{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant workflow templates.{% endif %} -You can also create your own workflow templates to share with your organization. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." +You can also create your own workflow templates to share with your organization. These templates will appear alongside the {% data variables.product.product_name %} workflow templates. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." ## Using workflow templates @@ -36,8 +36,8 @@ Anyone with write permission to a repository can set up {% data variables.produc {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} 1. If you already have a workflow in your repository, click **New workflow**. -1. Find the template that you want to use, then click **Set up this workflow**. -1. If the workflow template contains comments detailing additional setup steps, follow these steps. +1. Find the template that you want to use, then click **Set up this workflow**.{% if actions-starter-template-ui %} To help you find the template that you want, you can search for keywords or filter by category.{% endif %} +1. If the workflow template contains comments detailing additional setup steps, follow these steps. Many of the templates have corresponding guides. For more information, see [the {% data variables.product.prodname_actions %} guides](/actions/guides)." 1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." 1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs. 1. Click **Start commit**. diff --git a/translations/ja-JP/content/actions/migrating-to-github-actions/index.md b/translations/ja-JP/content/actions/migrating-to-github-actions/index.md index b4dbec7116..54a6cff1d2 100644 --- a/translations/ja-JP/content/actions/migrating-to-github-actions/index.md +++ b/translations/ja-JP/content/actions/migrating-to-github-actions/index.md @@ -9,7 +9,7 @@ versions: ghec: '*' redirect_from: - /actions/migrating-to-github-actions - - /articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax/ + - /articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax children: - /migrating-from-azure-pipelines-to-github-actions - /migrating-from-circleci-to-github-actions diff --git a/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md b/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md index 33cd83f62b..e3c6192362 100644 --- a/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md +++ b/translations/ja-JP/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md @@ -71,6 +71,15 @@ These attributes are available. You can change the attribute names in the [manag | `public_keys` | Optional | The public SSH keys for the user. More than one can be specified. | | `gpg_keys` | Optional | The GPG keys for the user. More than one can be specified. | +To specify more than one value for an attribute, use multiple `` elements. + +``` + + ssh-rsa LONG KEY + ssh-rsa LONG KEY 2 + +``` + ## Configuring SAML settings {% data reusables.enterprise_site_admin_settings.access-settings %} diff --git a/translations/ja-JP/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md b/translations/ja-JP/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md index b720b6c9a0..35573b2ad4 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md +++ b/translations/ja-JP/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md @@ -31,6 +31,8 @@ Because client connections to {% data variables.product.prodname_ghe_server %} c {% data reusables.enterprise_clustering.proxy_xff_firewall_warning %} +{% data reusables.enterprise_installation.terminating-tls %} + ### Enabling PROXY protocol support on {% data variables.product.product_location %} We strongly recommend enabling PROXY protocol support for both your appliance and the load balancer. Use the instructions provided by your vendor to enable the PROXY protocol on your load balancer. For more information, see [the PROXY protocol documentation](http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt). @@ -50,8 +52,6 @@ We strongly recommend enabling PROXY protocol support for both your appliance an {% data reusables.enterprise_clustering.x-forwarded-for %} -{% data reusables.enterprise_installation.terminating-tls %} - {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index 36e474e3e2..9cb3ba1b65 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -56,8 +56,8 @@ If you need to get information on the users, organizations, and repositories in Specifically, you can download CSV reports that list - all users -- all users who have been active within the last month -- all users who have been inactive for one month or more +- all active users +- all [dormant users](/admin/user-management/managing-dormant-users) - all users who have been suspended - all organizations - all repositories diff --git a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md index ac01707283..19a5c2f5bb 100644 --- a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md +++ b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md @@ -10,7 +10,6 @@ redirect_from: - /enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud - /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud -permissions: 'Enterprise owners who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.' versions: ghes: '*' ghae: '*' @@ -60,6 +59,12 @@ Enabling {% data variables.product.prodname_github_connect %} will not allow {% For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)." ## Enabling {% data variables.product.prodname_github_connect %} +Enterprise owners who are also owners of an organization or enterprise account that uses {% data variables.product.prodname_ghe_cloud %} can enable {% data variables.product.prodname_github_connect %}. + +If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_dotcom_the_website %} that is not owned by an enterprise account, you must enable {% data variables.product.prodname_github_connect %} with a personal account on {% data variables.product.prodname_dotcom_the_website %} that is an owner of the organization. + +If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_dotcom_the_website %} that is owned by an enterprise account or to an enterprise account itself, you must enable {% data variables.product.prodname_github_connect %} with a personal account on {% data variables.product.prodname_dotcom_the_website %} that is an owner of the enterprise account. + {% ifversion ghes %} 1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} @@ -73,7 +78,9 @@ For more information about managing enterprise accounts using the GraphQL API, s 1. Next to the enterprise account or organization you'd like to connect, click **Connect**. ![Connect button next to an enterprise account or business](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png) -## Disconnecting a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account from your enterprise account +## Disabling {% data variables.product.prodname_github_connect %} + +Enterprise owners can disable {% data variables.product.prodname_github_connect %}. When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location %} are deleted. diff --git a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md index cc41266506..27ad1a6dcc 100644 --- a/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md +++ b/translations/ja-JP/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md @@ -37,6 +37,8 @@ For more information about these features, see "[About the dependency graph](/gi You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}. +Only {% data variables.product.company_short %}-reviewed advisories are synchronized. {% data reusables.security-advisory.link-browsing-advisory-db %} + ### About generation of {% data variables.product.prodname_dependabot_alerts %} If you enable vulnerability detection, when {% data variables.product.product_location %} receives information about a vulnerability, it identifies repositories in your instance that use the affected version of the dependency and generates {% data variables.product.prodname_dependabot_alerts %}. You can choose whether or not to notify users automatically about new {% data variables.product.prodname_dependabot_alerts %}. diff --git a/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md b/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md index 39c47c0f0a..203f3fa1fb 100644 --- a/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md +++ b/translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md @@ -1,7 +1,7 @@ --- -title: GitHub Actions を有効化して GitHub Enterprise Server をバックアップおよび復元する -shortTitle: バックアップと復元 -intro: '外部ストレージプロバイダの {% data variables.product.prodname_actions %} データは、通常の {% data variables.product.prodname_ghe_server %} バックアップに含まれていないため、個別にバックアップする必要があります。' +title: Backing up and restoring GitHub Enterprise Server with GitHub Actions enabled +shortTitle: Backing up and restoring +intro: '{% data variables.product.prodname_actions %} data on your external storage provider is not included in regular {% data variables.product.prodname_ghe_server %} backups, and must be backed up separately.' versions: ghes: '*' type: how_to @@ -13,18 +13,43 @@ topics: redirect_from: - /admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled --- - {% data reusables.actions.enterprise-storage-ha-backups %} -{% data variables.product.prodname_enterprise_backup_utilities %} を使用して {% data variables.product.product_location %} をバックアップする場合、外部ストレージプロバイダに保存されている {% data variables.product.prodname_actions %} データはバックアップに含まれないことにご注意ください。 +If you use {% data variables.product.prodname_enterprise_backup_utilities %} to back up {% data variables.product.product_location %}, it's important to note that {% data variables.product.prodname_actions %} data stored on your external storage provider is not included in the backup. -以下は、{% data variables.product.product_location %} と {% data variables.product.prodname_actions %} を新しいアプライアンスに復元するために必要なステップの概要です。 +This is an overview of the steps required to restore {% data variables.product.product_location %} with {% data variables.product.prodname_actions %} to a new appliance: -1. 元のアプライアンスがオフラインであることを確認します。 -1. 交換用の {% data variables.product.prodname_ghe_server %} アプライアンスでネットワーク設定を手動設定します。 ネットワーク設定はバックアップスナップショットから除外され、`ghe-restore` で上書きされません。 -1. 元のアプライアンスと同じ {% data variables.product.prodname_actions %} 外部ストレージ設定を使用するように交換用アプライアンスを設定します。 -1. 交換用アプライアンスで {% data variables.product.prodname_actions %} を有効化します。 これにより、交換用アプライアンスが {% data variables.product.prodname_actions %} の同じ外部ストレージに接続されます。 -1. {% data variables.product.prodname_actions %} を外部ストレージプロバイダで設定したら、`ghe-restore` コマンドを使用して、バックアップから残りのデータを復元します。 詳しい情報については、「[バックアップを復元する](/admin/configuration/configuring-backups-on-your-appliance#restoring-a-backup)」を参照してください。 -1. セルフホストランナーを交換用アプライアンスに再登録します。 詳しい情報については、「[セルフホストランナーを追加する](/actions/hosting-your-own-runners/adding-self-hosted-runners)」を参照してください。 +1. Confirm that the original appliance is offline. +1. Manually configure network settings on the replacement {% data variables.product.prodname_ghe_server %} appliance. Network settings are excluded from the backup snapshot, and are not overwritten by `ghe-restore`. +1. To configure the replacement appliance to use the same {% data variables.product.prodname_actions %} external storage configuration as the original appliance, from the new appliance, set the required parameters with `ghe-config` command. + + - Azure Blob Storage + ```shell + ghe-config secrets.actions.storage.blob-provider "azure" + ghe-config secrets.actions.storage.azure.connection-string "_Connection_String_" + ``` + - Amazon S3 + ```shell + ghe-config secrets.actions.storage.blob-provider "s3" + ghe-config secrets.actions.storage.s3.bucket-name "_S3_Bucket_Name" + ghe-config secrets.actions.storage.s3.service-url "_S3_Service_URL_" + ghe-config secrets.actions.storage.s3.access-key-id "_S3_Access_Key_ID_" + ghe-config secrets.actions.storage.s3.access-secret "_S3_Access_Secret_" + ``` + - Optionally, to enable S3 force path style, enter the following command: + ```shell + ghe-config secrets.actions.storage.s3.force-path-style true + ``` + -{% data variables.product.prodname_ghe_server %} のバックアップと復元の詳細については、「[アプライアンスでバックアップを設定する](/admin/configuration/configuring-backups-on-your-appliance)」を参照してください。 +1. Enable {% data variables.product.prodname_actions %} on the replacement appliance. This will connect the replacement appliance to the same external storage for {% data variables.product.prodname_actions %}. + + ```shell + ghe-config app.actions.enabled true + ghe-config-apply + ``` + +1. After {% data variables.product.prodname_actions %} is configured and enabled, use the `ghe-restore` command to restore the rest of the data from the backup. For more information, see "[Restoring a backup](/admin/configuration/configuring-backups-on-your-appliance#restoring-a-backup)." +1. Re-register your self-hosted runners on the replacement appliance. For more information, see [Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners). + +For more information on backing up and restoring {% data variables.product.prodname_ghe_server %}, see "[Configuring backups on your appliance](/admin/configuration/configuring-backups-on-your-appliance)." diff --git a/translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md b/translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md index 514b440f73..748685a4e0 100644 --- a/translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md +++ b/translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md @@ -62,7 +62,7 @@ Before launching {% data variables.product.product_location %} on Azure, you'll {% data reusables.enterprise_installation.necessary_ports %} -4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation. +4. Create and attach a new managed data disk to the VM, and configure the size based on your license count. All Azure managed disks created since June 10, 2017 are encrypted at rest by default with Storage Service Encryption (SSE). For more information about the `az vm disk attach` command, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation. Pass in options for the name of your VM (for example, `ghe-acme-corp`), the resource group, the premium storage SKU, the size of the disk (for example, `100`), and a name for the resulting VHD. diff --git a/translations/ja-JP/content/admin/overview/about-github-ae.md b/translations/ja-JP/content/admin/overview/about-github-ae.md index 48edc3788d..62d5fcf17b 100644 --- a/translations/ja-JP/content/admin/overview/about-github-ae.md +++ b/translations/ja-JP/content/admin/overview/about-github-ae.md @@ -1,6 +1,6 @@ --- -title: GitHub AE について -intro: '{% data variables.product.prodname_ghe_managed %} は、クラウドで {% data variables.product.prodname_dotcom %} を使用するためにセキュリティが強化された準拠した方法です。' +title: About GitHub AE +intro: '{% data variables.product.prodname_ghe_managed %} is a security-enhanced and compliant way to use {% data variables.product.prodname_dotcom %} in the cloud.' versions: ghae: '*' type: overview @@ -9,32 +9,33 @@ topics: - Fundamentals --- -## {% data variables.product.prodname_ghe_managed %}について +## About {% data variables.product.prodname_ghe_managed %} -{% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} は完全に管理され、信頼性が高く、スケーラブルであるため、リスク管理を犠牲にすることなくデリバリを迅速化できます。 +{% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} is fully managed, reliable, and scalable, allowing you to accelerate delivery without sacrificing risk management. -{% data variables.product.prodname_ghe_managed %} は、アイデアから本番まで1つの開発者プラットフォームを提供します。 Team が使い慣れたツールを使用して開発速度を上げることができます。また、独自のセキュリティとアクセス制御、ワークフローの自動化、およびポリシーの適用により、業界と規制のコンプライアンスを維持できます。 +{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase development velocity with the tools that teams know and love, while you maintain industry and regulatory compliance with unique security and access controls, workflow automation, and policy enforcement. -## 高可用性および地球規模のクラウド +## A highly available and planet-scale cloud -{% data variables.product.prodname_ghe_managed %} は、高可用性アーキテクチャでホストされているフルマネージドサービスです。 {% data variables.product.prodname_ghe_managed %} は、クラウドでグローバルにホストされており、無制限に開発ライフサイクル全体をサポートするように拡張できます。 {% data variables.product.prodname_dotcom %} は、バックアップ、フェイルオーバー、およびシステム災害復旧を完全に管理するため、サービスやデータについて心配する必要はありません。 +{% data variables.product.prodname_ghe_managed %} is a fully managed service, hosted in a high availability architecture. {% data variables.product.prodname_ghe_managed %} is hosted globally in a cloud that can scale to support your full development lifecycle without limits. {% data variables.product.prodname_dotcom %} fully manages backups, failover, and disaster recovery, so you never need to worry about your service or data. -## データの常駐 +## Data residency -すべてのデータは、ユーザが選択したリージョン内で保存されます。 すべてのデータを選択したリージョン内に保存することで、GDPR およびグローバルデータ保護基準に準拠できます。 +All of your data is stored within the geographic region of your choosing. You can comply with GDPR and global data protection standards by keeping all of your data within your chosen region. -## 分離されたアカウント +## Isolated accounts -すべての開発者アカウントは、{% data variables.product.prodname_ghe_managed %} 内で完全に分離されています。 SAML シングルサインオンを必須として、アイデンティティプロバイダを介してアカウントを完全に制御できます。 SCIM を使用すると、中央のアイデンティティ管理システムで定義されているように、従業員が必要なリソースにのみアクセスできるようにすることができます。 詳しい情報については、「[Enterprise のアイデンティティとアクセスを管理する](/admin/authentication/managing-identity-and-access-for-your-enterprise)」を参照してください。 +All developer accounts are fully isolated in {% data variables.product.prodname_ghe_managed %}. You can fully control the accounts through your identity provider, with SAML single sign on as mandatory. SCIM enables you to ensure that employees only have access to the resources they should, as defined in your central identity management system. For more information, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." -## 制限付きネットワークアクセス +## Restricted network access -ネットワークアクセスが制限された {% data variables.product.prodname_ghe_managed %} での Enterprise への安全なアクセスにより、データはネットワーク内からのみアクセスできます。 詳しい情報については、「[Enterprise へのネットワークトラフィックを制限する](/admin/configuration/restricting-network-traffic-to-your-enterprise)」を参照してください。 +Secure access to your enterprise on {% data variables.product.prodname_ghe_managed %} with restricted network access, so that your data can only be accessed from within your network. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)." -## 商用および政府環境 +## Commercial and government environments -{% data variables.product.prodname_ghe_managed %} は、Azure Government クラウドという、米国政府機関とそのパートナー向けの信頼できるクラウドで利用できます。 {% data variables.product.prodname_ghe_managed %} は商用クラウドでも利用できるため、Organization に適したホスティング環境を選択できます。 +{% data variables.product.prodname_ghe_managed %} is available in the Azure Government cloud, the trusted cloud for US government agencies and their partners. {% data variables.product.prodname_ghe_managed %} is also available in the commercial cloud, so you can choose the hosting environment that is right for your organization. -## 参考リンク +## Further reading +- "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)" - "[Receiving help from {% data variables.product.company_short %} Support](/admin/enterprise-support/receiving-help-from-github-support)" diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md index 4a20954bbf..1312ef64f1 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md @@ -35,8 +35,13 @@ When your code depends on a package that has a security vulnerability, this vuln {% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %} when: {% ifversion fpt or ghec %} -- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %} +- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %} - New advisory data is synchronized to {% data variables.product.product_location %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} + {% note %} + + **Note:** Only advisories that have been reviewed by {% data variables.product.company_short %} will trigger {% data variables.product.prodname_dependabot_alerts %}. + + {% endnote %} - The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% ifversion fpt or ghec %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)." {% data reusables.repositories.dependency-review %} diff --git a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md index 7fd77729d1..34a478356c 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -2,6 +2,7 @@ title: Browsing security vulnerabilities in the GitHub Advisory Database intro: 'The {% data variables.product.prodname_advisory_database %} allows you to browse or search for vulnerabilities that affect open source projects on {% data variables.product.company_short %}.' shortTitle: Browse Advisory Database +miniTocMaxHeadingLevel: 3 redirect_from: - /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database - /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database @@ -22,13 +23,29 @@ topics: {% data reusables.repositories.a-vulnerability-is %} -{% data variables.product.product_name %} will send you {% data variables.product.prodname_dependabot_alerts %} if we detect that any of the vulnerabilities from the {% data variables.product.prodname_advisory_database %} affect the packages that your repository depends on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." - ## About the {% data variables.product.prodname_advisory_database %} -The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. {% data reusables.repositories.tracks-vulnerabilities %} +The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities, grouped in two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories. -Each security advisory contains information about the vulnerability, including the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology. +{% data reusables.repositories.tracks-vulnerabilities %} + +### About {% data variables.product.company_short %}-reviewed advisories + +{% data variables.product.company_short %}-reviewed advisories are security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. + +We carefully review each advisory for validity. Each {% data variables.product.company_short %}-reviewed advisory has a full description, and contains both ecosystem and package information. + +If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory affects packages you depend on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." + +### About unreviewed advisories + +Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. + +{% data variables.product.prodname_dependabot %} doesn't create {% data variables.product.prodname_dependabot_alerts %} for unreviewed advisories as this type of advisory isn't checked for validity or completion. + +## About security advisories + +Each security advisory contains information about the vulnerability, which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology. The severity level is one of four possible levels defined in the "[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)." - Low @@ -45,6 +62,11 @@ The {% data variables.product.prodname_advisory_database %} uses the CVSS levels 1. Navigate to https://github.com/advisories. 2. Optionally, to filter the list, use any of the drop-down menus. ![Dropdown filters](/assets/images/help/security/advisory-database-dropdown-filters.png) + {% tip %} + + **Tip:** You can use the sidebar on the left to explore {% data variables.product.company_short %}-reviewed and unreviewed advisories separately. + + {% endtip %} 3. Click on any advisory to view details. {% note %} @@ -63,6 +85,8 @@ You can search the database, and use qualifiers to narrow your search. For examp | Qualifier | Example | | ------------- | ------------- | +| `type:reviewed`| [**type:reviewed**](https://github.com/advisories?query=type%3Areviewed) will show {% data variables.product.company_short %}-reviewed advisories. | +| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. | | `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. | | `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. | | `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting NPM packages. | @@ -80,7 +104,7 @@ You can search the database, and use qualifiers to narrow your search. For examp ## Viewing your vulnerable repositories -For any vulnerability in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories have a {% data variables.product.prodname_dependabot %} alert for that vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)." +For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)." 1. Navigate to https://github.com/advisories. 2. Click an advisory. diff --git a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md index 9d6ac99ff3..a92278ed72 100644 --- a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -2,7 +2,7 @@ title: About wikis intro: 'You can host documentation for your repository in a wiki, so that others can use and contribute to your project.' redirect_from: - - /articles/about-github-wikis/ + - /articles/about-github-wikis - /articles/about-wikis - /github/building-a-strong-community/about-wikis product: '{% data reusables.gated-features.wikis %}' diff --git a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md index 52cdfdc278..9051feb405 100644 --- a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md +++ b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md @@ -1,11 +1,11 @@ --- -title: ウィキページを追加または編集する -intro: 'ウィキページは、{% data variables.product.product_name %} 上で直接、あるいはコマンドラインを使ってローカルで追加および編集できます。' +title: Adding or editing wiki pages +intro: 'You can add and edit wiki pages directly on {% data variables.product.product_name %} or locally using the command line.' redirect_from: - - /articles/adding-wiki-pages-via-the-online-interface/ - - /articles/editing-wiki-pages-via-the-online-interface/ - - /articles/adding-and-editing-wik-pages-locally/ - - /articles/adding-and-editing-wiki-pages-locally/ + - /articles/adding-wiki-pages-via-the-online-interface + - /articles/editing-wiki-pages-via-the-online-interface + - /articles/adding-and-editing-wik-pages-locally + - /articles/adding-and-editing-wiki-pages-locally - /articles/adding-or-editing-wiki-pages - /github/building-a-strong-community/adding-or-editing-wiki-pages product: '{% data reusables.gated-features.wikis %}' @@ -16,47 +16,55 @@ versions: ghec: '*' topics: - Community -shortTitle: Wikiページの管理 +shortTitle: Manage wiki pages --- -## ウィキページを追加する +## Adding wiki pages {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -3. ページの右上にある [**New Page**] をクリックします。 ![ウィキの新規ページボタン](/assets/images/help/wiki/wiki_new_page_button.png) -4. Markdown 以外のフォーマットで書くために、[Edit mode] ドロップダウンメニューを使い、他のフォーマットをクリックすることもできます。 ![ウィキのマークアップの選択](/assets/images/help/wiki/wiki_dropdown_markup.gif) -5. テキストエディタを使って、ページの内容を追加してください。 ![ウィキの WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png) -6. 追加しようとしている新しいファイルを説明するコミットメッセージを入力してください。 ![ウィキのコミットメッセージ](/assets/images/help/wiki/wiki_commit_message.png) -7. 変更を wiki にコミットするには [**Save Page**] をクリックします。 +3. In the upper-right corner of the page, click **New Page**. + ![Wiki new page button](/assets/images/help/wiki/wiki_new_page_button.png) +4. Optionally, to write in a format other than Markdown, use the Edit mode drop-down menu, and click a different format. + ![Wiki markup selection](/assets/images/help/wiki/wiki_dropdown_markup.gif) +5. Use the text editor to add your page's content. + ![Wiki WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png) +6. Type a commit message describing the new file you’re adding. + ![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png) +7. To commit your changes to the wiki, click **Save Page**. -## ウィキページを編集する +## Editing wiki pages {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -4. ウィキサイドバーを使用して、変更したいページに移動してください。 ページの右上にある [**Edit**] をクリックしてください。 ![ウィキのページ編集ボタン](/assets/images/help/wiki/wiki_edit_page_button.png) -5. テキストエディタを使って、ページの内容を編集します。 ![ウィキの WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png) -6. 変更内容を説明するコミットメッセージを入力します。 ![ウィキのコミットメッセージ](/assets/images/help/wiki/wiki_commit_message.png) -7. 変更を wiki にコミットするには [**Save Page**] をクリックします。 +4. Using the wiki sidebar, navigate to the page you want to change. In the upper-right corner of the page, click **Edit**. + ![Wiki edit page button](/assets/images/help/wiki/wiki_edit_page_button.png) +5. Use the text editor edit the page's content. + ![Wiki WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png) +6. Type a commit message describing your changes. + ![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png) +7. To commit your changes to the wiki, click **Save Page**. -## ローカルでウィキページを追加または編集する +## Adding or editing wiki pages locally -ウィキは Git のリポジトリの一部なので、Git ワークフローを使ってローカルで変更を加え、リポジトリにプッシュできます。 +Wikis are part of Git repositories, so you can make changes locally and push them to your repository using a Git workflow. -### 手元のコンピュータへウィキをクローンする +### Cloning wikis to your computer -すべてのウィキは、その内容をあなたのコンピュータにクローンする簡単な方法を提供しています。 提供されている次の URL でお使いのコンピュータにリポジトリをクローンできます。 +Every wiki provides an easy way to clone its contents down to your computer. +You can clone the repository to your computer with the provided URL: ```shell $ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git -# ローカルに wiki をクローン +# Clones the wiki locally ``` -wiki をクローンした後は、新しいファイルの追加、既存のファイルの編集、変更のコミットができます。 ユーザとコラボレータは、Wiki で作業するときにブランチを作成できますが、デフォルトブランチにプッシュされた変更のみがライブになり、読者はそれのみを利用できます。 +Once you have cloned the wiki, you can add new files, edit existing ones, and commit your changes. You and your collaborators can create branches when working on wikis, but only changes pushed to the default branch will be made live and available to your readers. -## ウィキのファイル名について +## About wiki filenames -wiki のページのタイトルはファイル名で決まり、ファイルの拡張子で wiki の内容の描画方法が決まります。 +The filename determines the title of your wiki page, and the file extension determines how your wiki content is rendered. -wiki は[弊社のオープンソースマークアップライブラリ](https://github.com/github/markup)でマークアップに変換され、ライブラリはファイルの拡張子によって使用するコンバータが決定されます。 たとえばファイルに *foo.md* あるいは *foo.markdown* という名前を付けた場合、wiki は Markdown コンバータを使います。一方で、*foo.textile* という名前のファイルには Textile コンバータが使われます。 +Wikis use [our open-source Markup library](https://github.com/github/markup) to convert the markup, and it determines which converter to use by a file's extension. For example, if you name a file *foo.md* or *foo.markdown*, wiki will use the Markdown converter, while a file named *foo.textile* will use the Textile converter. -wiki ページのタイトルには `\ / : * ? " < > |` という文字は使わないでください。 特定のオペレーティングシステムのユーザは、これらの文字を含むファイル名を扱えません。 内容を書く上では、拡張子にマッチしたマークアップ言語を使ってください。そうなっていない場合、内容は正しく描画されません。 +Don't use the following characters in your wiki page's titles: `\ / : * ? " < > |`. Users on certain operating systems won't be able to work with filenames containing these characters. Be sure to write your content using a markup language that matches the extension, or your content won't render properly. diff --git a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md index 6e13f93ce4..06192a9266 100644 --- a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md +++ b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md @@ -1,9 +1,9 @@ --- -title: ウィキにフッタやサイドバーを作成する -intro: カスタムのサイドバーやフッタをウィキに追加して、さらに多くのコンテキスト情報を読者に提供できます。 +title: Creating a footer or sidebar for your wiki +intro: You can add a custom sidebar or footer to your wiki to provide readers with more contextual information. redirect_from: - - /articles/creating-a-footer/ - - /articles/creating-a-sidebar/ + - /articles/creating-a-footer + - /articles/creating-a-sidebar - /articles/creating-a-footer-or-sidebar-for-your-wiki - /github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki product: '{% data reusables.gated-features.wikis %}' @@ -14,27 +14,33 @@ versions: ghec: '*' topics: - Community -shortTitle: フッターまたはサイドバーの作成 +shortTitle: Create footer or sidebar --- -## フッタの作成 +## Creating a footer {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -3. ページの下部にある [**Add a custom footer**] をクリックします。 ![ウィキのフッタセクションの追加](/assets/images/help/wiki/wiki_add_footer.png) -4. テキストエディタを使用して、フッタに表示するコンテンツを入力します。 ![ウィキの WYSIWYG](/assets/images/help/wiki/wiki-footer.png) -5. 追加中のフッタを説明するコミットメッセージを入力します。 ![ウィキのコミットメッセージ](/assets/images/help/wiki/wiki_commit_message.png) -6. 変更を wiki にコミットするには [**Save Page**] をクリックします。 +3. At the bottom of the page, click **Add a custom footer**. + ![Wiki add footer section](/assets/images/help/wiki/wiki_add_footer.png) +4. Use the text editor to type the content you want your footer to have. + ![Wiki WYSIWYG](/assets/images/help/wiki/wiki-footer.png) +5. Enter a commit message describing the footer you’re adding. + ![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png) +6. To commit your changes to the wiki, click **Save Page**. -## サイドバーの作成 +## Creating a sidebar {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -3. [**Add a custom sidebar**] をクリックします。 ![ウィキのサイドバーの追加](/assets/images/help/wiki/wiki_add_sidebar.png) -4. テキストエディタを使って、ページの内容を追加してください。 ![ウィキの WYSIWYG](/assets/images/help/wiki/wiki-sidebar.png) -5. 追加するサイドバーを説明するコミットメッセージを入力します。 ![ウィキのコミットメッセージ](/assets/images/help/wiki/wiki_commit_message.png) -6. 変更を wiki にコミットするには [**Save Page**] をクリックします。 +3. Click **Add a custom sidebar**. + ![Wiki add sidebar section](/assets/images/help/wiki/wiki_add_sidebar.png) +4. Use the text editor to add your page's content. + ![Wiki WYSIWYG](/assets/images/help/wiki/wiki-sidebar.png) +5. Enter a commit message describing the sidebar you’re adding. + ![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png) +6. To commit your changes to the wiki, click **Save Page**. -## フッタまたはサイドバーをローカルで作成 +## Creating a footer or sidebar locally -`_Footer.` というファイルがフッタの、そして `_Sidebar.` というファイルがサイドバーの内容として使われます。 他のすべてのウィキページと同じく、これらのファイルは、その拡張子に応じて描画されます。 +If you create a file named `_Footer.` or `_Sidebar.`, we'll use them to populate the footer and sidebar of your wiki, respectively. Like every other wiki page, the extension you choose for these files determines how we render them. diff --git a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md index 820f2a0a12..c132ba8340 100644 --- a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md +++ b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md @@ -1,14 +1,14 @@ --- -title: ウィキのコンテンツを編集する -intro: ウィキ内のコンテンツに画像やリンクを追加したり、一部のサポートされている MediaWiki 形式を使用したりできます。 +title: Editing wiki content +intro: 'You can add images and links to content in your wiki, and use some supported MediaWiki formats.' redirect_from: - - /articles/adding-links-to-wikis/ - - /articles/how-do-i-add-links-to-my-wiki/ - - /articles/how-do-i-add-or-upload-images-to-the-wiki/ - - /articles/needs-writing-review-how-do-i-add-or-upload-images-to-the-wiki/ - - /articles/how-do-i-add-images-to-my-wiki/ - - /articles/adding-images-to-wikis/ - - /articles/supported-mediawiki-formats/ + - /articles/adding-links-to-wikis + - /articles/how-do-i-add-links-to-my-wiki + - /articles/how-do-i-add-or-upload-images-to-the-wiki + - /articles/needs-writing-review-how-do-i-add-or-upload-images-to-the-wiki + - /articles/how-do-i-add-images-to-my-wiki + - /articles/adding-images-to-wikis + - /articles/supported-mediawiki-formats - /articles/editing-wiki-content - /github/building-a-strong-community/editing-wiki-content product: '{% data reusables.gated-features.wikis %}' @@ -21,39 +21,40 @@ topics: - Community --- -## リンクの追加 +## Adding links -ページでサポートされている標準的なマークアップや MediaWiki の構文を使ってウィキにリンクを作成できます。 例: +You can create links in wikis using the standard markup supported by your page, or using MediaWiki syntax. For example: -- ページが Markdown でレンダリングされる場合、リンクの構文は `[Link Text](full-URL-of-wiki-page)` です。 -- MediaWiki 構文では、リンクの構文は `[[Link Text|nameofwikipage]]` となります。 +- If your pages are rendered with Markdown, the link syntax is `[Link Text](full-URL-of-wiki-page)`. +- With MediaWiki syntax, the link syntax is `[[Link Text|nameofwikipage]]`. -## 画像の追加 +## Adding images -ウィキでは PNG、JPEG、および GIF 画像を表示できます。 +Wikis can display PNG, JPEG, and GIF images. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %} -3. ウィキ サイドバーを使って、変更したいページにアクセスし、[**Edit**] をクリックします。 -4. ウィキ ツールバーで [**Image**] をクリックします。 ![ウィキの画像追加ボタン](/assets/images/help/wiki/wiki_add_image.png) -5. [Insert Image] ダイアログボックスで、画像の URL と代替テキスト (これは検索エンジンや画像リーダーで使われます) を入力します。 -6. [**OK**] をクリックします。 +3. Using the wiki sidebar, navigate to the page you want to change, and then click **Edit**. +4. On the wiki toolbar, click **Image**. + ![Wiki Add image button](/assets/images/help/wiki/wiki_add_image.png) +5. In the "Insert Image" dialog box, type the image URL and the alt text (which is used by search engines and screen readers). +6. Click **OK**. -### リポジトリでの画像へのリンク +### Linking to images in a repository -{% data variables.product.product_name %}上のリポジトリにある画像は、ブラウザで URL をコピーし、それを画像へのパスとして利用することでリンクできます。 たとえば、Markdown を使ってウィキに画像を埋め込むと、以下のようになります: +You can link to an image in a repository on {% data variables.product.product_name %} by copying the URL in your browser and using that as the path to the image. For example, embedding an image in your wiki using Markdown might look like this: [[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]] -## サポートされる MediaWiki 形式 +## Supported MediaWiki formats -ウィキがどのマークアップ言語で書かれたかにかかわらず、特定の MediaWiki 構文を常に使用できます。 -- リンク ([Asciidoc を除く](https://github.com/gollum/gollum/commit/d1cf698b456cd6a35a54c6a8e7b41d3068acec3b)) -- 水平罫線: `---` -- 省略記号エンティティ (`δ` や `€` など) +No matter which markup language your wiki page is written in, certain MediaWiki syntax will always be available to you. +- Links ([except Asciidoc](https://github.com/gollum/gollum/commit/d1cf698b456cd6a35a54c6a8e7b41d3068acec3b)) +- Horizontal rules via `---` +- Shorthand symbol entities (such as `δ` or `€`) -セキュリティとパフォーマンス上の理由により、一部の構文はサポートされていません。 -- [トランスクルージョン](https://www.mediawiki.org/wiki/Transclusion) -- 定義リスト -- インデント -- 目次 +For security and performance reasons, some syntaxes are unsupported. +- [Transclusion](https://www.mediawiki.org/wiki/Transclusion) +- Definition lists +- Indentation +- Table of contents diff --git a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/index.md b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/index.md index 50c92afc22..fbec09d8fc 100644 --- a/translations/ja-JP/content/communities/documenting-your-project-with-wikis/index.md +++ b/translations/ja-JP/content/communities/documenting-your-project-with-wikis/index.md @@ -1,10 +1,10 @@ --- -title: ウィキでプロジェクトを文書化する -shortTitle: Wikiを使用する -intro: ウィキを使用してプロジェクトに関する具体的な長文形式の情報を共有できます。 +title: Documenting your project with wikis +shortTitle: Using wikis +intro: 'You can use a wiki to share detailed, long-form information about your project.' redirect_from: - - /categories/49/articles/ - - /categories/wiki/ + - /categories/49/articles + - /categories/wiki - /articles/documenting-your-project-with-wikis - /github/building-a-strong-community/documenting-your-project-with-wikis product: '{% data reusables.gated-features.wikis %}' diff --git a/translations/ja-JP/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md b/translations/ja-JP/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md index 850a481bd2..d2c37ba9c1 100644 --- a/translations/ja-JP/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md +++ b/translations/ja-JP/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md @@ -1,8 +1,8 @@ --- -title: リポジトリでのインタラクションを制限する -intro: パブリックリポジトリ上の特定のユーザに対して、一定期間アクティビティ制限を適用することができます。 +title: Limiting interactions in your repository +intro: You can temporarily enforce a period of limited activity for certain users on a public repository. redirect_from: - - /articles/limiting-interactions-with-your-repository/ + - /articles/limiting-interactions-with-your-repository - /articles/limiting-interactions-in-your-repository - /github/building-a-strong-community/limiting-interactions-in-your-repository versions: @@ -11,30 +11,32 @@ versions: permissions: People with admin permissions to a repository can temporarily limit interactions in that repository. topics: - Community -shortTitle: リポジトリ内でのインタラクションの制限 +shortTitle: Limit interactions in repo --- -## 一時的なインタラクションの制限について +## About temporary interaction limits {% data reusables.community.interaction-limits-restrictions %} -{% data reusables.community.interaction-limits-duration %} 制限期間が過ぎると、ユーザはリポジトリで通常のアクティビティを再開できます。 +{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your repository. {% data reusables.community.types-of-interaction-limits %} -ユーザアカウントまたは Organization が所有するすべてのリポジトリでアクティビティ制限を有効にすることもできます。 ユーザ全体または Organization 全体の制限が有効になっている場合、そのアカウントが所有する個々のリポジトリのアクティビティを制限することはできません。 詳しい情報については、「[ユーザアカウントのインタラクションを制限する](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)」と「[Organization 内のインタラクションを制限する](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)」を参照してください。 +You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)." -## リポジトリでのインタラクションを制限する +## Limiting interactions in your repository {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. 左サイドバーで [**Moderation settings**] をクリックします。 ![[Repository settings] サイトバーの [Moderation settings]](/assets/images/help/repository/repo-settings-moderation-settings.png) -1. [Moderation settings] で、[**Interaction limits**] をクリックします。 ![リポジトリの設定での [Interaction limits] ](/assets/images/help/repository/repo-settings-interaction-limits.png) +1. In the left sidebar, click **Moderation settings**. + !["Moderation settings" in repository settings sidebar](/assets/images/help/repository/repo-settings-moderation-settings.png) +1. Under "Moderation settings", click **Interaction limits**. + ![Interaction limits in repository settings ](/assets/images/help/repository/repo-settings-interaction-limits.png) {% data reusables.community.set-interaction-limit %} - ![[Temporary interaction limits] のオプション](/assets/images/help/repository/temporary-interaction-limits-options.png) + ![Temporary interaction limit options](/assets/images/help/repository/temporary-interaction-limits-options.png) -## 参考リンク -- [悪用あるいはスパムのレポート](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) -- [Organizationのリポジトリへの個人のアクセスの管理](/articles/managing-an-individual-s-access-to-an-organization-repository) -- [ユーザアカウントのリポジトリ権限レベル](/articles/permission-levels-for-a-user-account-repository) +## Further reading +- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" +- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)" +- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" diff --git a/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md b/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md index dd49527f30..e0cecf6b62 100644 --- a/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md +++ b/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md @@ -1,8 +1,8 @@ --- -title: パブリックリポジトリのコミュニティプロフィールについて -intro: リポジトリメンテナは、コミュニティの成長を支援し、コントリビューターをサポートする方法を学ぶために、パブリックリポジトリのコミュニティプロフィールをレビューできます。 コントリビューターは、プロジェクトにコントリビュートしたいかを知るために、パブリックリポジトリのコミュニティプロフィールを見ることができます。 +title: About community profiles for public repositories +intro: Repository maintainers can review their public repository's community profile to learn how they can help grow their community and support contributors. Contributors can view a public repository's community profile to see if they want to contribute to the project. redirect_from: - - /articles/viewing-your-community-profile/ + - /articles/viewing-your-community-profile - /articles/about-community-profiles-for-public-repositories - /github/building-a-strong-community/about-community-profiles-for-public-repositories versions: @@ -10,36 +10,36 @@ versions: ghec: '*' topics: - Community -shortTitle: コミュニティプロフィール +shortTitle: Community profiles --- -コミュニティプロフィールチェックリストは、README、CODE_OF_CONDUCT、LICENSE、CONTRIBUTING といった推奨されるコミュニティ健全性ファイル群が、サポートされている場所でプロジェクトに含まれているかをチェックします。 詳しい情報については[プロジェクトのコミュニティプロフィールへのアクセス](/articles/accessing-a-project-s-community-profile)を参照してください。 +The community profile checklist checks to see if a project includes recommended community health files, such as README, CODE_OF_CONDUCT, LICENSE, or CONTRIBUTING, in a supported location. For more information, see "[Accessing a project's community profile](/articles/accessing-a-project-s-community-profile)." -## リポジトリメンテナとしてのコミュニティプロフィールチェックリストの利用 +## Using the community profile checklist as a repository maintainer -リポジトリメンテナとして、人々がプロジェクトを使い、コントリビュートするのを助けるための推奨されるコミュニティ標準をプロジェクトが満たしているかを確認するために、コミュニティプロフィールチェックリストを使ってください。 詳しい情報についてはOpen Source Guides中の[コミュニティの構築](https://opensource.guide/building-community/)を参照してください。 +As a repository maintainer, use the community profile checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "[Building community](https://opensource.guide/building-community/)" in the Open Source Guides. -プロジェクトが持っていない推奨されているファイルがあるなら、**Add（追加）**をクリックしてファイルのドラフトを作成し、サブミットしてください。 +If a project doesn't have a recommended file, you can click **Add** to draft and submit a file. -{% data reusables.repositories.valid-community-issues %}詳細は「[Issue およびプルリクエストのテンプレートについて](/articles/about-issue-and-pull-request-templates)」を参照してください。 +{% data reusables.repositories.valid-community-issues %} For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)." -![メンテナのための推奨されるコミュニティ標準を持つコミュニティプロフィールチェックリスト](/assets/images/help/repository/add-button-community-profile.png) +![Community profile checklist with recommended community standards for maintainers](/assets/images/help/repository/add-button-community-profile.png) {% data reusables.repositories.security-guidelines %} -## コミュニティメンバーあるいはコラボレータとしてのコミュニティプロフィールチェックリストの利用 +## Using the community profile checklist as a community member or collaborator -コントリビューターになりたい場合は、コミュニティプロフィールチェックリストで、参加したいプロジェクトが推奨されるコミュニティ基準を満たしているかを確認してから、コントリビュートするかを決めてください。 詳しい情報については、Open Source Guides の「[コントリビュートの方法](https://opensource.guide/how-to-contribute/#anatomy-of-an-open-source-project)」を参照してください。 +As a potential contributor, use the community profile checklist to see if a project meets the recommended community standards and decide if you'd like to contribute. For more information, see "[How to contribute](https://opensource.guide/how-to-contribute/#anatomy-of-an-open-source-project)" in the Open Source Guides. -プロジェクトに推奨されているファイルがないなら、**[Propose]** をクリックし、ファイルのドラフトを作成してから、そのファイルをサブミットしてリポジトリメンテナに承認を仰ぐことができます。 +If a project doesn't have a recommended file, you can click **Propose** to draft and submit a file to the repository maintainer for approval. -![コントリビューターのための推奨されるコミュニティ標準を持つコミュニティプロフィールチェックリスト](/assets/images/help/repository/propose-button-community-profile.png) +![Community profile checklist with recommended community standards for contributors](/assets/images/help/repository/propose-button-community-profile.png) -## 参考リンク +## Further reading -- [プロジェクトへの行動規範の追加](/articles/adding-a-code-of-conduct-to-your-project) -- [リポジトリコントリビューターのためのガイドラインを定める](/articles/setting-guidelines-for-repository-contributors) -- [リポジトリへのライセンスの追加](/articles/adding-a-license-to-a-repository) -- [Issueとプルリクエストのテンプレートについて](/articles/about-issue-and-pull-request-templates) +- "[Adding a code of conduct to your project](/articles/adding-a-code-of-conduct-to-your-project)" +- "[Setting guidelines for repository contributors](/articles/setting-guidelines-for-repository-contributors)" +- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)" +- "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)" - "[Open Source Guides](https://opensource.guide/)" - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}) diff --git a/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/index.md b/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/index.md index 0589808ec9..f732f0c105 100644 --- a/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/index.md +++ b/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/index.md @@ -1,9 +1,9 @@ --- -title: 健全なコントリビューションを促すプロジェクトをセットアップする -shortTitle: 健全なコントリビューション -intro: リポジトリメンテナは、コントリビューションガイドラインを設定することで、コントリビュータがプロジェクトに対して意味のある有益なコントリビューションを行うことに役立ちます。 +title: Setting up your project for healthy contributions +shortTitle: Healthy contributions +intro: 'Repository maintainers can set contributing guidelines to help collaborators make meaningful, useful contributions to a project.' redirect_from: - - /articles/helping-people-contribute-to-your-project/ + - /articles/helping-people-contribute-to-your-project - /articles/setting-up-your-project-for-healthy-contributions - /github/building-a-strong-community/setting-up-your-project-for-healthy-contributions versions: diff --git a/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index 7a348df6f9..c5bb1df6a6 100644 --- a/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -7,7 +7,7 @@ versions: ghae: '*' ghec: '*' redirect_from: - - /articles/how-do-i-set-up-guidelines-for-contributors/ + - /articles/how-do-i-set-up-guidelines-for-contributors - /articles/setting-guidelines-for-repository-contributors - /github/building-a-strong-community/setting-guidelines-for-repository-contributors topics: diff --git a/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md b/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md index 6c5503c646..9974eff8e8 100644 --- a/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md +++ b/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md @@ -1,10 +1,10 @@ --- -title: テンプレートを使用して便利な Issue やプルリクエストを推進する -shortTitle: Issue および PR テンプレート -intro: リポジトリメンテナは、コントリビューターが質の高い Issue とプルリクエストを作成できるように、リポジトリにテンプレートを追加できます。 +title: Using templates to encourage useful issues and pull requests +shortTitle: Issue & PR templates +intro: Repository maintainers can add templates in a repository to help contributors create high-quality issues and pull requests. redirect_from: - /github/building-a-strong-community/using-issue-and-pull-request-templates - - /articles/using-templates-to-encourage-high-quality-issues-and-pull-requests-in-your-repository/ + - /articles/using-templates-to-encourage-high-quality-issues-and-pull-requests-in-your-repository - /articles/using-issue-and-pull-request-templates - /github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests versions: diff --git a/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md b/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md index 8b57229ddd..cbf6716233 100644 --- a/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md +++ b/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md @@ -1,8 +1,8 @@ --- -title: リポジトリ用の単一 Issue テンプレートを手動で作成する -intro: 手動で作成した Issue テンプレートをリポジトリに追加すると、プロジェクトのコントリビューターは自動的に Issue の本体でテンプレートの内容が見えるようになります。 +title: Manually creating a single issue template for your repository +intro: 'When you add a manually-created issue template to your repository, project contributors will automatically see the template''s contents in the issue body.' redirect_from: - - /articles/creating-an-issue-template-for-your-repository/ + - /articles/creating-an-issue-template-for-your-repository - /articles/manually-creating-a-single-issue-template-for-your-repository - /github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository versions: @@ -12,16 +12,16 @@ versions: ghec: '*' topics: - Community -shortTitle: Issue テンプレートの作成 +shortTitle: Create an issue template --- {% data reusables.repositories.legacy-issue-template-tip %} -サポートしているどのフォルダーにでも *ISSUE_TEMPLATE/* サブディレクトリを作成し、Issue テンプレートを複数含めることができます。また、`template` クエリパラメータで Issue の本文に使用するテンプレートを指定できます。 詳細は「[クエリパラメータによる Issue およびプルリクエストの自動化について](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)」を参照してください。 +You can create an *ISSUE_TEMPLATE/* subdirectory in any of the supported folders to contain multiple issue templates, and use the `template` query parameter to specify the template that will fill the issue body. For more information, see "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)." -YAML frontmatter を各 Issue テンプレートに追加して、Issue のタイトルを事前に入力したり、ラベルおよびアサインされた人を自動追加したり、リポジトリに新しい Issue を作成するときに表示されるテンプレート選択画面に表示されるテンプレートの名前と説明を指定したりすることができます。 +You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository. -YAML front matter の例は次のとおりです。 +Here is example YAML front matter. ```yaml --- @@ -34,7 +34,7 @@ assignees: octocat ``` {% note %} -**注釈:** フロントマター値に `:` などの YAML特殊文字が含まれている場合は、値全体を引用符で囲む必要があります。 たとえば、`":bug: Bug"` または `":new: triage needed, :bug: bug"` などです。 +**Note:** If a front matter value includes a YAML-reserved character such as `:` , you must put the whole value in quotes. For example, `":bug: Bug"` or `":new: triage needed, :bug: bug"`. {% endnote %} @@ -50,27 +50,31 @@ assignees: octocat {% endif %} -## Issue テンプレートを追加する +## Adding an issue template {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. ファイル名フィールドで: - - Issue テンプレートをリポジトリのルートディレクトリで表示するには、*issue_template* の名前を入力します。 たとえば、`issue_template.md` です。 ![ルートディレクトリの新しい Issue テンプレート名](/assets/images/help/repository/issue-template-file-name.png) - - リポジトリの `docs` ディレクトリに Issue テンプレートを表示するには、*docs/* に続けて *issue_template* の名前を入力します。 たとえば、`docs/issue_template.md` です。 ![docs ディレクトリの新しい Issue テンプレート](/assets/images/help/repository/issue-template-file-name-docs.png) - - ファイルを隠しディレクトリに格納するには、*.github/* と入力し、続いて *issue_template* という名前を入力します。 たとえば、`.github/issue_template.md` です。 ![隠しディレクトリの新しい Issue テンプレート](/assets/images/help/repository/issue-template-hidden-directory.png) - - 複数 Issue テンプレートを作成し、`template` クエリパラメータを使用して Issue の本文に使用するテンプレートを指定するには、*.github/ISSUE_TEMPLATE/* と入力し、続けて Issue テンプレートの名前を入力します。 たとえば、`.github/ISSUE_TEMPLATE/issue_template.md` です。 複数 Issue テンプレートをルートディレクトリや `docs/` ディレクトリにある `ISSUE_TEMPLATE` サブディレクトリに格納することもできます。 詳細は「[クエリパラメータによる Issue およびプルリクエストの自動化について](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)」を参照してください。 ![隠しディレクトリの新しい複数 Issue テンプレート](/assets/images/help/repository/issue-template-multiple-hidden-directory.png) -4. 新しいファイルの本文に Issue テンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります: +3. In the file name field: + - To make your issue template visible in the repository's root directory, type the name of your *issue_template*. For example, `issue_template.md`. + ![New issue template name in root directory](/assets/images/help/repository/issue-template-file-name.png) + - To make your issue template visible in the repository's `docs` directory, type *docs/* followed by the name of your *issue_template*. For example, `docs/issue_template.md`, + ![New issue template in docs directory](/assets/images/help/repository/issue-template-file-name-docs.png) + - To store your file in a hidden directory, type *.github/* followed by the name of your *issue_template*. For example, `.github/issue_template.md`. + ![New issue template in hidden directory](/assets/images/help/repository/issue-template-hidden-directory.png) + - To create multiple issue templates and use the `template` query parameter to specify a template to fill the issue body, type *.github/ISSUE_TEMPLATE/*, then the name of your issue template. For example, `.github/ISSUE_TEMPLATE/issue_template.md`. You can also store multiple issue templates in an `ISSUE_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)." + ![New multiple issue template in hidden directory](/assets/images/help/repository/issue-template-multiple-hidden-directory.png) +4. In the body of the new file, add your issue template. This could include: - YAML frontmatter - - 予測される動作と実際の動作 - - 問題の再現手順 - - プロジェクトのベンダー、オペレーティング システム、ハードウェアなどの仕様 + - Expected behavior and actual behavior + - Steps to reproduce the problem + - Specifications like the version of the project, operating system, or hardware {% data reusables.files.write_commit_message %} -{% data reusables.files.choose_commit_branch %} テンプレートがリポジトリのデフォルトブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。 +{% data reusables.files.choose_commit_branch %} Templates are available to collaborators when they are merged into the repository's default branch. {% data reusables.files.propose_new_file %} -## 参考リンク +## Further reading -- [Issueとプルリクエストのテンプレートについて](/articles/about-issue-and-pull-request-templates) -- [リポジトリ用に Issue テンプレートを設定する](/articles/configuring-issue-templates-for-your-repository) -- 「[クエリパラメータによる Issue およびプルリクエストの自動化について](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)」 -- [Issue の作成](/articles/creating-an-issue) +- "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)" +- "[Configuring issue templates for your repository](/articles/configuring-issue-templates-for-your-repository)" +- "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)" +- "[Creating an issue](/articles/creating-an-issue)" diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index ac19991197..c876fc183c 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -1,9 +1,9 @@ --- -title: GitHub App による認証 +title: Authenticating with GitHub Apps intro: '{% data reusables.shortdesc.authenticating_with_github_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/ - - /apps/building-github-apps/authentication-options-for-github-apps/ + - /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps + - /apps/building-github-apps/authentication-options-for-github-apps - /apps/building-github-apps/authenticating-with-github-apps - /developers/apps/authenticating-with-github-apps versions: @@ -13,59 +13,61 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 認証 +shortTitle: Authentication --- -## 秘密鍵を生成する +## Generating a private key -GitHub App の作成後は、1 つ以上の秘密鍵を生成する必要があります。 アクセストークンのリクエストに署名するには、この秘密鍵を使用します。 +After you create a GitHub App, you'll need to generate one or more private keys. You'll use the private key to sign access token requests. -鍵が危殆化したり、鍵を紛失した場合にダウンタイムを回避するため、複数の秘密鍵を作成してローテーションすることができます。 秘密鍵が公開鍵と適合することを確認するには、[秘密鍵を検証する](#verifying-private-keys)を参照してください。 +You can create multiple private keys and rotate them to prevent downtime if a key is compromised or lost. To verify that a private key matches a public key, see [Verifying private keys](#verifying-private-keys). -秘密鍵を生成するには、以下の手順に従います。 +To generate a private key: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} {% data reusables.user-settings.modify_github_app %} -5. [Private keys] で、[**Generate a private key**] をクリックします。 ![秘密鍵の生成](/assets/images/github-apps/github_apps_generate_private_keys.png) -6. お手元のコンピュータにダウンロードされた PEM フォーマットの秘密鍵が表示されます。 このファイルは必ず保存してください。GitHub では公開鍵の部分しか保存しません。 +5. In "Private keys", click **Generate a private key**. +![Generate private key](/assets/images/github-apps/github_apps_generate_private_keys.png) +6. You will see a private key in PEM format downloaded to your computer. Make sure to store this file because GitHub only stores the public portion of the key. {% note %} -**注釈:** 特定のファイルフォーマットが必要なライブラリを使用している場合、ダウンロードする PEM ファイルは `PKCS#1 RSAPrivateKey` フォーマットになります。 +**Note:** If you're using a library that requires a specific file format, the PEM file you download will be in `PKCS#1 RSAPrivateKey` format. {% endnote %} -## 秘密鍵を検証する -{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. 秘密鍵のフィンガープリントを生成し、{% data variables.product.product_name %} で表示されているフィンガープリントと比較することにより、秘密鍵が {% data variables.product.product_name %} に保存宇されている公開鍵と適合することを検証できます。 +## Verifying private keys +{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. You can verify that your private key matches the public key stored on {% data variables.product.product_name %} by generating the fingerprint of your private key and comparing it to the fingerprint shown on {% data variables.product.product_name %}. -秘密鍵を検証するには、以下の手順に従います。 +To verify a private key: -1. {% data variables.product.prodname_github_app %} の開発者設定ページにある [Private keys] セクションで、検証する秘密鍵と公開鍵のペアを見つけます。 詳しい情報については、[秘密鍵を生成する](#generating-a-private-key)を参照してください。 ![秘密鍵のフィンガープリント](/assets/images/github-apps/github_apps_private_key_fingerprint.png) -2. 次のコマンドを使用して、秘密鍵 (PEM) のフィンガープリントをローカルで生成します。 +1. Find the fingerprint for the private and public key pair you want to verify in the "Private keys" section of your {% data variables.product.prodname_github_app %}'s developer settings page. For more information, see [Generating a private key](#generating-a-private-key). +![Private key fingerprint](/assets/images/github-apps/github_apps_private_key_fingerprint.png) +2. Generate the fingerprint of your private key (PEM) locally by using the following command: ```shell $ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64 ``` -3. ローカルで生成されたフィンガープリントの結果と、{% data variables.product.product_name %} に表示されているフィンガープリントを比較します。 +3. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}. -## 秘密鍵を削除する -紛失や危殆化した秘密鍵は削除できますが、最低 1 つは秘密鍵を所有する必要があります。 鍵が 1 つしかない場合、その鍵を削除する前に新しい鍵を生成する必要があります。 ![直近の秘密鍵を削除する](/assets/images/github-apps/github_apps_delete_key.png) +## Deleting private keys +You can remove a lost or compromised private key by deleting it, but you must have at least one private key. When you only have one key, you will need to generate a new one before deleting the old one. +![Deleting last private key](/assets/images/github-apps/github_apps_delete_key.png) -## {% data variables.product.prodname_github_app %} として認証を行う +## Authenticating as a {% data variables.product.prodname_github_app %} -{% data variables.product.prodname_github_app %} として認証を行うと、以下のことが可能になります。 +Authenticating as a {% data variables.product.prodname_github_app %} lets you do a couple of things: -* {% data variables.product.prodname_github_app %} について管理情報の概要を取得できます。 -* アプリケーションのインストールのため、アクセストークンをリクエストできます。 +* You can retrieve high-level management information about your {% data variables.product.prodname_github_app %}. +* You can request access tokens for an installation of the app. -{% data variables.product.prodname_github_app %} として認証するには、PEM フォーマットで[秘密鍵を生成](#generating-a-private-key)し、ローカルマシンにダウンロードします。 この鍵を使用して [JSON Web Token (JWT)](https://jwt.io/introduction) に署名し、`RS256` アルゴリズムを使用してエンコードします。 {% data variables.product.product_name %} は、トークンをアプリケーションが保存する公開鍵で検証することにより、リクエストが認証されていることを確認します。 +To authenticate as a {% data variables.product.prodname_github_app %}, [generate a private key](#generating-a-private-key) in PEM format and download it to your local machine. You'll use this key to sign a [JSON Web Token (JWT)](https://jwt.io/introduction) and encode it using the `RS256` algorithm. {% data variables.product.product_name %} checks that the request is authenticated by verifying the token with the app's stored public key. -JWT を生成するために使用できる簡単な Ruby スクリプトを掲載します。 `gem install jwt` を実行してから、このスクリプトを使用してください。 +Here's a quick Ruby script you can use to generate a JWT. Note you'll have to run `gem install jwt` before using it. - ```ruby require 'openssl' require 'jwt' # https://rubygems.org/gems/jwt @@ -88,19 +90,19 @@ jwt = JWT.encode(payload, private_key, "RS256") puts jwt ``` -`YOUR_PATH_TO_PEM` と `YOUR_APP_ID` の値は置き換えてください。 値はダブルクオートで囲んでください。 +`YOUR_PATH_TO_PEM` and `YOUR_APP_ID` are the values you must replace. Make sure to enclose the values in double quotes. -{% data variables.product.prodname_github_app %} の識別子 (`YOUR_APP_ID`) を、JWT [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) (発行者) クレームの値として使用します。 {% data variables.product.prodname_github_app %} 識別子は、[アプリケーションを作成](/apps/building-github-apps/creating-a-github-app/)後の最初の webhook ping から、または GitHub.com UI のアプリケーション設定ページからいつでも取得できます。 +Use your {% data variables.product.prodname_github_app %}'s identifier (`YOUR_APP_ID`) as the value for the JWT [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) (issuer) claim. You can obtain the {% data variables.product.prodname_github_app %} identifier via the initial webhook ping after [creating the app](/apps/building-github-apps/creating-a-github-app/), or at any time from the app settings page in the GitHub.com UI. -JWT を作成後は、それを API リクエストの `Header` に設定します。 +After creating the JWT, set it in the `Header` of the API request: ```shell $ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.v3+json" {% data variables.product.api_url_pre %}/app ``` -`YOUR_JWT` の値は置き換えてください。 +`YOUR_JWT` is the value you must replace. -上記の例では、最大有効期限として 10 分間を設定し、その後は API が `401` エラーを返し始めます。 +The example above uses the maximum expiration time of 10 minutes, after which the API will start returning a `401` error: ```json { @@ -109,19 +111,19 @@ $ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github } ``` -有効期限が経過した後は、JWT を新しく作成する必要があります。 +You'll need to create a new JWT after the time expires. -## {% data variables.product.prodname_github_app %} として API エンドポイントにアクセスする +## Accessing API endpoints as a {% data variables.product.prodname_github_app %} -{% data variables.product.prodname_github_app %} の概要を取得するために使用できる REST API エンドポイントの一覧については、「[GitHub App](/rest/reference/apps)」を参照してください。 +For a list of REST API endpoints you can use to get high-level information about a {% data variables.product.prodname_github_app %}, see "[GitHub Apps](/rest/reference/apps)." -## インストールとして認証を行う +## Authenticating as an installation -インストールとして認証を行うと、そのインストールの API でアクションを実行できます。 インストールとして認証を行う前に、インストールアクセストークンを作成する必要があります。 GitHub Appが少なくとも1つのリポジトリにインストールされていることを確認してください。まったくインストールされていない場合、インストールトークンを作成することは不可能です。 インストールアクセストークンは、認証を行うため {% data variables.product.prodname_github_apps %} により使用されます。 詳しい情報については「[GitHub Appのインストール](/developers/apps/managing-github-apps/installing-github-apps)」を参照してください。 +Authenticating as an installation lets you perform actions in the API for that installation. Before authenticating as an installation, you must create an installation access token. Ensure that you have already installed your GitHub App to at least one repository; it is impossible to create an installation token without a single installation. These installation access tokens are used by {% data variables.product.prodname_github_apps %} to authenticate. For more information, see "[Installing GitHub Apps](/developers/apps/managing-github-apps/installing-github-apps)." -デフォルトでは、インストールトークンのスコープは、インストールがアクセスできるすべてのリポジトリにアクセスできるよう設定されています。 `repository_ids` パラメータを使用すると、インストールアクセストークンのスコープを特定のリポジトリに限定できます。 詳細については、[アプリケーション (エンドポイント) に対するアクセストークンの作成](/rest/reference/apps#create-an-installation-access-token-for-an-app)を参照してください。 インストールアクセストークンは {% data variables.product.prodname_github_app %} によって設定された権限を持ち、1 時間後に期限切れになります。 +By default, installation access tokens are scoped to all the repositories that an installation can access. You can limit the scope of the installation access token to specific repositories by using the `repository_ids` parameter. See the [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app) endpoint for more details. Installation access tokens have the permissions configured by the {% data variables.product.prodname_github_app %} and expire after one hour. -認証されたアプリケーションのインストールを一覧表示するには、[上記で生成した](#jwt-payload) JWT を API リクエストの Authorization ヘッダに含めます。 +To list the installations for an authenticated app, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request: ```shell $ curl -i -X GET \ @@ -130,9 +132,9 @@ $ curl -i -X GET \ {% data variables.product.api_url_pre %}/app/installations ``` -レスポンスには、インストールのリストが含まれ、各インストールの `id` がインストールのアクセストークンを作成するために利用できます。 レスポンスのフォーマットに関する詳しい情報については、「[認証されたアプリケーションのインストールの一覧表示](/rest/reference/apps#list-installations-for-the-authenticated-app)」を参照してください。 +The response will include a list of installations where each installation's `id` can be used for creating an installation access token. For more information about the response format, see "[List installations for the authenticated app](/rest/reference/apps#list-installations-for-the-authenticated-app)." -インストールアクセストークンを作成するには、[上記で生成した](#jwt-payload) JWT を API リクエストの Authorization ヘッダに含め、`:installation_id` をインストールの `id` に置き換えます。 +To create an installation access token, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request and replace `:installation_id` with the installation's `id`: ```shell $ curl -i -X POST \ @@ -141,9 +143,9 @@ $ curl -i -X POST \ {% data variables.product.api_url_pre %}/app/installations/:installation_id/access_tokens ``` -レスポンスには、インストールアクセストークン、有効期限、トークンの権限、およびトークンがアクセスできるリポジトリが含まれます。 レスポンスのフォーマットに関する詳しい情報については、[アプリケーション (エンドポイント) に対するアクセストークンの作成](/rest/reference/apps#create-an-installation-access-token-for-an-app)を参照してください。 +The response will include your installation access token, the expiration date, the token's permissions, and the repositories that the token can access. For more information about the response format, see the [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app) endpoint. -インストールアクセストークンで認証を行うには、インストールアクセストークンを API リクエストの Authorization ヘッダに含めます。 +To authenticate with an installation access token, include it in the Authorization header in the API request: ```shell $ curl -i \ @@ -152,17 +154,17 @@ $ curl -i \ {% data variables.product.api_url_pre %}/installation/repositories ``` -`YOUR_INSTALLATION_ACCESS_TOKEN` の値は置き換えてください。 +`YOUR_INSTALLATION_ACCESS_TOKEN` is the value you must replace. -## インストールとして API エンドポイントにアクセスする +## Accessing API endpoints as an installation -インストールアクセストークンを使用して {% data variables.product.prodname_github_apps %} の概要を取得するために利用できる REST API エンドポイントの一覧については、「[利用可能なエンドポイント](/rest/overview/endpoints-available-for-github-apps)」を参照してください。 +For a list of REST API endpoints that are available for use by {% data variables.product.prodname_github_apps %} using an installation access token, see "[Available Endpoints](/rest/overview/endpoints-available-for-github-apps)." -インストールに関連するエンドポイントの一覧については、「[インストール](/rest/reference/apps#installations)」を参照してください。 +For a list of endpoints related to installations, see "[Installations](/rest/reference/apps#installations)." -## インストールによる HTTP ベースの Git アクセス +## HTTP-based Git access by an installation -リポジトリの `contents` に[権限](/apps/building-github-apps/setting-permissions-for-github-apps/)があるインストールは、インストールアクセストークンを使用して Git へのアクセスを認証できます。 インストールアクセストークンを HTTP パスワードとして使用してください。 +Installations with [permissions](/apps/building-github-apps/setting-permissions-for-github-apps/) on `contents` of a repository, can use their installation access tokens to authenticate for Git access. Use the installation access token as the HTTP password: ```shell git clone https://x-access-token:<token>@github.com/owner/repo.git diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app.md b/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app.md index 1d84ac6ca6..93f56c8090 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app.md @@ -1,9 +1,9 @@ --- -title: GitHub App を作成する +title: Creating a GitHub App intro: '{% data reusables.shortdesc.creating_github_apps %}' redirect_from: - - /early-access/integrations/creating-an-integration/ - - /apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps/ + - /early-access/integrations/creating-an-integration + - /apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps - /apps/building-github-apps/creating-a-github-app - /developers/apps/creating-a-github-app versions: @@ -14,13 +14,12 @@ versions: topics: - GitHub Apps --- - -{% ifversion fpt or ghec %}構成済みの GitHub App を作成できる GitHub App Manifest の使い方については、「[マニフェストから GitHub App を作成する](/apps/building-github-apps/creating-github-apps-from-a-manifest/)」を参照してください。{% endif %} +{% ifversion fpt or ghec %}To learn how to use GitHub App Manifests, which allow people to create preconfigured GitHub Apps, see "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %} {% ifversion fpt or ghec %} {% note %} - **ノート：** {% data reusables.apps.maximum-github-apps-allowed %} + **Note:** {% data reusables.apps.maximum-github-apps-allowed %} {% endnote %} {% endif %} @@ -28,44 +27,57 @@ topics: {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -1. [**New GitHub App**] をクリックします。 ![新しい GitHub App を作成するボタン](/assets/images/github-apps/github_apps_new.png) -1. [GitHub App name] に、アプリケーションの名前を入力します。 ![GitHub App の名前フィールド](/assets/images/github-apps/github_apps_app_name.png) +1. Click **New GitHub App**. +![Button to create a new GitHub App](/assets/images/github-apps/github_apps_new.png) +1. In "GitHub App name", type the name of your app. +![Field for the name of your GitHub App](/assets/images/github-apps/github_apps_app_name.png) - アプリケーションには簡潔で明快な名前を付けましょう。 アプリケーションの名前は、既存の GitHub アカウントと同じ名前にできません。ただし、その名前があなた自身のユーザ名や Organization 名である場合は例外です。 インテグレーションが動作すると、ユーザインターフェース上にアプリケーション名のスラッグが表示されます。 + Give your app a clear and succinct name. Your app cannot have the same name as an existing GitHub account, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your integration takes an action. -1. 必要に応じて、ユーザーに表示されるアプリケーションの説明を [Description] に入力します。 ![GitHub App の説明フィールド](/assets/images/github-apps/github_apps_description.png) -1. [Homepage URL] に、アプリケーションのウェブサイトの完全な URL を入力します。 ![GitHub App のホームページ URL フィールド](/assets/images/github-apps/github_apps_homepage_url.png) +1. Optionally, in "Description", type a description of your app that users will see. +![Field for a description of your GitHub App](/assets/images/github-apps/github_apps_description.png) +1. In "Homepage URL", type the full URL to your app's website. +![Field for the homepage URL of your GitHub App](/assets/images/github-apps/github_apps_homepage_url.png) {% ifversion fpt or ghes > 3.0 or ghec %} -1. [Callback URL] に、ユーザがインストールを認可した後にリダイレクトされる URL を完全な形で入力します。 この URL は、アプリケーションがユーザからサーバへのリクエストを識別して承認する必要がある場合に使用されます。 +1. In "Callback URL", type the full URL to redirect to after a user authorizes the installation. This URL is used if your app needs to identify and authorize user-to-server requests. - [**Add callback URL**] を使用して、コールバック URL を最大 10 個追加できます。 + You can use **Add callback URL** to provide additional callback URLs, up to a maximum of 10. - ![[Add callback URL] のボタンと コールバック URL のフィールド](/assets/images/github-apps/github_apps_callback_url_multiple.png) + ![Button for 'Add callback URL' and field for callback URL](/assets/images/github-apps/github_apps_callback_url_multiple.png) {% else %} -1. [User authorization callback URL] に、ユーザーがインストールを認可した後にリダイレクトされる URL を完全な形で入力します。 この URL は、アプリケーションがユーザからサーバへのリクエストを識別して承認する必要がある場合に使用されます。 ![GitHub App のユーザ認可コールバック URL フィールド](/assets/images/github-apps/github_apps_user_authorization.png) +1. In "User authorization callback URL", type the full URL to redirect to after a user authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests. +![Field for the user authorization callback URL of your GitHub App](/assets/images/github-apps/github_apps_user_authorization.png) {% endif %} -1. デフォルトでは、アプリケーションのセキュリティを高めるため、アプリケーションは期限付きのユーザ認可トークンを使用します。 期限付きのユーザトークンの使用をオプトアウトするには、[Expire user authorization tokens] の選択を解除する必要があります。 リフレッシュトークンフローの設定と、期限付きユーザトークンの利点に関する詳細については、「[ユーザからサーバーに対するアクセストークンをリフレッシュする](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)」を参照してください。 ![GitHub App のセットアップ中に期限付きユーザトークンをオプトインするオプション](/assets/images/github-apps/expire-user-tokens-selection.png) -1. アプリケーションが OAuth フローを使用してユーザを認可する場合、[**Request user authorization (OAuth) during installation**] を選択して、ユーザーかアプリをインストール時に認可するようにできます。 このオプションを選択した場合、[Setup URL] が利用できなくなり、アプリケーションのインストール後にユーザはあなたが設定した [User authorization callback URL] にリダイレクトされます。 詳しい情報については「[インストール中にユーザを認可する](/apps/installing-github-apps/#authorizing-users-during-installation)」を参照してください。 ![インストール時にユーザの認可を要求する](/assets/images/github-apps/github_apps_request_auth_upon_install.png) -1. インストール後に追加の設定が必要な場合、[Setup URL] を追加して、アプリケーションをインストールした後にユーザをリダイレクトします。 ![GitHub App のセットアップ URL フィールド ](/assets/images/github-apps/github_apps_setup_url.png) +1. By default, to improve your app's security, your app will use expiring user authorization tokens. To opt-out of using expiring user tokens, you must deselect "Expire user authorization tokens". To learn more about setting up a refresh token flow and the benefits of expiring user tokens, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)." + ![Option to opt-in to expiring user tokens during GitHub Apps setup](/assets/images/github-apps/expire-user-tokens-selection.png) +1. If your app authorizes users using the OAuth flow, you can select **Request user authorization (OAuth) during installation** to allow people to authorize the app when they install it, saving a step. If you select this option, the "Setup URL" becomes unavailable and users will be redirected to your "User authorization callback URL" after installing the app. See "[Authorizing users during installation](/apps/installing-github-apps/#authorizing-users-during-installation)" for more information. +![Request user authorization during installation](/assets/images/github-apps/github_apps_request_auth_upon_install.png) +1. If additional setup is required after installation, add a "Setup URL" to redirect users to after they install your app. +![Field for the setup URL of your GitHub App ](/assets/images/github-apps/github_apps_setup_url.png) {% note %} - **注釈:** 前のステップで [**Request user authorization (OAuth) during installation**] を選択した場合、このフィールドは利用できなくなり、アプリケーションのインストール後にユーザは [User authorization callback URL] にリダイレクトされます。 + **Note:** When you select **Request user authorization (OAuth) during installation** in the previous step, this field becomes unavailable and people will be redirected to the "User authorization callback URL" after installing the app. {% endnote %} -1. [Webhook URL] に、イベントが POST する URL を入力します。 各アプリケーションは、アプリケーションがインストールまたは変更されたり、アプリケーションがサブスクライブしているその他のイベントが発生したりするたびに、アプリケーションで設定した webhook を受信します。 ![GitHub App の webhook URL フィールド](/assets/images/github-apps/github_apps_webhook_url.png) +1. In "Webhook URL", type the URL that events will POST to. Each app receives its own webhook which will notify you every time the app is installed or modified, as well as any other events the app subscribes to. +![Field for the webhook URL of your GitHub App](/assets/images/github-apps/github_apps_webhook_url.png) -1. 必要に応じて、webhook を保護するための、オプションのシークレットトークンを [Webhook Secret] に入力します。 ![webhook にシークレットトークンを追加するフィールド](/assets/images/github-apps/github_apps_webhook_secret.png) +1. Optionally, in "Webhook Secret", type an optional secret token used to secure your webhooks. +![Field to add a secret token for your webhook](/assets/images/github-apps/github_apps_webhook_secret.png) {% note %} - **注釈:** シークレットトークンは、設定することを強くお勧めします。 詳しい情報については「[webhookをセキュアにする](/webhooks/securing/)」を参照してください。 + **Note:** We highly recommend that you set a secret token. For more information, see "[Securing your webhooks](/webhooks/securing/)." {% endnote %} -1. [Permissions] で、アプリケーションが要求する権限を選択します。 権限の各タイプで、ドロップダウンメニューを使用して [**Read-only**]、[**Read & write**]、または[**No access**] をクリックします。 ![GitHub App のさまざまな権限](/assets/images/github-apps/github_apps_new_permissions_post2dot13.png) -1. [Subscribe to events] で、アプリケーションが受け取るイベントを選択します。 -1. アプリケーションをインストールする場所を、[**Only on this account**] (このアカウントのみ) と [**Any account**] (すべてのアカウント) から選びます。 これらのオプションに関する詳しい情報については、「[GitHub App をパブリックまたはプライベートにする](/apps/managing-github-apps/making-a-github-app-public-or-private/)」を参照してください。 ![GitHub App のインストールオプション](/assets/images/github-apps/github_apps_installation_options.png) -1. [**Create GitHub App**] をクリックします。 ![GitHub App を作成するボタン](/assets/images/github-apps/github_apps_create_github_app.png) +1. In "Permissions", choose the permissions your app will request. For each type of permission, use the drop-down menu and click **Read-only**, **Read & write**, or **No access**. +![Various permissions for your GitHub App](/assets/images/github-apps/github_apps_new_permissions_post2dot13.png) +1. In "Subscribe to events", choose the events you want your app to receive. +1. To choose where the app can be installed, select either **Only on this account** or **Any account**. For more information on installation options, see "[Making a GitHub App public or private](/apps/managing-github-apps/making-a-github-app-public-or-private/)." +![Installation options for your GitHub App](/assets/images/github-apps/github_apps_installation_options.png) +1. Click **Create GitHub App**. +![Button to create your GitHub App](/assets/images/github-apps/github_apps_create_github_app.png) diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md b/translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md index 1ea8edbf72..f3dc98fd52 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md @@ -2,8 +2,8 @@ title: Identifying and authorizing users for GitHub Apps intro: '{% data reusables.shortdesc.identifying_and_authorizing_github_apps %}' redirect_from: - - /early-access/integrations/user-identification-authorization/ - - /apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps/ + - /early-access/integrations/user-identification-authorization + - /apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps - /apps/building-github-apps/identifying-and-authorizing-users-for-github-apps - /developers/apps/identifying-and-authorizing-users-for-github-apps versions: diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/index.md b/translations/ja-JP/content/developers/apps/building-github-apps/index.md index 8896961930..20e2cd4b16 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/index.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/index.md @@ -1,8 +1,8 @@ --- -title: GitHub App を構築する -intro: GitHub App を、あなた自身や他の人が使うために構築できます。 GitHub App の登録と、権限および認証オプションの設定方法について学びましょう。 +title: Building GitHub Apps +intro: You can build GitHub Apps for yourself or others to use. Learn how to register and set up permissions and authentication options for GitHub Apps. redirect_from: - - /apps/building-integrations/setting-up-and-registering-github-apps/ + - /apps/building-integrations/setting-up-and-registering-github-apps - /apps/building-github-apps versions: fpt: '*' diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index 53e44bac23..6027f1bb2b 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -1,10 +1,10 @@ --- -title: GitHub Appのレート制限 +title: Rate limits for GitHub Apps intro: '{% data reusables.shortdesc.rate_limits_github_apps %}' redirect_from: - - /early-access/integrations/rate-limits/ - - /apps/building-integrations/setting-up-and-registering-github-apps/about-rate-limits-for-github-apps/ - - /apps/building-github-apps/rate-limits-for-github-apps/ + - /early-access/integrations/rate-limits + - /apps/building-integrations/setting-up-and-registering-github-apps/about-rate-limits-for-github-apps + - /apps/building-github-apps/rate-limits-for-github-apps - /apps/building-github-apps/understanding-rate-limits-for-github-apps - /developers/apps/rate-limits-for-github-apps versions: @@ -14,16 +14,15 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: レート制限 +shortTitle: Rate limits --- - -## サーバーからサーバーへのリクエスト +## Server-to-server requests {% ifversion ghec %} The rate limits for server-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.product.product_location %}, then the rate is higher than for installations outside an enterprise. -### 通常のサーバーからサーバーへのレート制限 +### Normal server-to-server rate limits {% endif %} @@ -31,32 +30,32 @@ The rate limits for server-to-server requests made by {% data variables.product. {% ifversion ghec %} -### {% data variables.product.prodname_ghe_cloud %}のサーバーからサーバーへのレート制限 +### {% data variables.product.prodname_ghe_cloud %} server-to-server rate limits {% data variables.product.prodname_github_apps %} that are installed on an organization or repository owned by an enterprise on {% data variables.product.product_location %} have a rate limit of 15,000 requests per hour for server-to-server requests. {% endif %} -## ユーザからサーバーへのリクエスト +## User-to-server requests -{% data variables.product.prodname_github_apps %}[ユーザの代わりに](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-and-authorizing-users-for-github-apps)動作し、ユーザからサーバーへのリクエストを発行することができます。 +{% data variables.product.prodname_github_apps %} can also act [on behalf of a user](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-and-authorizing-users-for-github-apps), making user-to-server requests. {% ifversion ghec %} The rate limits for user-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.product.product_location %}, then the rate is higher than for installations outside an enterprise. -### 通常のユーザからサーバーへのレート制限 +### Normal user-to-server rate limits {% endif %} -User-to-server requests are rate limited at {% ifversion ghae %}15,000{% else %}5,000{% endif %} requests per hour and per authenticated user. ユーザが認可したすべてのOAuthアプリケーション、ユーザが所有する個人アクセストークン、ユーザの{% ifversion ghae %} トークン{% else %} ユーザ名およびパスワード{% endif %} で認証されたリクエストは、ユーザに対する1時間あたり5,000リクエストという割り当てを共有します。 +User-to-server requests are rate limited at {% ifversion ghae %}15,000{% else %}5,000{% endif %} requests per hour and per authenticated user. All OAuth applications authorized by that user, personal access tokens owned by that user, and requests authenticated with that user's{% ifversion ghae %} token{% else %} username and password{% endif %} share the same quota of 5,000 requests per hour for that user. {% ifversion ghec %} -### {% data variables.product.prodname_ghe_cloud %}のユーザからサーバーへのレート制限 +### {% data variables.product.prodname_ghe_cloud %} user-to-server rate limits When a user belongs to an enterprise on {% data variables.product.product_location %}, user-to-server requests to resources owned by the same enterprise are rate limited at 15,000 requests per hour and per authenticated user. All OAuth applications authorized by that user, personal access tokens owned by that user, and requests authenticated with that user's username and password share the same quota of 5,000 requests per hour for that user. {% endif %} -レート制限に関する詳細な情報については、REST APIについては「[レート制限](/rest/overview/resources-in-the-rest-api#rate-limiting)」を、GraphQL APIについては「[リソース制限]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations)」を参照してください。 +For more detailed information about rate limits, see "[Rate limiting](/rest/overview/resources-in-the-rest-api#rate-limiting)" for REST API and "[Resource limitations]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations)" for GraphQL API. diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md b/translations/ja-JP/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md index b5b91952a3..df3ebbe72d 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md @@ -1,9 +1,9 @@ --- -title: GitHub Appの権限の設定 +title: Setting permissions for GitHub Apps intro: '{% data reusables.shortdesc.permissions_github_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-github-apps/about-permissions-for-github-apps/ - - /apps/building-github-apps/permissions-for-github-apps/ + - /apps/building-integrations/setting-up-and-registering-github-apps/about-permissions-for-github-apps + - /apps/building-github-apps/permissions-for-github-apps - /apps/building-github-apps/setting-permissions-for-github-apps - /developers/apps/setting-permissions-for-github-apps versions: @@ -13,7 +13,6 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 権限の設定 +shortTitle: Set permissions --- - -GitHub Appは、デフォルトでは何の権限も持っていません。 GitHub Appを作成する際に、そのアプリケーションがエンドユーザのデータにアクセスするために必要な権限を選択できます。 権限は、追加することも削除することもできます。 詳しい情報については「[GitHub Appの権限の編集](/apps/managing-github-apps/editing-a-github-app-s-permissions/)」を参照してください。 +GitHub Apps don't have any permissions by default. When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)." diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md index fc5641bce7..d390f9c8e5 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md @@ -2,11 +2,11 @@ title: Authorizing OAuth Apps intro: '{% data reusables.shortdesc.authorizing_oauth_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps/ - - /apps/building-integrations/setting-up-and-registering-oauth-apps/directing-users-to-review-their-access/ - - /apps/building-integrations/setting-up-and-registering-oauth-apps/creating-multiple-tokens-for-oauth-apps/ - - /v3/oauth/ - - /apps/building-oauth-apps/authorization-options-for-oauth-apps/ + - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps + - /apps/building-integrations/setting-up-and-registering-oauth-apps/directing-users-to-review-their-access + - /apps/building-integrations/setting-up-and-registering-oauth-apps/creating-multiple-tokens-for-oauth-apps + - /v3/oauth + - /apps/building-oauth-apps/authorization-options-for-oauth-apps - /apps/building-oauth-apps/authorizing-oauth-apps - /developers/apps/authorizing-oauth-apps versions: diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md index 14a48db5c1..a080cbc4da 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md @@ -1,8 +1,8 @@ --- -title: OAuthアプリの作成 +title: Creating an OAuth App intro: '{% data reusables.shortdesc.creating_oauth_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps/ + - /apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps - /apps/building-oauth-apps/creating-an-oauth-app - /developers/apps/creating-an-oauth-app versions: @@ -13,11 +13,10 @@ versions: topics: - OAuth Apps --- - {% ifversion fpt or ghec %} {% note %} - **ノート：** {% data reusables.apps.maximum-oauth-apps-allowed %} + **Note:** {% data reusables.apps.maximum-oauth-apps-allowed %} {% endnote %} {% endif %} @@ -25,29 +24,35 @@ topics: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -4. [**New OAuth App**] をクリックします。 ![新しい OAuth App を作成するボタン](/assets/images/oauth-apps/oauth_apps_new_app.png) +4. Click **New OAuth App**. +![Button to create a new OAuth app](/assets/images/oauth-apps/oauth_apps_new_app.png) {% note %} - **注釈:** アプリをまだ作成したことがない場合、このボタンに [**Register a new application**] と表示されます。 + **Note:** If you haven't created an app before, this button will say, **Register a new application**. {% endnote %} -6. [Application name] に、アプリケーションの名前を入力します。 ![アプリケーションの名前フィールド](/assets/images/oauth-apps/oauth_apps_application_name.png) +6. In "Application name", type the name of your app. +![Field for the name of your app](/assets/images/oauth-apps/oauth_apps_application_name.png) {% warning %} - **警告:** 公にしてよいと思われる OAuth App の情報のみを使用します。 OAuth App を作成する場合、内部 URL などの機密データを使用することは避けてください。 + **Warning:** Only use information in your OAuth app that you consider public. Avoid using sensitive data, such as internal URLs, when creating an OAuth App. {% endwarning %} -7. [Homepage URL] に、アプリケーションのウェブサイトの完全な URL を入力します。 ![アプリケーションのホームページ URL フィールド](/assets/images/oauth-apps/oauth_apps_homepage_url.png) -8. 必要に応じて、ユーザーに表示されるアプリケーションの説明を [Application description] に入力します。 ![アプリケーションの説明フィールド](/assets/images/oauth-apps/oauth_apps_application_description.png) -9. [Authorization callback URL] に、アプリケーションのコールバック URL を入力します。 ![アプリケーションの認可コールバック URL フィールド](/assets/images/oauth-apps/oauth_apps_authorization_callback_url.png) +7. In "Homepage URL", type the full URL to your app's website. +![Field for the homepage URL of your app](/assets/images/oauth-apps/oauth_apps_homepage_url.png) +8. Optionally, in "Application description", type a description of your app that users will see. +![Field for a description of your app](/assets/images/oauth-apps/oauth_apps_application_description.png) +9. In "Authorization callback URL", type the callback URL of your app. +![Field for the authorization callback URL of your app](/assets/images/oauth-apps/oauth_apps_authorization_callback_url.png) {% ifversion fpt or ghes > 3.0 or ghec %} {% note %} - **注釈:** {% data variables.product.prodname_github_apps %} と異なり、OAuth App は複数のコールバック URL を持つことはできません。 + **Note:** OAuth Apps cannot have multiple callback URLs, unlike {% data variables.product.prodname_github_apps %}. {% endnote %} {% endif %} -10. **Register application** をクリックする。 ![アプリケーションを登録するボタン](/assets/images/oauth-apps/oauth_apps_register_application.png) +10. Click **Register application**. +![Button to register an application](/assets/images/oauth-apps/oauth_apps_register_application.png) diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/index.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/index.md index ffe30c016d..69a5c827a2 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/index.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/index.md @@ -1,8 +1,8 @@ --- -title: OAuth App を構築する -intro: OAuth Apps を、あなた自身や他の人が使うために構築できます。 OAuth App の登録と、権限および認可オプションの設定方法について学びましょう。 +title: Building OAuth Apps +intro: You can build OAuth Apps for yourself or others to use. Learn how to register and set up permissions and authorization options for OAuth Apps. redirect_from: - - /apps/building-integrations/setting-up-and-registering-oauth-apps/ + - /apps/building-integrations/setting-up-and-registering-oauth-apps - /apps/building-oauth-apps versions: fpt: '*' diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 3dc9de0fb9..bdf4b1997d 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -2,8 +2,8 @@ title: Scopes for OAuth Apps intro: '{% data reusables.shortdesc.understanding_scopes_for_oauth_apps %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/ - - /apps/building-oauth-apps/scopes-for-oauth-apps/ + - /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps + - /apps/building-oauth-apps/scopes-for-oauth-apps - /apps/building-oauth-apps/understanding-scopes-for-oauth-apps - /developers/apps/scopes-for-oauth-apps versions: diff --git a/translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md b/translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md index bcb5178dfb..d60e0d8400 100644 --- a/translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md +++ b/translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md @@ -2,9 +2,9 @@ title: About apps intro: 'You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs to add flexibility and reduce friction in your own workflow.{% ifversion fpt or ghec %} You can also share integrations with others on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).{% endif %}' redirect_from: - - /apps/building-integrations/setting-up-a-new-integration/ - - /apps/building-integrations/ - - /apps/getting-started-with-building-apps/ + - /apps/building-integrationssetting-up-a-new-integration + - /apps/building-integrations + - /apps/getting-started-with-building-apps - /apps/about-apps - /developers/apps/about-apps versions: diff --git a/translations/ja-JP/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md b/translations/ja-JP/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md index 3b4da45422..6e2ffa00ba 100644 --- a/translations/ja-JP/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md @@ -2,8 +2,8 @@ title: Differences between GitHub Apps and OAuth Apps intro: 'Understanding the differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} will help you decide which app you want to create. An {% data variables.product.prodname_oauth_app %} acts as a GitHub user, whereas a {% data variables.product.prodname_github_app %} uses its own identity when installed on an organization or on repositories within an organization.' redirect_from: - - /early-access/integrations/integrations-vs-oauth-applications/ - - /apps/building-integrations/setting-up-a-new-integration/about-choosing-an-integration-type/ + - /early-access/integrations/integrations-vs-oauth-applications + - /apps/building-integrations/setting-up-a-new-integration/about-choosing-an-integration-type - /apps/differences-between-apps - /developers/apps/differences-between-github-apps-and-oauth-apps versions: diff --git a/translations/ja-JP/content/developers/apps/guides/using-the-github-api-in-your-app.md b/translations/ja-JP/content/developers/apps/guides/using-the-github-api-in-your-app.md index f3f5a3bfe5..fa26be18c7 100644 --- a/translations/ja-JP/content/developers/apps/guides/using-the-github-api-in-your-app.md +++ b/translations/ja-JP/content/developers/apps/guides/using-the-github-api-in-your-app.md @@ -2,7 +2,7 @@ title: Using the GitHub API in your app intro: Learn how to set up your app to listen for events and use the Octokit library to perform REST API operations. redirect_from: - - /apps/building-your-first-github-app/ + - /apps/building-your-first-github-app - /apps/quickstart-guides/using-the-github-api-in-your-app - /developers/apps/using-the-github-api-in-your-app versions: diff --git a/translations/ja-JP/content/developers/apps/index.md b/translations/ja-JP/content/developers/apps/index.md index ea8b2fefb3..30fe7ff44f 100644 --- a/translations/ja-JP/content/developers/apps/index.md +++ b/translations/ja-JP/content/developers/apps/index.md @@ -1,12 +1,12 @@ --- -title: アプリ -intro: 独自のアプリケーションを構築して、ワークフローを自動化および効率化できます。 +title: Apps +intro: You can automate and streamline your workflow by building your own apps. redirect_from: - - /early-access/integrations/ - - /early-access/integrations/authentication/ - - /early-access/integrations/install-an-integration/ - - /apps/adding-integrations/ - - /apps/building-integrations/setting-up-a-new-integration/about-integrations/ + - /early-access/integrations + - /early-access/integrations/authentication + - /early-access/integrations/install-an-integration + - /apps/adding-integrations + - /apps/building-integrations/setting-up-a-new-integration/about-integrations - /apps - /v3/integrations versions: diff --git a/translations/ja-JP/content/developers/apps/managing-github-apps/deleting-a-github-app.md b/translations/ja-JP/content/developers/apps/managing-github-apps/deleting-a-github-app.md index e73a1f12ad..5c9cdb43cf 100644 --- a/translations/ja-JP/content/developers/apps/managing-github-apps/deleting-a-github-app.md +++ b/translations/ja-JP/content/developers/apps/managing-github-apps/deleting-a-github-app.md @@ -1,8 +1,8 @@ --- -title: GitHub App を削除する。 +title: Deleting a GitHub App intro: '{% data reusables.shortdesc.deleting_github_apps %}' redirect_from: - - /apps/building-integrations/managing-github-apps/deleting-a-github-app/ + - /apps/building-integrations/managing-github-apps/deleting-a-github-app - /apps/managing-github-apps/deleting-a-github-app - /developers/apps/deleting-a-github-app versions: @@ -13,12 +13,15 @@ versions: topics: - GitHub Apps --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -4. 削除する GitHub App を選択します。 ![アプリケーションの選択](/assets/images/github-apps/github_apps_select-app.png) +4. Select the GitHub App you want to delete. +![App selection](/assets/images/github-apps/github_apps_select-app.png) {% data reusables.user-settings.github_apps_advanced %} -6. [**Delete GitHub App**] をクリックします。 ![GitHub App を削除するボタン](/assets/images/github-apps/github_apps_delete.png) -7. 削除する GitHub App の名前を入力して、削除を確認します。 ![削除する GitHub App の名前を確認するフィールド](/assets/images/github-apps/github_apps_delete_integration_name.png) -8. [**I understand the consequences, delete this GitHub App**] をクリックします。 ![GitHub App の削除を確認するボタン](/assets/images/github-apps/github_apps_confirm_deletion.png) +6. Click **Delete GitHub App**. +![Button to delete a GitHub App](/assets/images/github-apps/github_apps_delete.png) +7. Type the name of the GitHub App to confirm you want to delete it. +![Field to confirm the name of the GitHub App you want to delete](/assets/images/github-apps/github_apps_delete_integration_name.png) +8. Click **I understand the consequences, delete this GitHub App**. +![Button to confirm the deletion of your GitHub App](/assets/images/github-apps/github_apps_confirm_deletion.png) diff --git a/translations/ja-JP/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md b/translations/ja-JP/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md index 0329103cbb..3d9e709d77 100644 --- a/translations/ja-JP/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md +++ b/translations/ja-JP/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md @@ -1,8 +1,8 @@ --- -title: GitHub App の権限を編集する +title: Editing a GitHub App's permissions intro: '{% data reusables.shortdesc.editing_permissions_for_github_apps %}' redirect_from: - - /apps/building-integrations/managing-github-apps/editing-a-github-app-s-permissions/ + - /apps/building-integrations/managing-github-apps/editing-a-github-app-s-permissions - /apps/managing-github-apps/editing-a-github-app-s-permissions - /developers/apps/editing-a-github-apps-permissions versions: @@ -12,21 +12,26 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 権限を編集する +shortTitle: Edit permissions --- - {% note %} -**注釈:** アカウントまたは Organization のオーナーが変更を承認するまで、更新した権限はインストールしたアプリケーションに反映されません。 [InstallationEvent webhook](/webhooks/event-payloads/#installation) を使用すると、ユーザがアプリケーションの新しい権限を受け入れた時に確認できます。 ただし[ユーザレベルの権限](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-level-permissions)は例外で、アカウントの所有者が変更を承認する必要はありません。 +**Note:** Updated permissions won't take effect on an installation until the owner of the account or organization approves the changes. You can use the [InstallationEvent webhook](/webhooks/event-payloads/#installation) to find out when people accept new permissions for your app. One exception is [user-level permissions](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-level-permissions), which don't require the account owner to approve permission changes. {% endnote %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -4. 権限を変更する GitHub App を選択します。 ![アプリケーションの選択](/assets/images/github-apps/github_apps_select-app.png) -5. 左サイドバーで、[**Permissions & webhooks**] をクリックします。 ![権限と webhook](/assets/images/github-apps/github_apps_permissions_and_webhooks.png) -6. 変更したい権限を修正します。 権限の各タイプで、ドロップダウンメニューから [Read-only]、[Read & write]、[No access] のいずれかを選択します。 ![GitHub App に対する権限の選択](/assets/images/github-apps/github_apps_permissions_post2dot13.png) -7. [Subscribe to events] で、アプリケーションがサブスクライブするイベントを選択します。 ![GitHub App がイベントにサブスクライブするための権限の選択](/assets/images/github-apps/github_apps_permissions_subscribe_to_events.png) -8. O必要に応じて、[Add a note to users] で注釈を追加し、GitHub App がリクエストする権限を変更する理由をユーザに伝えます。 ![GitHub App の権限を変更した理由をユーザに説明する注釈を追加するための入力ボックス](/assets/images/github-apps/github_apps_permissions_note_to_users.png) -9. [**Save changes**] をクリックします。 ![権限の変更を保存するボタン](/assets/images/github-apps/github_apps_save_changes.png) +4. Select the GitHub App whose permissions you want to change. +![App selection](/assets/images/github-apps/github_apps_select-app.png) +5. In the left sidebar, click **Permissions & webhooks**. +![Permissions and webhooks](/assets/images/github-apps/github_apps_permissions_and_webhooks.png) +6. Modify the permissions you'd like to change. For each type of permission, select either "Read-only", "Read & write", or "No access" from the dropdown. +![Permissions selections for your GitHub App](/assets/images/github-apps/github_apps_permissions_post2dot13.png) +7. In "Subscribe to events", select any events to which you'd like to subscribe your app. +![Permissions selections for subscribing your GitHub App to events](/assets/images/github-apps/github_apps_permissions_subscribe_to_events.png) +8. Optionally, in "Add a note to users", add a note telling your users why you are changing the permissions that your GitHub App requests. +![Input box to add a note to users explaining why your GitHub App permissions have changed](/assets/images/github-apps/github_apps_permissions_note_to_users.png) +9. Click **Save changes**. +![Button to save permissions changes](/assets/images/github-apps/github_apps_save_changes.png) diff --git a/translations/ja-JP/content/developers/apps/managing-github-apps/index.md b/translations/ja-JP/content/developers/apps/managing-github-apps/index.md index 4e11896537..718fa7bb8f 100644 --- a/translations/ja-JP/content/developers/apps/managing-github-apps/index.md +++ b/translations/ja-JP/content/developers/apps/managing-github-apps/index.md @@ -1,8 +1,8 @@ --- -title: GitHub Appの管理 -intro: GitHub Appを作成して登録した後、そのアプリケーションを変更したり、権限を変更したり、所有権を移譲したり、アプリケーションを削除したりできます。 +title: Managing GitHub Apps +intro: 'After you create and register a GitHub App, you can make modifications to the app, change permissions, transfer ownership, and delete the app.' redirect_from: - - /apps/building-integrations/managing-github-apps/ + - /apps/building-integrations/managing-github-apps - /apps/managing-github-apps versions: fpt: '*' diff --git a/translations/ja-JP/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md b/translations/ja-JP/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md index c8409c004a..2955f8e8c0 100644 --- a/translations/ja-JP/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md +++ b/translations/ja-JP/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md @@ -2,10 +2,10 @@ title: Making a GitHub App public or private intro: '{% data reusables.shortdesc.making-a-github-app-public-or-private %}' redirect_from: - - /apps/building-integrations/setting-up-and-registering-github-apps/about-installation-options-for-github-apps/ - - /apps/building-github-apps/installation-options-for-github-apps/ - - /apps/building-integrations/managing-github-apps/changing-a-github-app-s-installation-option/ - - /apps/managing-github-apps/changing-a-github-app-s-installation-option/ + - /apps/building-integrations/setting-up-and-registering-github-apps/about-installation-options-for-github-apps + - /apps/building-github-apps/installation-options-for-github-apps + - /apps/building-integrations/managing-github-apps/changing-a-github-app-s-installation-option + - /apps/managing-github-apps/changing-a-github-app-s-installation-option - /apps/managing-github-apps/making-a-github-app-public-or-private - /developers/apps/making-a-github-app-public-or-private versions: diff --git a/translations/ja-JP/content/developers/apps/managing-github-apps/modifying-a-github-app.md b/translations/ja-JP/content/developers/apps/managing-github-apps/modifying-a-github-app.md index ae8f0176c3..48fc1ccfb1 100644 --- a/translations/ja-JP/content/developers/apps/managing-github-apps/modifying-a-github-app.md +++ b/translations/ja-JP/content/developers/apps/managing-github-apps/modifying-a-github-app.md @@ -1,8 +1,8 @@ --- -title: GitHub Appの変更 +title: Modifying a GitHub App intro: '{% data reusables.shortdesc.modifying_github_apps %}' redirect_from: - - /apps/building-integrations/managing-github-apps/modifying-a-github-app/ + - /apps/building-integrations/managing-github-apps/modifying-a-github-app - /apps/managing-github-apps/modifying-a-github-app - /developers/apps/modifying-a-github-app versions: @@ -13,10 +13,11 @@ versions: topics: - GitHub Apps --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} {% data reusables.user-settings.modify_github_app %} -5. 「Basic information（基本情報）」で、修正したいGitHub Appの情報を変更してください。 ![GitHub Appの基本情報セクション](/assets/images/github-apps/github_apps_basic_information.png) -6. [**Save changes**] をクリックします。 ![GitHub Appの変更保存ボタン](/assets/images/github-apps/github_apps_save_changes.png) +5. In "Basic information", modify the GitHub App information that you'd like to change. +![Basic information section for your GitHub App](/assets/images/github-apps/github_apps_basic_information.png) +6. Click **Save changes**. +![Button to save changes for your GitHub App](/assets/images/github-apps/github_apps_save_changes.png) diff --git a/translations/ja-JP/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md b/translations/ja-JP/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md index 37dd1271b0..4bbe104d16 100644 --- a/translations/ja-JP/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md +++ b/translations/ja-JP/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md @@ -1,8 +1,8 @@ --- -title: GitHub Appの所有権を移譲する +title: Transferring ownership of a GitHub App intro: '{% data reusables.shortdesc.transferring_ownership_of_github_apps %}' redirect_from: - - /apps/building-integrations/managing-github-apps/transferring-ownership-of-a-github-app/ + - /apps/building-integrations/managing-github-apps/transferring-ownership-of-a-github-app - /apps/managing-github-apps/transferring-ownership-of-a-github-app - /developers/apps/transferring-ownership-of-a-github-app versions: @@ -12,15 +12,19 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 所有権の移譲 +shortTitle: Transfer ownership --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -4. 所有権を移譲するGitHub Appを選択します。 ![アプリケーションの選択](/assets/images/github-apps/github_apps_select-app.png) +4. Select the GitHub App whose ownership you want to transfer. +![App selection](/assets/images/github-apps/github_apps_select-app.png) {% data reusables.user-settings.github_apps_advanced %} -6. [**Transfer ownership**]をクリックします。 ![所有権を移譲するボタン](/assets/images/github-apps/github_apps_transfer_ownership.png) -7. 移譲するGitHub Appの名前を入力します。 ![移譲するアプリケーションの名前を入力するフィールド](/assets/images/github-apps/github_apps_transfer_app_name.png) -8. GitHub Appの移譲先のユーザまたはOrganizationの名前を入力します。 ![移譲先のユーザまたはOrganizationの名前を入力するフィールド](/assets/images/github-apps/github_apps_transfer_new_owner.png) -9. [**Transfer this GitHub App**]をクリックします。 ![GitHub Appの移譲を確認するボタン](/assets/images/github-apps/github_apps_transfer_integration.png) +6. Click **Transfer ownership**. +![Button to transfer ownership](/assets/images/github-apps/github_apps_transfer_ownership.png) +7. Type the name of the GitHub App you want to transfer. +![Field to enter the name of the app to transfer](/assets/images/github-apps/github_apps_transfer_app_name.png) +8. Type the name of the user or organization you want to transfer the GitHub App to. +![Field to enter the user or org to transfer to](/assets/images/github-apps/github_apps_transfer_new_owner.png) +9. Click **Transfer this GitHub App**. +![Button to confirm the transfer of a GitHub App](/assets/images/github-apps/github_apps_transfer_integration.png) diff --git a/translations/ja-JP/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md b/translations/ja-JP/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md index ef365a60b3..26affcb17f 100644 --- a/translations/ja-JP/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md +++ b/translations/ja-JP/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md @@ -1,8 +1,8 @@ --- -title: OAuth App を削除する +title: Deleting an OAuth App intro: '{% data reusables.shortdesc.deleting_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/deleting-an-oauth-app/ + - /apps/building-integrations/managing-oauth-apps/deleting-an-oauth-app - /apps/managing-oauth-apps/deleting-an-oauth-app - /developers/apps/deleting-an-oauth-app versions: @@ -13,10 +13,12 @@ versions: topics: - OAuth Apps --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -4. 変更する {% data variables.product.prodname_oauth_app %} を選択します。 ![アプリケーションの選択](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png) -5. [**Delete application**] をクリックします。 ![アプリケーションを削除するボタン](/assets/images/oauth-apps/oauth_apps_delete_application.png) -6. [**Delete this OAuth Application**] をクリックします。 ![削除を確認するボタン](/assets/images/oauth-apps/oauth_apps_delete_confirm.png) +4. Select the {% data variables.product.prodname_oauth_app %} you want to modify. +![App selection](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png) +5. Click **Delete application**. +![Button to delete the application](/assets/images/oauth-apps/oauth_apps_delete_application.png) +6. Click **Delete this OAuth Application**. +![Button to confirm the deletion](/assets/images/oauth-apps/oauth_apps_delete_confirm.png) diff --git a/translations/ja-JP/content/developers/apps/managing-oauth-apps/index.md b/translations/ja-JP/content/developers/apps/managing-oauth-apps/index.md index ced5d77d0a..5a40c83444 100644 --- a/translations/ja-JP/content/developers/apps/managing-oauth-apps/index.md +++ b/translations/ja-JP/content/developers/apps/managing-oauth-apps/index.md @@ -1,8 +1,8 @@ --- -title: OAuth Appの管理 -intro: OAuth Appを作成して登録した後、そのアプリケーションを変更したり、権限を変更したり、所有権を移譲したり、アプリケーションを削除したりできます。 +title: Managing OAuth Apps +intro: 'After you create and register an OAuth App, you can make modifications to the app, change permissions, transfer ownership, and delete the app.' redirect_from: - - /apps/building-integrations/managing-oauth-apps/ + - /apps/building-integrations/managing-oauth-apps - /apps/managing-oauth-apps versions: fpt: '*' diff --git a/translations/ja-JP/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md b/translations/ja-JP/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md index dd1e8eb75a..c6196ae921 100644 --- a/translations/ja-JP/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md +++ b/translations/ja-JP/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md @@ -1,8 +1,8 @@ --- -title: OAuth Appの変更 +title: Modifying an OAuth App intro: '{% data reusables.shortdesc.modifying_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/modifying-an-oauth-app/ + - /apps/building-integrations/managing-oauth-apps/modifying-an-oauth-app - /apps/managing-oauth-apps/modifying-an-oauth-app - /developers/apps/modifying-an-oauth-app versions: @@ -13,10 +13,9 @@ versions: topics: - OAuth Apps --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} {% data reusables.user-settings.modify_oauth_app %} -1. 修正したい{% data variables.product.prodname_oauth_app %}の情報を変更してください。 +1. Modify the {% data variables.product.prodname_oauth_app %} information that you'd like to change. {% data reusables.user-settings.update_oauth_app %} diff --git a/translations/ja-JP/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md b/translations/ja-JP/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md index 4a74d1dd46..975ec5bafb 100644 --- a/translations/ja-JP/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md +++ b/translations/ja-JP/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md @@ -1,8 +1,8 @@ --- -title: OAuth App の所有権を移譲する +title: Transferring ownership of an OAuth App intro: '{% data reusables.shortdesc.transferring_ownership_of_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/transferring-ownership-of-an-oauth-app/ + - /apps/building-integrations/managing-oauth-apps/transferring-ownership-of-an-oauth-app - /apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app - /developers/apps/transferring-ownership-of-an-oauth-app versions: @@ -12,14 +12,18 @@ versions: ghec: '*' topics: - OAuth Apps -shortTitle: 所有権の移譲 +shortTitle: Transfer ownership --- - {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -4. 変更する {% data variables.product.prodname_oauth_app %} を選択します。 ![アプリケーションの選択](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png) -5. [**Transfer ownership**]をクリックします。 ![所有権を移譲するボタン](/assets/images/oauth-apps/oauth_apps_transfer_ownership.png) -6. 移譲する {% data variables.product.prodname_oauth_app %} の名前を入力します。 ![移譲するアプリケーションの名前を入力するフィールド](/assets/images/oauth-apps/oauth_apps_transfer_oauth_name.png) -7. {% data variables.product.prodname_oauth_app %} を移譲するユーザまたは Organization の名前を入力します。 ![移譲先のユーザまたはOrganizationの名前を入力するフィールド](/assets/images/oauth-apps/oauth_apps_transfer_new_owner.png) -8. [**Transfer this application**] をクリックします。 ![アプリケーションを移譲するボタン](/assets/images/oauth-apps/oauth_apps_transfer_application.png) +4. Select the {% data variables.product.prodname_oauth_app %} you want to modify. +![App selection](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png) +5. Click **Transfer ownership**. +![Button to transfer ownership](/assets/images/oauth-apps/oauth_apps_transfer_ownership.png) +6. Type the name of the {% data variables.product.prodname_oauth_app %} you want to transfer. +![Field to enter the name of the app to transfer](/assets/images/oauth-apps/oauth_apps_transfer_oauth_name.png) +7. Type the name of the user or organization you want to transfer the {% data variables.product.prodname_oauth_app %} to. +![Field to enter the user or org to transfer to](/assets/images/oauth-apps/oauth_apps_transfer_new_owner.png) +8. Click **Transfer this application**. +![Button to transfer the application](/assets/images/oauth-apps/oauth_apps_transfer_application.png) diff --git a/translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md b/translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md index ad10ee73b2..ce44a8e347 100644 --- a/translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md +++ b/translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md @@ -1,8 +1,8 @@ --- -title: 認可リクエストエラーのトラブルシューティング +title: Troubleshooting authorization request errors intro: '{% data reusables.shortdesc.troubleshooting_authorization_request_errors_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/troubleshooting-authorization-request-errors/ + - /apps/building-integrations/managing-oauth-apps/troubleshooting-authorization-request-errors - /apps/managing-oauth-apps/troubleshooting-authorization-request-errors - /developers/apps/troubleshooting-authorization-request-errors versions: @@ -12,38 +12,42 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 認可のトラブルシューティング +shortTitle: Troubleshoot authorization --- +## Application suspended -## アプリケーションのサスペンド - -設定した OAuth Appが (不正利用の報告、スパム、APIの誤用により) サスペンドされた場合、GitHubは以下のパラメータを使用して、エラーを手短に説明する、登録されたコールバックURLにリダイレクトします。 +If the OAuth App you set up has been suspended (due to reported abuse, spam, or a mis-use of the API), GitHub will redirect to the registered callback URL using the following parameters to summarize the error: http://your-application.com/callback?error=application_suspended &error_description=Your+application+has+been+suspended.+Contact+support@github.com. &error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23application-suspended &state=xyz -サスペンドされたアプリケーションに関する問題を解決するには、{% data variables.contact.contact_support %} までご連絡ください。 +To solve issues with suspended applications, please contact {% data variables.contact.contact_support %}. -## リダイレクトURIの不一致 +## Redirect URI mismatch -指定した`redirect_uri`がアプリケーションで登録したものと一致しない場合、GitHubは以下のパラメータを使用して、エラーを手短に説明する、登録されたコールバックURLにリダイレクトします。 +If you provide a `redirect_uri` that doesn't match what you've registered with your application, GitHub will redirect to the registered callback URL with the following parameters summarizing the error: http://your-application.com/callback?error=redirect_uri_mismatch &error_description=The+redirect_uri+MUST+match+the+registered+callback+URL+for+this+application. &error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23redirect-uri-mismatch &state=xyz -このエラーを修正するには、登録したものと一致する`redirect_uri`を指定するか、アプリケーションで登録されているデフォルトのURIを使用するためパラメータを省略します。 +To correct this error, either provide a `redirect_uri` that matches what you registered or leave out this parameter to use the default one registered with your application. -### アクセス拒否 +### Access denied -If the ユーザがアプリケーションへのアクセスを拒否している場合、GitHubは以下のパラメータを使用して、エラーを手短に説明する、登録されたコールバックURLにリダイレクトします。 +If the user rejects access to your application, GitHub will redirect to +the registered callback URL with the following parameters summarizing +the error: http://your-application.com/callback?error=access_denied &error_description=The+user+has+denied+your+application+access. &error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23access-denied &state=xyz -このような場合、あなたにできることは何もありません。ユーザには、あなたのアプリケーションを使用しない自由があります。 ユーザはウインドウを閉じるかブラウザで戻ることが多いため、このエラーをあなたが見ることはないかもしれません。 +There's nothing you can do here as users are free to choose not to use +your application. More often than not, users will just close the window +or press back in their browser, so it is likely that you'll never see +this error. diff --git a/translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md b/translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md index 7f830dcfe5..5dc9f10a8b 100644 --- a/translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md +++ b/translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md @@ -1,8 +1,8 @@ --- -title: OAuth Appアクセストークンのリクエストエラーのトラブルシューティング +title: Troubleshooting OAuth App access token request errors intro: '{% data reusables.shortdesc.troubleshooting_access_token_reques_errors_oauth_apps %}' redirect_from: - - /apps/building-integrations/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors/ + - /apps/building-integrations/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors - /apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors - /developers/apps/troubleshooting-oauth-app-access-token-request-errors versions: @@ -12,18 +12,18 @@ versions: ghec: '*' topics: - OAuth Apps -shortTitle: トークンリクエストのトラブルシューティング +shortTitle: Troubleshoot token request --- - {% note %} -**注釈:** この例ではJSONのレスポンスのみ示しています。 +**Note:** These examples only show JSON responses. {% endnote %} -## 不正なクライアント認識情報 +## Incorrect client credentials -渡した client\_id や client\_secret が正しくない場合は、以下のエラーレスポンスを受け取ります。 +If the client\_id and or client\_secret you pass are incorrect you will +receive this error response. ```json { @@ -33,11 +33,12 @@ shortTitle: トークンリクエストのトラブルシューティング } ``` -このエラーを解決するには、{% data variables.product.prodname_oauth_app %} の正しい認証情報を持っているかを確認します。 `client_id` と `client_secret` が間違っていないか、また {% data variables.product.product_name %} に正しく渡されているかを再確認してください。 +To solve this error, make sure you have the correct credentials for your {% data variables.product.prodname_oauth_app %}. Double check the `client_id` and `client_secret` to make sure they are correct and being passed correctly +to {% data variables.product.product_name %}. -## リダイレクトURIの不一致 +## Redirect URI mismatch -指定した `redirect_uri` が {% data variables.product.prodname_oauth_app %} で登録したものと一致しない場合、次のエラーメッセージが表示されます。 +If you provide a `redirect_uri` that doesn't match what you've registered with your {% data variables.product.prodname_oauth_app %}, you'll receive this error message: ```json { @@ -47,9 +48,11 @@ shortTitle: トークンリクエストのトラブルシューティング } ``` -このエラーを修正するには、登録したものと一致する`redirect_uri`を指定するか、アプリケーションで登録されているデフォルトのURIを使用するためパラメータを省略します。 +To correct this error, either provide a `redirect_uri` that matches what +you registered or leave out this parameter to use the default one +registered with your application. -## 不正な検証コード +## Bad verification code ```json { @@ -60,7 +63,9 @@ shortTitle: トークンリクエストのトラブルシューティング } ``` -渡した検証コードが間違っている、有効期限切れ、または最初の認可リクエストで受け取ったものと一致しない場合、このエラーを受信します。 +If the verification code you pass is incorrect, expired, or doesn't +match what you received in the first request for authorization you will +receive this error. ```json { @@ -70,4 +75,5 @@ shortTitle: トークンリクエストのトラブルシューティング } ``` -この問題を解決するには、[OAuth Appの認可](/apps/building-oauth-apps/authorizing-oauth-apps/)のプロセスを再び開始し、新しいコードを取得します。 +To solve this error, start the [OAuth authorization process again](/apps/building-oauth-apps/authorizing-oauth-apps/) +and get a new code. diff --git a/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md b/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md index 84c7e435a1..4a6292a7c8 100644 --- a/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md +++ b/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md @@ -1,12 +1,12 @@ --- -title: アプリケーションのリストのための要件 -intro: '{% data variables.product.prodname_marketplace %}上のアプリケーションは、リストを公開する前にこのページに概要がある要件を満たさなければなりません。' +title: Requirements for listing an app +intro: 'Apps on {% data variables.product.prodname_marketplace %} must meet the requirements outlined on this page before the listing can be published.' redirect_from: - - /apps/adding-integrations/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace/ - - /apps/marketplace/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace/ - - /apps/marketplace/getting-started-with-github-marketplace-listings/requirements-for-listing-an-app-on-github-marketplace/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/requirements-for-listing-an-app-on-github-marketplace/ - - /apps/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/ + - /apps/adding-integrations/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace + - /apps/marketplace/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace + - /apps/marketplace/getting-started-with-github-marketplace-listings/requirements-for-listing-an-app-on-github-marketplace + - /apps/marketplace/creating-and-submitting-your-app-for-approval/requirements-for-listing-an-app-on-github-marketplace + - /apps/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace - /marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace - /developers/github-marketplace/requirements-for-listing-an-app versions: @@ -14,68 +14,67 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: リストの要件 +shortTitle: Listing requirements --- - -{% data variables.product.prodname_marketplace %}上にアプリケーションをリストするための要件は、提供するのが無料なのか有料アプリケーションなのかによって変わります。 +The requirements for listing an app on {% data variables.product.prodname_marketplace %} vary according to whether you want to offer a free or a paid app. -## すべての{% data variables.product.prodname_marketplace %}リストの要件 +## Requirements for all {% data variables.product.prodname_marketplace %} listings -{% data variables.product.prodname_marketplace %}上のすべてのリストは、{% data variables.product.product_name %}コミュニティに価値を提供するツールのためのものでなければなりません。 公開のためにリストをサブミットする際には、[{% data variables.product.prodname_marketplace %}開発者契約](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)の条項を読んで同意しなければなりません。 +All listings on {% data variables.product.prodname_marketplace %} should be for tools that provide value to the {% data variables.product.product_name %} community. When you submit your listing for publication, you must read and accept the terms of the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)." -### すべてのアプリケーションに対するユーザ体験の要件 +### User experience requirements for all apps -すべてのリストは、無料のアプリケーションのためのものか、有料アプリケーションのためのものであるかにかかわらず、以下の要件を満たさなければなりません。 +All listings should meet the following requirements, regardless of whether they are for a free or paid app. -- リストはユーザを積極的に{% data variables.product.product_name %}から離れさせようとしてはなりません。 -- リストは、パブリッシャーの有効な連絡先の情報を含んでいなければなりません。 -- リストには、アプリケーションの適切な説明がなければなりません。 -- リストは価格プランを指定しなければなりません。 -- アプリケーションは顧客に価値を提供し、認証以外の方法でプラットフォームと統合されていなければなりません -- アプリケーションケーションは{% data variables.product.prodname_marketplace %}で公開されなければならず、ベータや招待のみでの利用であってはなりません。 -- アプリケーションは、{% data variables.product.prodname_marketplace %} APIを使ってプランの変更やキャンセルがあったことをパブリッシャーに知らせるために、webhookイベントがセットアップされていなければなりません。 詳しい情報については「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。 +- Listings must not actively persuade users away from {% data variables.product.product_name %}. +- Listings must include valid contact information for the publisher. +- Listings must have a relevant description of the application. +- Listings must specify a pricing plan. +- Apps must provide value to customers and integrate with the platform in some way beyond authentication. +- Apps must be publicly available in {% data variables.product.prodname_marketplace %} and cannot be in beta or available by invite only. +- Apps must have webhook events set up to notify the publisher of any plan changes or cancellations using the {% data variables.product.prodname_marketplace %} API. For more information, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -優れた顧客体験を提供することに関する詳細な情報については、「[アプリケーションの顧客体験のベストプラクティス](/developers/github-marketplace/customer-experience-best-practices-for-apps)」を参照してください。 +For more information on providing a good customer experience, see "[Customer experience best practices for apps](/developers/github-marketplace/customer-experience-best-practices-for-apps)." -### すべてのアプリケーションに対するブランドとリストの要件 +### Brand and listing requirements for all apps -- GitHubのログを使用するアプリケーションは、{% data variables.product.company_short %}ガイドラインに従わなければなりません。 詳しい情報については「[{% data variables.product.company_short %}ロゴと利用](https://github.com/logos)」を参照してください。 -- アプリケーションは、「[{% data variables.product.prodname_marketplace %}リストの説明の作成](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)」にある推奨事項を満たすロゴ、機能カード、スクリーンショット画像を持っていなければなりません。 -- リストには、十分に書かれた文法上の誤りがない説明が含まれていなければなりません。 リストの作成のガイダンスとしては、「[{% data variables.product.prodname_marketplace %}リストの説明の作成](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)」を参照してください。 +- Apps that use GitHub logos must follow the {% data variables.product.company_short %} guidelines. For more information, see "[{% data variables.product.company_short %} Logos and Usage](https://github.com/logos)." +- Apps must have a logo, feature card, and screenshots images that meet the recommendations provided in "[Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)." +- Listings must include descriptions that are well written and free of grammatical errors. For guidance in writing your listing, see "[Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)." -顧客を保護するために、セキュリティのベストプラクティスにも従うことをおすすめします。 詳しい情報については「[アプリケーションのセキュリティのベストプラクティス](/developers/github-marketplace/security-best-practices-for-apps)」を参照してください。 +To protect your customers, we recommend that you also follow security best practices. For more information, see "[Security best practices for apps](/developers/github-marketplace/security-best-practices-for-apps)." -## 無料アプリケーションに関する留意点 +## Considerations for free apps -{% data reusables.marketplace.free-apps-encouraged %} +{% data reusables.marketplace.free-apps-encouraged %} -## 有料アプリケーションの要件 +## Requirements for paid apps -{% data variables.product.prodname_marketplace %}でアプリケーションの有料プランを公開するには、そのアプリケーションが検証済みパブリッシャーであるOrganizationの所有である必要があります。 検証プロセスやアプリケーションの所有権移譲の詳細については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」を参照してください。 +To publish a paid plan for your app on {% data variables.product.prodname_marketplace %}, your app must be owned by an organization that is a verified publisher. For more information about the verification process or transferring ownership of your app, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." -アプリケーションが既に公開されており、あなたが検証済みパブリッシャーである場合は、価格プランエディタから新しく有料プランを公開できます。 詳しい情報については、「[リストに対する価格プランの設定](/developers/github-marketplace/setting-pricing-plans-for-your-listing)」を参照してください。 +If your app is already published and you're a verified publisher, then you can publish a new paid plan from the pricing plan editor. For more information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)." -有料アプリケーション (または有料プランを提供するアプリケーション) を公開するには、以下の要件も満たす必要があります。 +To publish a paid app (or an app that offers a paid plan), you must also meet the following requirements: -- {% data variables.product.prodname_github_apps %}は最低100件のインストールが必要です。 -- {% data variables.product.prodname_oauth_apps %}は最低200ユーザが必要です。 -- すべての有料アプリケーションは、新規購入、アップグレード、ダウングレード、キャンセル、無料トライアルの{% data variables.product.prodname_marketplace %}購入イベントを処理できなければなりません。 詳しい情報については、以下の「[有料アプリケーションの支払い要件](#billing-requirements-for-paid-apps)」を参照してください。 +- {% data variables.product.prodname_github_apps %} should have a minimum of 100 installations. +- {% data variables.product.prodname_oauth_apps %} should have a minimum of 200 users. +- All paid apps must handle {% data variables.product.prodname_marketplace %} purchase events for new purchases, upgrades, downgrades, cancellations, and free trials. For more information, see "[Billing requirements for paid apps](#billing-requirements-for-paid-apps)" below. -アプリケーションを{% data variables.product.prodname_marketplace %}上で公開する準備ができたら、アプリケーション掲載のために検証をリクエストする必要があります。 +When you are ready to publish the app on {% data variables.product.prodname_marketplace %} you must request verification for the app listing. {% note %} -**注釈:** {% data reusables.marketplace.app-transfer-to-org-for-verification %}アプリケーションをOrganizationに移譲する方法については、[公開のためのリストのサブミット](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)」を参照してください。 +**Note:** {% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to transfer an app to an organization, see: "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)." {% endnote %} -## 有料アプリケーションの支払い要件 +## Billing requirements for paid apps -アプリケーションは支払いを処理する必要はありませんが、{% data variables.product.prodname_marketplace %}購入イベントを使って新規の購入、アップグレード、ダウングレード、キャンセル、無料トライアルを管理できなければなりません。 これらのイベントをアプリケーションに統合する方法については、「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。 +Your app does not need to handle payments but does need to use {% data variables.product.prodname_marketplace %} purchase events to manage new purchases, upgrades, downgrades, cancellations, and free trials. For information about how integrate these events into your app, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -GitHubの支払いAPIを使えば、顧客はGitHubを離れることなくアプリケーションを購入し、自分の{% data variables.product.product_location %}のアカウントにすでに結合されている支払い方法でサービスに対する支払いを行えます。 +Using GitHub's billing API allows customers to purchase an app without leaving GitHub and to pay for the service with the payment method already attached to their account on {% data variables.product.product_location %}. -- アプリケーションは、有料のサブスクリプションの購入について、月次及び年次の支払いをサポートしなければなりません。 -- リストは、無料及び有料プランの任意の組み合わせを提供できます。 無料プランはオプションですが、推奨されます。 詳しい情報については「[{% data variables.product.prodname_marketplace %}リストの価格プランの設定](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)」を参照してください。 +- Apps must support both monthly and annual billing for paid subscriptions purchases. +- Listings may offer any combination of free and paid plans. Free plans are optional but encouraged. For more information, see "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)." diff --git a/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md b/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md index 1089f8cbb7..edf1015910 100644 --- a/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md +++ b/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md @@ -1,63 +1,63 @@ --- -title: アプリケーションのセキュリティベストプラクティス -intro: '{% data variables.product.prodname_marketplace %}上でセキュアなアプリケーションを共有する準備のガイドライン' +title: Security best practices for apps +intro: 'Guidelines for preparing a secure app to share on {% data variables.product.prodname_marketplace %}.' redirect_from: - - /apps/marketplace/getting-started/security-review-process/ + - /apps/marketplace/getting-started/security-review-process - /marketplace/getting-started/security-review-process - /developers/github-marketplace/security-review-process-for-submitted-apps - /developers/github-marketplace/security-best-practices-for-apps -shortTitle: セキュリティベストプラクティス +shortTitle: Security best practice versions: fpt: '*' ghec: '*' topics: - Marketplace --- +If you follow these best practices it will help you to provide a secure user experience. -以下のベストプラクティスに従えば、セキュアなユーザ体験を提供するための役に立つでしょう。 +## Authorization, authentication, and access control -## 認可、認証、アクセスコントロール +We recommend creating a GitHub App rather than an OAuth App. {% data reusables.marketplace.github_apps_preferred %}. See "[Differences between GitHub Apps and OAuth Apps](/apps/differences-between-apps/)" for more details. +- Apps should use the principle of least privilege and should only request the OAuth scopes and GitHub App permissions that the app needs to perform its intended functionality. For more information, see [Principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege) in Wikipedia. +- Apps should provide customers with a way to delete their account, without having to email or call a support person. +- Apps should not share tokens between different implementations of the app. For example, a desktop app should have a separate token from a web-based app. Individual tokens allow each app to request the access needed for GitHub resources separately. +- Design your app with different user roles, depending on the functionality needed by each type of user. For example, a standard user should not have access to admin functionality, and billing managers might not need push access to repository code. +- Apps should not share service accounts such as email or database services to manage your SaaS service. +- All services used in your app should have unique login and password credentials. +- Admin privilege access to the production hosting infrastructure should only be given to engineers and employees with administrative duties. +- Apps should not use personal access tokens to authenticate and should authenticate as an [OAuth App](/apps/about-apps/#about-oauth-apps) or a [GitHub App](/apps/about-apps/#about-github-apps): + - OAuth Apps should authenticate using an [OAuth token](/apps/building-oauth-apps/authorizing-oauth-apps/). + - GitHub Apps should authenticate using either a [JSON Web Token (JWT)](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app), [OAuth token](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/), or [installation access token](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation). -OAuth AppよりもGitHub Appを作成することをおすすめします。 {% data reusables.marketplace.github_apps_preferred %}. 詳細については、「[GitHub AppsとOAuth Appsの違い](/apps/differences-between-apps/)」を参照してください。 -- アプリケーションは、最小権限の原則を用い、アプリケーションが意図された機能を実行するために必要なOAuthのスコープとGitHub Appの権限だけをリクエストすべきです。 詳しい情報については、Wikipediaで[最小権限の原則](https://ja.wikipedia.org/wiki/最小権限の原則)を参照してください。 -- アプリケーションは、サポート担当者にメールや連絡をすることなく、顧客が自分のアカウントを削除する方法を提供しなければなりません。 -- アプリケーションは、異なる実装間でトークンを共有してはなりません。 たとえば、デスクトップのアプリケーションはWebベースのアプリケーションとは別のトークンを持つべきです。 個々のトークンを使うことで、それぞれのアプリケーションはGitHubのリソースに必要なアクセスを個別にリクエストできます。 -- ユーザの種類に応じて求められる機能によって、様々なユーザのロールを持たせてアプリケーションを設計してください。 たとえば、標準的なユーザは管理機能を利用できるべきではなく、支払いマネージャーはリポジトリのコードにプッシュアクセスできるべきではありません。 -- アプリケーションは、SaaSサービスを管理するためのメールやデータベースサービスのようなサービスアカウントを共有するべきではありません。 -- アプリケーションで使用されるすべてのサービスは、固有のログインとパスワードクレデンシャルを持たなければなりません。 -- プロダクションのホスティングインフラストラクチャへの管理権限でのアクセスは、管理業務を持つエンジニアや従業員にのみ与えられるべきです。 -- アプリケーションは、認証に個人アクセストークンを使うべきではなく、[OAuth App](/apps/about-apps/#about-oauth-apps)あるいは[GitHub App](/apps/about-apps/#about-github-apps)として認証されなければなりません。 - - OAuth Appsは、[OAuthトークン](/apps/building-oauth-apps/authorizing-oauth-apps/)を使って認証を受けるべきです。 - - GitHub Appは、[JSON Webトークン (JWT)](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)、[OAuthトークン](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)、[インストールアクセストークン](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)のいずれかで認証を受けるべきです。 +## Data protection -## データの保護 +- Apps should encrypt data transferred over the public internet using HTTPS, with a valid TLS certificate, or SSH for Git. +- Apps should store client ID and client secret keys securely. We recommend storing them as [environmental variables](http://en.wikipedia.org/wiki/Environment_variable#Getting_and_setting_environment_variables). +- Apps should delete all GitHub user data within 30 days of receiving a request from the user, or within 30 days of the end of the user's legal relationship with GitHub. +- Apps should not require the user to provide their GitHub password. +- Apps should encrypt tokens, client IDs, and client secrets. -- アプリケーションは、パブリックなインターネット上で転送されるデータを、有効なTLS証明書を用いたHTTPSもしくはSSH for Gitで暗号化すべきです。 -- アプリケーションは、クライアントIDとクライアントシークレットキーをセキュアに保存すべきです。 それらは[環境変数](http://en.wikipedia.org/wiki/Environment_variable#Getting_and_setting_environment_variables)に保存することをおすすめします。 -- アプリケーションは、ユーザからの要求を受けてから30日以内、あるいはユーザのGitHubとの法的な関係が終了してから30日以内に、すべてのGitHubユーザデータを削除すべきです。 -- アプリケーションは、ユーザにGitHubパスワードの提供を求めるべきではありません。 -- アプリケーションは、トークン、クライアントID、クライアントシークレットを暗号化すべきです。 +## Logging and monitoring -## ロギング及びモニタリング +Apps should have logging and monitoring capabilities. App logs should be retained for at least 30 days and archived for at least one year. +A security log should include: -アプリケーションは、ロギング及びモニタリングの機能を持つべきです。 アプリケーションのログは最低でも30日間保存され、最低でも1年間アーカイブされるべきです。 セキュリティログは以下を含まなければなりません。 +- Authentication and authorization events +- Service configuration changes +- Object reads and writes +- All user and group permission changes +- Elevation of role to admin +- Consistent timestamping for each event +- Source users, IP addresses, and/or hostnames for all logged actions -- 認証及び認可イベント -- サービス設定の変更 -- オブジェクトの読み書き -- すべてのユーザ及びグループの権限変更 -- ロールの管理者への昇格 -- 各イベントに対する一貫したタイムスタンプ -- 記録されたすべてのアクションのソースユーザ、IPアドレス及びホスト名 +## Incident response workflow -## インシデントレスポンスのワークフロー +To provide a secure experience for users, you should have a clear incident response plan in place before listing your app. We recommend having a security and operations incident response team in your company rather than using a third-party vendor. You should have the capability to notify {% data variables.product.product_name %} within 24 hours of a confirmed incident. -ユーザのセキュアな体験を提供するためには、アプリケーションをリストする前に明確なインシデントレスポンスプランを用意しておくべきです。 サードパーティのベンダを利用するよりは、自社内にセキュリティ及び運用インシデントレスポンスチームを持つことをおすすめします。 インシデントの確認から24時間以内に{% data variables.product.product_name %}に通知する機能を持っていなければなりません。 +For an example of an incident response workflow, see the "Data Breach Response Policy" on the [SANS Institute website](https://www.sans.org/information-security-policy/). A short document with clear steps to take in the event of an incident is more valuable than a lengthy policy template. -インシデントレスポンスのワークフローの例としては、[SANS Institute website](https://www.sans.org/information-security-policy/)の"Data Breach Response Policy"を参照してください。 インシデントが生じた際に取るべき明確なステップを記した短いドキュメントは、長いポリシーテンプレートよりも価値があります。 +## Vulnerability management and patching workflow -## 脆弱性管理とパッチ適用ワークフロー +You should conduct regular vulnerability scans of production infrastructure. You should triage the results of vulnerability scans and define a period of time in which you agree to remediate the vulnerability. -プロダクションインフラストラクチャーの定期的な脆弱性スキャンを行わなければなりません。 脆弱性スキャンの結果をトリアージし、脆弱性の修正までの期間を定義して同意しなければなりません。 - -完全な脆弱性管理のプログラムをセットアップする準備ができていない場合は、パッチ適用のプロセスを作成することから始めると役立ちます。 パッチ管理ポリシーを作成するためのガイダンスとしては、TechRepublicの記事「[Establish a patch management policy](https://www.techrepublic.com/blog/it-security/establish-a-patch-management-policy-87756/)」を参照してください。 +If you are not ready to set up a full vulnerability management program, it's useful to start by creating a patching process. For guidance in creating a patch management policy, see this TechRepublic article "[Establish a patch management policy](https://www.techrepublic.com/blog/it-security/establish-a-patch-management-policy-87756/)." diff --git a/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md b/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md index df563b4758..1faccc7c50 100644 --- a/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md +++ b/translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md @@ -1,10 +1,10 @@ --- -title: リストのメトリクスの参照 -intro: '{% data variables.product.prodname_marketplace %} Insightsのページは、{% data variables.product.prodname_github_app %}のメトリクスを表示します。 このメトリクスを使って{% data variables.product.prodname_github_app %}のパフォーマンスを追跡し、価格、プラン、無料トライアル、マーケティングキャンペーンの効果の可視化の方法に関する判断を、より多くの情報に基づいて行えます。' +title: Viewing metrics for your listing +intro: 'The {% data variables.product.prodname_marketplace %} Insights page displays metrics for your {% data variables.product.prodname_github_app %}. You can use the metrics to track your {% data variables.product.prodname_github_app %}''s performance and make more informed decisions about pricing, plans, free trials, and how to visualize the effects of marketing campaigns.' redirect_from: - - /apps/marketplace/managing-github-marketplace-listings/viewing-performance-metrics-for-a-github-marketplace-listing/ - - /apps/marketplace/viewing-performance-metrics-for-a-github-marketplace-listing/ - - /apps/marketplace/github-marketplace-insights/ + - /apps/marketplace/managing-github-marketplace-listings/viewing-performance-metrics-for-a-github-marketplace-listing + - /apps/marketplace/viewing-performance-metrics-for-a-github-marketplace-listing + - /apps/marketplace/github-marketplace-insights - /marketplace/github-marketplace-insights - /developers/github-marketplace/viewing-metrics-for-your-listing versions: @@ -12,45 +12,45 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: リストのメトリクスの表示 +shortTitle: View listing metrics --- - -過去の日（24時間）、週、月、あるいは{% data variables.product.prodname_github_app %}がリストされた期間全体に対するメトリクスを見ることができます。 +You can view metrics for the past day (24 hours), week, month, or for the entire duration of time that your {% data variables.product.prodname_github_app %} has been listed. {% note %} -**ノート:** データの集計には時間がかかるので、表示される日付には若干の遅れが生じます。 期間を選択すると、ページの上部にそのメトリクスの正確な日付が表示されます。 +**Note:** Because it takes time to aggregate data, you'll notice a slight delay in the dates shown. When you select a time period, you can see exact dates for the metrics at the top of the page. {% endnote %} -## パフォーマンスメトリクス +## Performance metrics -Insightsページには、選択された期間に対する以下のパフォーマンスメトリクスが表示されます。 +The Insights page displays these performance metrics, for the selected time period: -* **Subscription value:** サブスクリプションで可能な合計収入（米ドル）。 この値は、プランや無料トライアルがまったくキャンセルされず、すべてのクレジット取引が成功した場合に可能な収入を示します。 subscription valueには、選択された期間内に無料トライアルで始まったプランの全額が、仮にその期間に金銭取引がなかったとしても含まれます。 subscription valueには、選択された期間内にアップグレードされたプランの全額も含まれますが、日割り計算の文は含まれません。 個別の取引を見てダウンロードするには、「[GitHub Marketplaceの取引](/marketplace/github-marketplace-transactions/)」を参照してください。 -* **Visitors:** GitHub Appのリスト内のページを見た人数。 この数字には、ログインした訪問者とログアウトした訪問者がどちらも含まれます。 -* **Pageviews:** GitHub Appのリスト内のページが受けた閲覧数です。 一人の訪問者が複数のページビューを生成できます。 +* **Subscription value:** Total possible revenue (in US dollars) for subscriptions. This value represents the possible revenue if no plans or free trials are cancelled and all credit transactions are successful. The subscription value includes the full value for plans that begin with a free trial in the selected time period, even when there are no financial transactions in that time period. The subscription value also includes the full value of upgraded plans in the selected time period but does not include the prorated amount. To see and download individual transactions, see "[GitHub Marketplace transactions](/marketplace/github-marketplace-transactions/)." +* **Visitors:** Number of people that have viewed a page in your GitHub Apps listing. This number includes both logged in and logged out visitors. +* **Pageviews:** Number of views the pages in your GitHub App's listing received. A single visitor can generate more than one pageview. {% note %} -**ノート:** 推定されたsubscription valueは、その期間に処理された取引よりもはるかに高くなることがあります。 +**Note:** Your estimated subscription value could be much higher than the transactions processed for this period. {% endnote %} -### コンバージョンパフォーマンス +### Conversion performance -* **Unique visitors to landing page:** GitHub Appのランディングページを閲覧した人数。 -* **Unique visitors to checkout page:** GitHub Appのチェックアウトページのいずれかを閲覧した人数。 -* **Checkout page to new subscriptions:** 有料サブスクリプション、無料トライアル、無料サブスクリプションの総数。 それぞれの種類のサブスクリプションの特定の数値については「合計サブスクリプションの内訳」を参照してください。 +* **Unique visitors to landing page:** Number of people who viewed your GitHub App's landing page. +* **Unique visitors to checkout page:** Number of people who viewed one of your GitHub App's checkout pages. +* **Checkout page to new subscriptions:** Total number of paid subscriptions, free trials, and free subscriptions. See the "Breakdown of total subscriptions" for the specific number of each type of subscription. ![Marketplace insights](/assets/images/marketplace/marketplace_insights.png) -{% data variables.product.prodname_marketplace %} Insightsには以下のようにしてアクセスしてください。 +To access {% data variables.product.prodname_marketplace %} Insights: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.marketplace_apps %} -4. Insightを表示させる{% data variables.product.prodname_github_app %}を選択します。 +4. Select the {% data variables.product.prodname_github_app %} that you'd like to view Insights for. {% data reusables.user-settings.edit_marketplace_listing %} -6. **Insights**タブをクリックしてください。 -7. Insightsページの右上にあるPeriod（期間）ドロップダウンをクリックして、異なる期間を選択することもできます。 ![Marketplaceの期間](/assets/images/marketplace/marketplace_insights_time_period.png) +6. Click the **Insights** tab. +7. Optionally, select a different time period by clicking the Period dropdown in the upper-right corner of the Insights page. +![Marketplace time period](/assets/images/marketplace/marketplace_insights_time_period.png) diff --git a/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md b/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md index 9b9bc6f646..7370b55b41 100644 --- a/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md +++ b/translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md @@ -2,7 +2,7 @@ title: About GitHub Marketplace intro: 'Learn about {% data variables.product.prodname_marketplace %} where you can share your apps and actions publicly with all {% data variables.product.product_name %} users.' redirect_from: - - /apps/marketplace/getting-started/ + - /apps/marketplace/getting-started - /marketplace/getting-started - /developers/github-marketplace/about-github-marketplace versions: diff --git a/translations/ja-JP/content/developers/github-marketplace/index.md b/translations/ja-JP/content/developers/github-marketplace/index.md index 52d203a55d..7bfbc295fd 100644 --- a/translations/ja-JP/content/developers/github-marketplace/index.md +++ b/translations/ja-JP/content/developers/github-marketplace/index.md @@ -1,9 +1,9 @@ --- title: GitHub Marketplace -intro: '{% data variables.product.prodname_dotcom %} Marketplaceで開発者が利用したり購入したりできるように、ツールをリストしてください。' +intro: 'List your tools in {% data variables.product.prodname_dotcom %} Marketplace for developers to use or purchase.' redirect_from: - - /apps/adding-integrations/listing-apps-on-github-marketplace/about-github-marketplace/ - - /apps/marketplace/ + - /apps/adding-integrations/listing-apps-on-github-marketplace/about-github-marketplace + - /apps/marketplace - /marketplace versions: fpt: '*' diff --git a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md index 05a31943e4..d1b387eead 100644 --- a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md +++ b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md @@ -1,11 +1,11 @@ --- -title: プランの変更を通知するようwebhookを設定する -intro: '[ドラフトの{% data variables.product.prodname_marketplace %}リストを作成](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)したあと、顧客のアカウントのプランに変更があった場合に通知するよう、webhookを設定できます。 webhookを設定すると、アプリケーション中で[`marketplace_purchase`イベントタイプを処理](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)できるようになります。' +title: Configuring a webhook to notify you of plan changes +intro: 'After [creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/), you can configure a webhook that notifies you when changes to customer account plans occur. After you configure the webhook, you can [handle the `marketplace_purchase` event types](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) in your app.' redirect_from: - - /apps/adding-integrations/managing-listings-on-github-marketplace/adding-webhooks-for-a-github-marketplace-listing/ - - /apps/marketplace/managing-github-marketplace-listings/adding-webhooks-for-a-github-marketplace-listing/ - - /apps/marketplace/setting-up-github-marketplace-webhooks/creating-a-webhook-for-a-github-marketplace-listing/ - - /apps/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/ + - /apps/adding-integrations/managing-listings-on-github-marketplace/adding-webhooks-for-a-github-marketplace-listing + - /apps/marketplace/managing-github-marketplace-listings/adding-webhooks-for-a-github-marketplace-listing + - /apps/marketplace/setting-up-github-marketplace-webhooks/creating-a-webhook-for-a-github-marketplace-listing + - /apps/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook - /marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook - /developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes versions: @@ -13,14 +13,13 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: プラン変更のwebhook +shortTitle: Webhooks for plan changes --- +The {% data variables.product.prodname_marketplace %} event webhook can only be set up from your application's {% data variables.product.prodname_marketplace %} listing page. You can configure all other events from your [application's developer settings page](https://github.com/settings/developers). If you haven't created a {% data variables.product.prodname_marketplace %} listing, read "[Creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)" to learn how. -{% data variables.product.prodname_marketplace %}のイベントwebhookは、アプリケーションの{% data variables.product.prodname_marketplace %}リストページからのみセットアップできます。 他のすべてのイベントは、[アプリケーションの開発者設定ページ](https://github.com/settings/developers)から設定できます。 {% data variables.product.prodname_marketplace %}のリストを作成していない場合は、「[ドラフトの{% data variables.product.prodname_marketplace %}リストの作成](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)」を読んで、その方法を学んでください。 +## Creating a webhook -## webhookの作成 - -{% data variables.product.prodname_marketplace %}リストのwebhookを作成するには、[{% data variables.product.prodname_marketplace %}リストページ](https://github.com/marketplace/manage)の左のサイドバーで**Webhook**をクリックしてください。 webhookを設定するのに必要な、以下のwebhookの設定オプションが表示されます。 +To create a webhook for your {% data variables.product.prodname_marketplace %} listing, click **Webhook** in the left sidebar of your [{% data variables.product.prodname_marketplace %} listing page](https://github.com/marketplace/manage). You'll see the following webhook configuration options needed to configure your webhook: ### Payload URL @@ -28,7 +27,7 @@ shortTitle: プラン変更のwebhook ### Content type -{% data reusables.webhooks.content_type %} GitHubは、`application/json`コンテンツタイプの利用をおすすめします。 +{% data reusables.webhooks.content_type %} GitHub recommends using the `application/json` content type. ### Secret @@ -36,10 +35,10 @@ shortTitle: プラン変更のwebhook ### Active -デフォルトでは、webhookの配信は「Active」です。 「Active」の選択を解除すれば、開発の間webhookペイロードの配信を無効にできます。 webhookの配信を無効にした場合、レビューのためにアプリケーションをサブミットする前には「Active」を選択しなければなりません。 +By default, webhook deliveries are "Active." You can choose to disable the delivery of webhook payloads during development by deselecting "Active." If you've disabled webhook deliveries, you will need to select "Active" before you submit your app for review. -## webhookの配信の表示 +## Viewing webhook deliveries -{% data variables.product.prodname_marketplace %} webhookを設定すると、アプリケーションの[{% data variables.product.prodname_marketplace %}リスト](https://github.com/marketplace/manage)の**Webhook**ページから、`POST`リクエストのペイロードを調べることができるようになります。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。 +Once you've configured your {% data variables.product.prodname_marketplace %} webhook, you'll be able to inspect `POST` request payloads from the **Webhook** page of your application's [{% data variables.product.prodname_marketplace %} listing](https://github.com/marketplace/manage). GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub. -![最近の{% data variables.product.prodname_marketplace %} webhookの配信の調査](/assets/images/marketplace/marketplace_webhook_deliveries.png) +![Inspect recent {% data variables.product.prodname_marketplace %} webhook deliveries](/assets/images/marketplace/marketplace_webhook_deliveries.png) diff --git a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md index 65ea0f1037..9dd64a8959 100644 --- a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md +++ b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md @@ -1,16 +1,16 @@ --- -title: アプリケーションのリストのドラフト -intro: '{% data variables.product.prodname_marketplace %}のリストを作成すると、GitHubは承認のためにアプリケーションがサブミットされるまで、そのリストをドラフトモードで保存します。 このリストは、顧客に対してアプリケーションがどのように使えるのかを示します。' +title: Drafting a listing for your app +intro: 'When you create a {% data variables.product.prodname_marketplace %} listing, GitHub saves it in draft mode until you submit the app for approval. Your listing shows customers how they can use your app.' redirect_from: - - /apps/adding-integrations/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace/ - - /apps/marketplace/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace/ - - /apps/marketplace/getting-started-with-github-marketplace-listings/listing-an-app-on-github-marketplace/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/listing-an-app-on-github-marketplace/ - - /apps/adding-integrations/managing-listings-on-github-marketplace/removing-a-listing-from-github-marketplace/ - - /apps/marketplace/managing-github-marketplace-listings/removing-a-listing-from-github-marketplace/ - - /apps/adding-integrations/managing-listings-on-github-marketplace/editing-a-github-marketplace-listing/ - - /apps/marketplace/managing-github-marketplace-listings/editing-a-github-marketplace-listing/ - - /apps/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/ + - /apps/adding-integrations/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace + - /apps/marketplace/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace + - /apps/marketplace/getting-started-with-github-marketplace-listings/listing-an-app-on-github-marketplace + - /apps/marketplace/creating-and-submitting-your-app-for-approval/listing-an-app-on-github-marketplace + - /apps/adding-integrations/managing-listings-on-github-marketplace/removing-a-listing-from-github-marketplace + - /apps/marketplace/managing-github-marketplace-listings/removing-a-listing-from-github-marketplace + - /apps/adding-integrations/managing-listings-on-github-marketplace/editing-a-github-marketplace-listing + - /apps/marketplace/managing-github-marketplace-listings/editing-a-github-marketplace-listing + - /apps/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing - /marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing - /developers/github-marketplace/drafting-a-listing-for-your-app versions: @@ -18,50 +18,51 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: アプリケーションリストのドラフト +shortTitle: Draft an app listing --- +## Create a new draft {% data variables.product.prodname_marketplace %} listing -## 新しいドラフトの{% data variables.product.prodname_marketplace %}リストの作成 +You can only create draft listings for apps that are public. Before creating your draft listing, you can read the following guidelines for writing and configuring settings in your {% data variables.product.prodname_marketplace %} listing: -パブリックなアプリケーションについては、ドラフトのリストだけが作成できます。 ドラフトのリストを作成する前に、{% data variables.product.prodname_marketplace %}リストの設定を書いて構成するための以下のガイドラインを読んでください。 +* [Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/) +* [Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/) +* [Configuring the {% data variables.product.prodname_marketplace %} Webhook](/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/) -* [{% data variables.product.prodname_marketplace %}リストの説明を書く](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/) -* [{% data variables.product.prodname_marketplace %}リストの価格プランの設定](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/) -* [{% data variables.product.prodname_marketplace %} webhookの設定](/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/) - -{% data variables.product.prodname_marketplace %}のリストを作成するには、以下のようにします。 +To create a {% data variables.product.prodname_marketplace %} listing: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} -3. 左のサイドバーで、{% data variables.product.prodname_marketplace %}に追加しようとしているアプリケーションに応じて、**OAuth Apps**もしくは**GitHub Apps**をクリックしてください。 +3. In the left sidebar, click either **OAuth Apps** or **GitHub Apps** depending on the app you're adding to {% data variables.product.prodname_marketplace %}. {% note %} - **ノート**: https://github.com/marketplace/new にアクセスし、利用可能なアプリケーションを見て、**Create draft listing（ドラフトのリストの作成）**をクリックしても、リストを追加できます。 + **Note**: You can also add a listing by navigating to https://github.com/marketplace/new, viewing your available apps, and clicking **Create draft listing**. {% endnote %} - ![アプリケーションの種類の選択](/assets/images/settings/apps_choose_app.png) + ![App type selection](/assets/images/settings/apps_choose_app.png) -4. {% data variables.product.prodname_marketplace %}に追加するアプリケーションを選択します。 ![{% data variables.product.prodname_marketplace %}リストのアプリケーションの選択](/assets/images/github-apps/github_apps_select-app.png) +4. Select the app you'd like to add to {% data variables.product.prodname_marketplace %}. +![App selection for {% data variables.product.prodname_marketplace %} listing](/assets/images/github-apps/github_apps_select-app.png) {% data reusables.user-settings.edit_marketplace_listing %} -5. 新しいドラフトのリストを作成すると、{% data variables.product.prodname_marketplace %}のリストの完成前にアクセスしておかなければならないセクションの概要が表示されます。 ![GitHub Marketplaceのリスト](/assets/images/marketplace/marketplace_listing_overview.png) +5. Once you've created a new draft listing, you'll see an overview of the sections that you'll need to visit before your {% data variables.product.prodname_marketplace %} listing will be complete. +![GitHub Marketplace listing](/assets/images/marketplace/marketplace_listing_overview.png) {% note %} -**ノート:** リストの"Contact info（連絡先の情報）"セクションでは、support@domain.comというようなグループメールアドレスよりは、個人のメールアドレスを使うことをおすすめします。 GitHubはこれらのメールアドレスを、リストに影響するかもしれない{% data variables.product.prodname_marketplace %}のアップデート、新機能、マーケティングの機会、支払い、カンファレンスやスポンサーシップに関する情報などに関する連絡に使用します。 +**Note:** In the "Contact info" section of your listing, we recommend using individual email addresses, rather than group emails addresses like support@domain.com. GitHub will use these email addresses to contact you about updates to {% data variables.product.prodname_marketplace %} that might affect your listing, new feature releases, marketing opportunities, payouts, and information on conferences and sponsorships. {% endnote %} -## リストの編集 +## Editing your listing -{% data variables.product.prodname_marketplace %}のドラフトリストを作成した後は、いつでもリスト内の情報を変更するために戻ってくることができます。 アプリケーションが検証済みで{% data variables.product.prodname_marketplace %}にあるなら、リスト中の情報や画像を編集することはできますが、公開された既存の価格プランを変更することはできません。 「[{% data variables.product.prodname_marketplace %}リストの価格プランの設定](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)」を参照してください。 +Once you've created a {% data variables.product.prodname_marketplace %} draft listing, you can come back to modify information in your listing anytime. If your app is already approved and in {% data variables.product.prodname_marketplace %}, you can edit the information and images in your listing, but you will not be able to change existing published pricing plans. See "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)." -## アプリケーションのサブミット +## Submitting your app -{% data variables.product.prodname_marketplace %}リストが完成したら、**Overview（概要）**ページからレビューのためにリストをサブミットできます。 「[{% data variables.product.prodname_marketplace %}の開発者契約](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement/)」を読んで同意しなければなりません。続いて**Submit for review（レビューのためにサブミット）**をクリックできます。 レビューのためにアプリケーションをサブミットした後、のオンボーディングの専門家から、オンボーディングのプロセスに関する追加情報と併せて連絡が来ます。 +Once you've completed your {% data variables.product.prodname_marketplace %} listing, you can submit your listing for review from the **Overview** page. You'll need to read and accept the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement/)," and then you can click **Submit for review**. After you submit your app for review, an onboarding expert will contact you with additional information about the onboarding process. -## {% data variables.product.prodname_marketplace %}リストの削除 +## Removing a {% data variables.product.prodname_marketplace %} listing -アプリケーションを{% data variables.product.prodname_marketplace %}のリストに載せたくなくなったなら、リストを削除するために{% data variables.contact.contact_support %}に連絡してください。 +If you no longer want to list your app in {% data variables.product.prodname_marketplace %}, contact {% data variables.contact.contact_support %} to remove your listing. diff --git a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md index 0af82f6f19..c587c34a71 100644 --- a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md +++ b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md @@ -1,14 +1,14 @@ --- -title: GitHub Marketplace上でのアプリケーションのリスト -intro: 'アプリケーションを{% data variables.product.prodname_marketplace %}上でリストする際の要件とベストプラクティスについて学んでください。' +title: Listing an app on GitHub Marketplace +intro: 'Learn about requirements and best practices for listing your app on {% data variables.product.prodname_marketplace %}.' redirect_from: - - /apps/adding-integrations/listing-apps-on-github-marketplace/ - - /apps/marketplace/listing-apps-on-github-marketplace/ - - /apps/marketplace/getting-started-with-github-marketplace-listings/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/ - - /apps/adding-integrations/managing-listings-on-github-marketplace/ - - /apps/marketplace/managing-github-marketplace-listings/ - - /apps/marketplace/listing-on-github-marketplace/ + - /apps/adding-integrations/listing-apps-on-github-marketplace + - /apps/marketplace/listing-apps-on-github-marketplace + - /apps/marketplace/getting-started-with-github-marketplace-listings + - /apps/marketplace/creating-and-submitting-your-app-for-approval + - /apps/adding-integrations/managing-listings-on-github-marketplace + - /apps/marketplace/managing-github-marketplace-listings + - /apps/marketplace/listing-on-github-marketplace - /marketplace/listing-on-github-marketplace versions: fpt: '*' @@ -21,6 +21,6 @@ children: - /setting-pricing-plans-for-your-listing - /configuring-a-webhook-to-notify-you-of-plan-changes - /submitting-your-listing-for-publication -shortTitle: Marketplaceへのアプリケーションの掲載 +shortTitle: List an app on the Marketplace --- diff --git a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md index 3f01711b93..ffdba1e720 100644 --- a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md +++ b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md @@ -1,17 +1,17 @@ --- -title: リストに対する価格プランの設定 -intro: 'アプリケーションを{% data variables.product.prodname_marketplace %}上でリストする際に、アプリケーションを無料のサービスとして提供するか、アプリケーションを販売するかを選択できます。 アプリケーションを販売することを計画するなら、様々な機能レベルに対して異なる価格プランを作成できます。' +title: Setting pricing plans for your listing +intro: 'When you list your app on {% data variables.product.prodname_marketplace %}, you can choose to provide your app as a free service or sell your app. If you plan to sell your app, you can create different pricing plans for different feature tiers.' redirect_from: - - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/pricing-payments-and-free-trials/setting-a-github-marketplace-listing-s-pricing-plan/ - - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans/ - - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans/ - - /apps/marketplace/pricing-payments-and-free-trials/about-github-marketplace-pricing-plans/ - - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/managing-github-marketplace-listings/changing-a-github-marketplace-listing-s-pricing-plan/ - - /apps/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/ + - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/pricing-payments-and-free-trials/setting-a-github-marketplace-listing-s-pricing-plan + - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans + - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans + - /apps/marketplace/pricing-payments-and-free-trials/about-github-marketplace-pricing-plans + - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/managing-github-marketplace-listings/changing-a-github-marketplace-listing-s-pricing-plan + - /apps/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan - /marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan - /developers/github-marketplace/setting-pricing-plans-for-your-listing versions: @@ -19,70 +19,69 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: 掲載する価格プランの設定 +shortTitle: Set listing pricing plans --- +## About setting pricing plans -## 価格プランの設定について +{% data variables.product.prodname_marketplace %} offers several different types of pricing plans. For detailed information, see "[Pricing plans for {% data variables.product.prodname_marketplace %}](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)." -{% data variables.product.prodname_marketplace %}では、いくつかの種類の価格プランを提供しています。 詳細にな情報については「[{% data variables.product.prodname_marketplace %}の価格プラン](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)」を参照してください。 +To offer a paid plan for your app, your app must be owned by an organization that has completed the publisher verification process and met certain criteria. For more information, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)" and "[Requirements for listing an app on {% data variables.product.prodname_marketplace %}](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)." -アプリケーションで有料プランを提供するには、アプリケーションがパブリッシャー検証プロセスを済ませたOrganizationの所有であり、かつ特定の条件を満たす必要があります。 詳しい情報については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」および「[{% data variables.product.prodname_marketplace %}アプリケーションを載せるための要件](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)」を参照してください。 +If your app is already published with a paid plan and you're a verified publisher, then you can publish a new paid plan from the "Edit a pricing plan" page in your Marketplace app listing settings. -アプリケーションが有料プラン付きで既に公開されており、あなたが検証済みパブリッシャーである場合は、Marketplaceアプリケーション掲載設定の [Edit a pricing plan] ページから新しい有料プランを公開できます。 +![Publish this plan button](/assets/images/marketplace/publish-this-plan-button.png) -![[Publish this plan] ボタン](/assets/images/marketplace/publish-this-plan-button.png) +If your app is already published with a paid plan and but you are not a verified publisher, then you can cannot publish a new paid plan until you are a verified publisher. For more information about becoming a verified publisher, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." -アプリケーションが有料プラン付きで既に公開されており、あなたが検証済みパブリッシャーでない場合は、検証済みパブリッシャーになるまで新しい有料プランを公開できません。 検証済みパブリッシャーになる方法の詳細については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」を参照してください。 +## About saving pricing plans -## 価格プランの保存について +You can save pricing plans in a draft or published state. If you haven't submitted your {% data variables.product.prodname_marketplace %} listing for approval, a published plan will function in the same way as a draft plan until your listing is approved and shown on {% data variables.product.prodname_marketplace %}. Draft plans allow you to create and save new pricing plans without making them available on your {% data variables.product.prodname_marketplace %} listing page. Once you publish a pricing plan on a published listing, it's available for customers to purchase immediately. You can publish up to 10 pricing plans. -価格プランは、ドラフトもしくは公開状態で保存できます。 {% data variables.product.prodname_marketplace %}リストを承認のためにサブミットしていないなら、リストが承認されるまでは公開されたプランはドラフトのプランと同じように機能し、{% data variables.product.prodname_marketplace %}上に表示されます。 ドラフトプランを利用すると、新しい価格プランを{% data variables.product.prodname_marketplace %}リストページ上で利用できるようにすることなく作成し、保存できます。 公開リスト上で価格プランを公開すると、顧客はすぐにそれを利用して購入できるようになります。 最大で10の価格プランを公開できます。 +For guidelines on billing customers, see "[Billing customers](/developers/github-marketplace/billing-customers)." -顧客への課金のガイドラインについては、「[顧客への課金](/developers/github-marketplace/billing-customers)」を参照してください。 +## Creating pricing plans -## 価格プランの作成 +To create a pricing plan for your {% data variables.product.prodname_marketplace %} listing, click **Plans and pricing** in the left sidebar of your [{% data variables.product.prodname_marketplace %} listing page](https://github.com/marketplace/manage). For more information, see "[Creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)." -{% data variables.product.prodname_marketplace %}リストの価格プランを作成するには、[{% data variables.product.prodname_marketplace %}リストページ](https://github.com/marketplace/manage)の左のサイドバーで**Plans and pricing（プラント価格）**をクリックしてください。 詳しい情報については「[ドラフトの{% data variables.product.prodname_marketplace %}リストの作成](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)」を参照してください。 +When you click **New draft plan**, you'll see a form that allows you to customize your pricing plan. You'll need to configure the following fields to create a pricing plan: -**New draft plan（新規ドラフトプラン）**をクリックすると、価格プランをカスタマイズできるフォームが表示されます。 価格プランを作成するには、以下のフィールドを設定しなければなりません。 +- **Plan name** - Your pricing plan's name will appear on your {% data variables.product.prodname_marketplace %} app's landing page. You can customize the name of your pricing plan to align with the plan's resources, the size of the company that will use the plan, or anything you'd like. -- **Plan name（プラン名）** - プラン名は、{% data variables.product.prodname_marketplace %}アプリケーションのランディングページに表示されます。 価格名はカスタマイズして、プランのリソース、そのプランを利用する企業の規模、あるいはその他好きなことにあわせることができます。 +- **Pricing models** - There are three types of pricing plan: free, flat-rate, and per-unit. All plans require you to process new purchase and cancellation events from the marketplace API. In addition, for paid plans: -- **Pricing models（価格モデル）** - 価格モデルには、無料、定額、ユニット単位の3種類があります。 すべてのプランで、Marketplace APIからの新規の購入とキャンセルの処理が必要になります。 加えて、有料プランでは以下が必要です。 - - - 月単位及び年単位でのサブスクリプションの価格を米ドルで設定しなければなりません。 - - アプリケーションはプランの変更イベントを処理しなければなりません。 - - 有料プランを持つリストを公開するには、検証をリクエストしなければなりません。 + - You must set a price for both monthly and yearly subscriptions in US dollars. + - Your app must process plan change events. + - You must request verification to publish a listing with a paid plan. - {% data reusables.marketplace.marketplace-pricing-free-trials %} - 詳細な情報については、「[{% data variables.product.prodname_marketplace %}アプリケーションの価格プラン](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)」及び「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。 + For detailed information, see "[Pricing plans for {% data variables.product.prodname_marketplace %} apps](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)" and "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -- **Available for（利用対象）** - {% data variables.product.prodname_marketplace %}の価格プランは、**個人及びOrganizationアカウント**、**個人アカウントのみ**、**Organizationアカウントのみ**のいずれかにできます。 たとえば、価格プランがユニット単位であり、複数のシートを提供するなら、個人アカウントからOrganization内の人にシートを割り当てる方法はないので、**Organization accounts only（Organizationアカウントのみ）**が選択できるでしょう。 +- **Available for** - {% data variables.product.prodname_marketplace %} pricing plans can apply to **Personal and organization accounts**, **Personal accounts only**, or **Organization accounts only**. For example, if your pricing plan is per-unit and provides multiple seats, you would select **Organization accounts only** because there is no way to assign seats to people in an organization from a personal account. -- **Short description（簡単な説明）** - 価格プランの詳細の簡単な要約を書いてください。 この説明には、そのプランが意図している顧客の種類や、プランに含まれるリソースなどが含まれることがあります。 +- **Short description** - Write a brief summary of the details of the pricing plan. The description might include the type of customer the plan is intended for or the resources the plan includes. -- **Bullets（箇条書き）** - 価格プランに関する詳細を含む箇条書きを、最大で4項目書くことができます。 この箇条書きでは、アプリケーションのユースケースを含めたり、プランに含まれるリソースや機能に関するさらなる詳細をリストしたりすることができます。 +- **Bullets** - You can write up to four bullets that include more details about your pricing plan. The bullets might include the use cases of your app or list more detailed information about the resources or features included in the plan. {% data reusables.marketplace.free-plan-note %} -## {% data variables.product.prodname_marketplace %}リストの価格プランの変更 +## Changing a {% data variables.product.prodname_marketplace %} listing's pricing plan -{% data variables.product.prodname_marketplace %}のリストのための価格プランが必要なくなったり、プランの詳細を調整する必要が生じた場合、そのプランを削除できます。 +If a pricing plan for your {% data variables.product.prodname_marketplace %} listing is no longer needed, or if you need to adjust pricing details, you can remove it. -![価格プランを削除するボタン](/assets/images/marketplace/marketplace_remove_this_plan.png) +![Button to remove your pricing plan](/assets/images/marketplace/marketplace_remove_this_plan.png) -{% data variables.product.prodname_marketplace %}にリスト済みのアプリケーションの価格プランを公開すると、そのプランは変更できなくなります。 その代わりに、その価格プランを削除して、新しいプランを作成しなければなりません。 削除された価格プランを購入済みの顧客は、オプトアウトして新しい価格プランに移行するまでは、そのプランを使い続けます。 価格プランの詳細については、「[{% data variables.product.prodname_marketplace %}の価格プラン](/marketplace/selling-your-app/github-marketplace-pricing-plans/)」を参照してください。 +Once you publish a pricing plan for an app that is already listed in {% data variables.product.prodname_marketplace %}, you can't make changes to the plan. Instead, you'll need to remove the pricing plan and create a new plan. Customers who already purchased the removed pricing plan will continue to use it until they opt out and move onto a new pricing plan. For more on pricing plans, see "[{% data variables.product.prodname_marketplace %} pricing plans](/marketplace/selling-your-app/github-marketplace-pricing-plans/)." -価格プランを削除すると、ユーザはそのプランを使ってアプリケーションを購入することはできなくなります。 削除されたプランの既存ユーザは、プランのサブスクリプションをキャンセルするまではそのプランに留まり続けます。 +Once you remove a pricing plan, users won't be able to purchase your app using that plan. Existing users on the removed pricing plan will continue to stay on the plan until they cancel their plan subscription. {% note %} -**ノート:** {% data variables.product.product_name %}は、削除された価格プランからユーザを削除することはできません。 削除された価格プランから新しい価格プランへ、アップグレードもしくはダウングレードするようユーザに促すキャンペーンを実行できます。 +**Note:** {% data variables.product.product_name %} can't remove users from a removed pricing plan. You can run a campaign to encourage users to upgrade or downgrade from the removed pricing plan onto a new pricing plan. {% endnote %} -価格プランを取り下げることなくGitHub Marketplaceの無料トライアルを無効化することはできますが、そうすると将来的にそのプランの無料トライアルを開始できなくなります。 価格プランに対する無料トライアルを無効にすることにした場合、サインアップ済みのユーザは無料トライアルを最後まで利用できます。 +You can disable GitHub Marketplace free trials without retiring the pricing plan, but this prevents you from initiating future free trials for that plan. If you choose to disable free trials for a pricing plan, users already signed up can complete their free trial. -価格プランを終了した後には、削除した価格プランと同じ名前で新しい価格プランを作成できます。 たとえば、「Pro」価格プランがあるものの、定額料金を変更する必要がある場合、その「Pro」価格プランを削除し、更新された価格で新しい「Pro」価格プランを作成できます。 ユーザは、すぐに新しい価格プランで購入できるようになります。 +After retiring a pricing plan, you can create a new pricing plan with the same name as the removed pricing plan. For instance, if you have a "Pro" pricing plan but need to change the flat rate price, you can remove the "Pro" pricing plan and create a new "Pro" pricing plan with an updated price. Users will be able to purchase the new pricing plan immediately. -あなたが検証済みパブリッシャーでない場合は、アプリケーションの価格プランを変更できません。 検証済みパブリッシャーになる方法の詳細については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」を参照してください。 +If you are not a verified publisher, then you cannot change a pricing plan for your app. For more information about becoming a verified publisher, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)." diff --git a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md index 41b5dcefad..0fc3e55f1b 100644 --- a/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md +++ b/translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md @@ -1,14 +1,14 @@ --- -title: アプリケーションのリストの説明を書く -intro: '{% data variables.product.prodname_marketplace %}で[アプリケーションをリスト](/marketplace/listing-on-github-marketplace/) するには、GitHubのガイドラインに従ってアプリケーションの説明を書き、画像を指定する必要があります。' +title: Writing a listing description for your app +intro: 'To [list your app](/marketplace/listing-on-github-marketplace/) in the {% data variables.product.prodname_marketplace %}, you''ll need to write descriptions of your app and provide images that follow GitHub''s guidelines.' redirect_from: - - /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-writing-github-app-descriptions/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/writing-github-app-descriptions/ - - /apps/adding-integrations/listing-apps-on-github-marketplace/guidelines-for-creating-a-github-marketplace-listing/ - - /apps/marketplace/listing-apps-on-github/guidelines-for-creating-a-github-marketplace-listing/ - - /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-creating-github-marketplace-listing-images/ - - /apps/marketplace/creating-and-submitting-your-app-for-approval/creating-github-marketplace-listing-images/ - - /apps/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/ + - /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-writing-github-app-descriptions + - /apps/marketplace/creating-and-submitting-your-app-for-approval/writing-github-app-descriptions + - /apps/adding-integrations/listing-apps-on-github-marketplace/guidelines-for-creating-a-github-marketplace-listing + - /apps/marketplace/listing-apps-on-github/guidelines-for-creating-a-github-marketplace-listing + - /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-creating-github-marketplace-listing-images + - /apps/marketplace/creating-and-submitting-your-app-for-approval/creating-github-marketplace-listing-images + - /apps/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions - /marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions - /developers/github-marketplace/writing-a-listing-description-for-your-app versions: @@ -16,183 +16,181 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: リストの説明を書く +shortTitle: Write listing descriptions --- +Here are guidelines about the fields you'll need to fill out in the **Listing description** section of your draft listing. -ドラフトリストの [**リストの説明**] セクションに入力する必要があるフィールドについてのガイドラインは以下のとおりです。 +## Naming and links -## 名前のリンク +### Listing name -### リスト名 +Your listing's name will appear on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). The name is limited to 255 characters and can be different from your app's name. Your listing cannot have the same name as an existing account on {% data variables.product.product_location %}, unless the name is your own user or organization name. -リストの名前は、 [{% data variables.product.prodname_marketplace %}ホームページ](https://github.com/marketplace)に表示されます。 名前は255文字を上限とし、アプリケーションの名前と異なっていても構いません。 リストの名前は、{% data variables.product.product_location %}上の既存アカウントと同じ名前にできません。ただし、その名前があなた自身のユーザ名やOrganization名である場合は例外です。 +### Very short description -### ごく簡単な説明 +The community will see the "very short" description under your app's name on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). -コミュニティには、[{% data variables.product.prodname_marketplace %}ホームページ](https://github.com/marketplace)のアプリケーション名の下に「ごく短い」説明が表示されます。 +![{% data variables.product.prodname_marketplace %} app short description](/assets/images/marketplace/marketplace_short_description.png) -![{% data variables.product.prodname_marketplace %}アプリケーションの短い説明](/assets/images/marketplace/marketplace_short_description.png) +#### Length -#### 長さ +We recommend keeping short descriptions to 40-80 characters. Although you are allowed to use more characters, concise descriptions are easier for customers to read and understand quickly. -簡単な説明は、40～80文字にとどめることをお勧めします。 それ以上の文字数を使うこともできますが、説明は簡潔なほうが顧客に読みやすく、わかりやすくなります。 +#### Content -#### 内容 +- Describe the app’s functionality. Don't use this space for a call to action. For example: -- アプリケーションの機能を説明します。 このスペースを操作の指示には使用しないでください。 例: + **DO:** Lightweight project management for GitHub issues - **良い例:** GitHub Issueの軽量なプロジェクト管理 + **DON'T:** Manage your projects and issues on GitHub - **悪い例:** GitHubでプロジェクトとIssueを管理してください + **Tip:** Add an "s" to the end of the verb in a call to action to turn it into an acceptable description: _Manages your projects and issues on GitHub_ - **ヒント:** 「～してください」ではなく「～します」と書けば、一応、説明として許容されます。例: _GitHubでプロジェクトとIssueを管理します_ +- Don’t repeat the app’s name in the description. -- 説明でアプリケーション名は繰り返さないようにします。 + **DO:** A container-native continuous integration tool - **良い例:** コンテナ対応の継続的インテグレーションツール + **DON'T:** Skycap is a container-native continuous integration tool - **悪い例:** Skycapは、コンテナ対応の継続的インテグレーションツールです +#### Formatting -#### フォーマット +- Always use sentence-case capitalization. Only capitalize the first letter and proper nouns. -- 英文字表記は固有名詞に使用し、大文字小文字は常に正しく使ってください。 大文字で始めて英文字表記するのは固有名詞だけです。 +- Don't use punctuation at the end of your short description. Short descriptions should not include complete sentences, and definitely should not include more than one sentence. -- 短い説明の終わりには句読点を付けません。 完全文では書かないようにし、複数文は絶対に避けてください。 +- Only capitalize proper nouns. For example: -- 大文字で始めて英文字表記するのは固有名詞だけです。 例: + **DO:** One-click delivery automation for web developers - **良い例:** Web開発者向けのワンクリック配信の自動化 + **DON'T:** One-click delivery automation for Web Developers - **悪い例:** Web Developer用のワンクリック配信の自動化 +- Always use a [serial comma](https://en.wikipedia.org/wiki/Serial_comma) in lists. -- 3つ以上の項目を並べるとき、[最後の「および」の前には読点](https://en.wikipedia.org/wiki/Serial_comma)を打ちます。 +- Avoid referring to the GitHub community as "users." -- GitHubコミュニティを「ユーザー」と称するのは避けてください。 + **DO:** Create issues automatically for people in your organization - **良い例:** Organizationの人に自動的にIssueを作成する + **DON'T:** Create issues automatically for an organization's users - **悪い例:** 組織のユーザーについて自動的にIssueを作成する +- Avoid acronyms unless they’re well established (such as API). For example: -- 略語は一般的な場合 (APIなど) を除いて使用しないでください。 例: + **DO:** Agile task boards, estimates, and reports without leaving GitHub - **良い例:** GitHubから移動しないアジャイルタスクボード、推定、およびレポート + **DON'T:** Agile task boards, estimates, and reports without leaving GitHub’s UI - **悪い例'T:** GitHub UIから移動しないアジャイルタスクボード、推定、およびレポート +### Categories -### カテゴリ +Apps in {% data variables.product.prodname_marketplace %} can be displayed by category. Select the category that best describes the main functionality of your app in the **Primary category** dropdown, and optionally select a **Secondary category** that fits your app. -{% data variables.product.prodname_marketplace %}のアプリケーションはカテゴリ別に表示できます。 アプリケーションの主な機能を端的に表すカテゴリを [**Primary category**] ドロップダウンで選択し、オプションでstrong x-id="1">アプリケーションに適した [**Secondary category**] を選択します。 +### Supported languages -### サポートされている言語 +If your app only works with specific languages, select up to 10 programming languages that your app supports. These languages are displayed on your app's {% data variables.product.prodname_marketplace %} listing page. This field is optional. -アプリケーションが特定の言語でのみ動作する場合は、アプリケーションがサポートしている言語を最大10まで選択します。 選択した言語はアプリケーションの{% data variables.product.prodname_marketplace %}リストページに表示されます。 このフィールドはオプションです。 +### Listing URLs -### URLのリスト +**Required URLs** +* **Customer support URL:** The URL of a web page that your customers will go to when they have technical support, product, or account inquiries. +* **Privacy policy URL:** The web page that displays your app's privacy policy. +* **Installation URL:** This field is shown for OAuth Apps only. (GitHub Apps don't use this URL because they use the optional Setup URL from the GitHub App's settings page instead.) When a customer purchases your OAuth App, GitHub will redirect customers to the installation URL after they install the app. You will need to redirect customers to `https://github.com/login/oauth/authorize` to begin the OAuth authorization flow. See "[New purchases for OAuth Apps](/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/)" for more details. Skip this field if you're listing a GitHub App. -**必須のURL** -* **カスタマーサポートのURL:** 顧客がテクニカルサポート、製品、またはアカウントについて問い合わせるためにアクセスするWebページのURL。 -* **プライバシーポリシーのURL:** アプリケーションのプライバシーポリシーが表示されるWebページ。 -* **インストールURL:** このフィールドが表示されるのはOAuthアプリケーションの場合のみです。 (GitHub AppはこのURLを使用しません。かわりに、GitHub Appの設定ページからオプションの設定URLを使用するからです。) 顧客がOAuth Appを購入する際、アプリケーションのインストール後にGitHubは顧客をインストールURLにリダイレクトします。 OAuth認証フローを始めるには、顧客を`https://github.com/login/oauth/authorize`にリダイレクトする必要があります。 詳細については、「[OAuthアプリケーションの新規購入](/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/)」を参照してください。 GitHub Appをリストする場合、このフィールドはスキップしてください。 +**Optional URLs** +* **Company URL:** A link to your company's website. +* **Status URL:** A link to a web page that displays the status of your app. Status pages can include current and historical incident reports, web application uptime status, and scheduled maintenance. +* **Documentation URL:** A link to documentation that teaches customers how to use your app. -**オプションのURL** -* **企業URL:** 会社のWebサイトへのリンク。 -* **ステータスURL:** アプリケーションのステータスを表示するWebページへのリンク。 ステータスページには、現在および履歴のインシデントレポート、Webアプリケーションの稼働時間ステータス、およびメンテナンスのスケジュールが記載されます。 -* **ドキュメントのURL:** 顧客にアプリケーションの使用方法を説明するドキュメントへのリンク。 +## Logo and feature card -## ロゴと機能カード +{% data variables.product.prodname_marketplace %} displays all listings with a square logo image inside a circular badge to visually distinguish apps. -{% data variables.product.prodname_marketplace %}には、アプリケーションを視覚的に区別するために、円形のバッジの中に四角いロゴ画像の付いたリストが表示されます。 +![GitHub Marketplace logo and badge images](/assets/images/marketplace/marketplace-logo-and-badge.png) -![GitHub Marketplaceのロゴおよびバッジ画像](/assets/images/marketplace/marketplace-logo-and-badge.png) +A feature card consists of your app's logo, name, and a custom background image that captures your brand personality. {% data variables.product.prodname_marketplace %} displays this card if your app is one of the four randomly featured apps at the top of the [homepage](https://github.com/marketplace). Each app's very short description is displayed below its feature card. -機能カードは、アプリケーションのロゴ、名前、およびブランドの個性を捉えた顧客の背景画像で構成されます。 アプリケーションが、ランダムに選択されて[ホームページ](https://github.com/marketplace)の上部に表示されているアプリケーションの1つである場合、{% data variables.product.prodname_marketplace %}には、このカードが表示されます。 各アプリケーションのごく短い説明が、機能カードの下に表示されます。 +![Feature card](/assets/images/marketplace/marketplace_feature_card.png) -![機能カード](/assets/images/marketplace/marketplace_feature_card.png) +As you upload images and select colors, your {% data variables.product.prodname_marketplace %} draft listing will display a preview of your logo and feature card. -画像をアップロードして色を選択すると、{% data variables.product.prodname_marketplace %}のドラフトリストに、ロゴと機能カードのプレビューが表示されます。 +#### Guidelines for logos -#### ロゴのガイドライン +You must upload a custom image for the logo. For the badge, choose a background color. -ロゴ用として、カスタム画像をアップロードする必要があります。 バッジには、背景色を選択します。 +- Upload a logo image that is at least 200 pixels x 200 pixels so your logo won't have to be upscaled when your listing is published. +- Logos will be cropped to a square. We recommend uploading a square image file with your logo in the center. +- For best results, upload a logo image with a transparent background. +- To give the appearance of a seamless badge, choose a badge background color that matches the background color (or transparency) of your logo image. +- Avoid using logo images with words or text in them. Logos with text do not scale well on small screens. -- リストを公開するときにアップスケールしなくて済むように、アップロードするロゴ画像は200×200ピクセル以上にしてください。 -- ロゴは正方形にトリミングされます。 ロゴが中央にある正方形の画像ファイルをアップロードすることをお勧めします。 -- 最適な結果を得るには、透明な背景のロゴ画像をアップロードしてください。 -- 継ぎ目がないようにバッジを表示するには、ロゴ画像の背景色 (または透明) と一致する色をバッジの背景として選択します。 -- 単語や文章が含まれるロゴ画像の使用は避けてください。 文字が含まれる画像は、小さい画面で適切に縮小されません。 +#### Guidelines for feature cards -#### 機能カードのガイドライン +You must upload a custom background image for the feature card. For the app's name, choose a text color. -機能カード用として、カスタム背景画像をアップロードする必要があります。 アプリケーションの名前には、文字色を選択します。 +- Use a pattern or texture in your background image to give your card a visual identity and help it stand out against the dark background of the {% data variables.product.prodname_marketplace %} homepage. Feature cards should capture your app's brand personality. +- Background image measures 965 pixels x 482 pixels (width x height). +- Choose a text color for your app's name that shows up clearly over the background image. -- カードを視覚的に区別しやすいように、また{% data variables.product.prodname_marketplace %}ホームページの暗い背景に対して目立つように、背景画像にはパターンまたはテクスチャを使用します。 機能カードには、アプリケーションのブランドの個性を取得する必要があります。 -- 背景画像の大きさは、幅965ピクセル x 高さ482ピクセルです。 -- アプリケーション名の文字色には、背景画像に対してはっきり見える色を選択してください。 +## Listing details -## リストの詳細 +To get to your app's landing page, click your app's name from the {% data variables.product.prodname_marketplace %} homepage or category page. The landing page displays a longer description of the app, which includes two parts: an "Introductory description" and a "Detailed description." -アプリケーションのランディングページにアクセスするには、{% data variables.product.prodname_marketplace %}ホームページまたはカテゴリページからアプリケーションの名前をクリックします。 ランディングページページには、アプリケーションの長い説明が表示されます。説明は「概要説明」と「詳細説明」の2部で構成されています。 +Your "Introductory description" is displayed at the top of your app's {% data variables.product.prodname_marketplace %} landing page. -「概要説明」は、アプリケーションの{% data variables.product.prodname_marketplace %}ランディングページの上部に表示されます。 +![{% data variables.product.prodname_marketplace %} introductory description](/assets/images/marketplace/marketplace_intro_description.png) -![{% data variables.product.prodname_marketplace %}の概要説明](/assets/images/marketplace/marketplace_intro_description.png) +Clicking **Read more...**, displays the "Detailed description." -[**Read more...**] をクリックすると、「詳細説明」が表示されます。 +![{% data variables.product.prodname_marketplace %} detailed description](/assets/images/marketplace/marketplace_detailed_description.png) -![{% data variables.product.prodname_marketplace %}の詳細説明](/assets/images/marketplace/marketplace_detailed_description.png) +Follow these guidelines for writing these descriptions. -説明の記述は、以下のガイドラインに従ってください。 +### Length -### 長さ +We recommend writing a 1-2 sentence high-level summary between 150-250 characters in the required "Introductory description" field when [listing your app](/marketplace/listing-on-github-marketplace/). Although you are allowed to use more characters, concise summaries are easier for customers to read and understand quickly. -[アプリケーションをリストする](/marketplace/listing-on-github-marketplace/)ときの必須の「概要説明」フィールドに、150～250文字の長さで1、2文くらいの概要を記述してください。 それ以上の文字数を使うこともできますが、概要は簡潔なほうが顧客に読みやすく、わかりやすくなります。 +You can add more information in the optional "Detailed description" field. You see this description when you click **Read more...** below the introductory description on your app's landing page. A detailed description consists of 3-5 [value propositions](https://en.wikipedia.org/wiki/Value_proposition), with 1-2 sentences describing each one. You can use up to 1,000 characters for this description. -オプションの「詳細説明」フィールドに情報を追加することもできます。 アプリケーションのランディングページで概要説明の下にある [**Read more...**] をクリックすると、この説明が表示されます。 詳細説明は3～5個の[バリュープロポジション](https://en.wikipedia.org/wiki/Value_proposition)で構成され、それぞれが1、2文の説明です。 この説明には、最大1,000文字まで使用できます。 +### Content -### 内容 +- Always begin introductory descriptions with your app's name. -- 概要説明は、必ずアプリケーション名から始めます。 +- Always write descriptions and value propositions using the active voice. -- 説明とバリュープロポジションは、必ず能動態で書きます。 +### Formatting -### フォーマット +- Always use sentence-case capitalization in value proposition titles. Only capitalize the first letter and proper nouns. -- バリュープロポジションでは、英文字表記は固有名詞に使用し、大文字小文字は常に正しく使ってください。 大文字で始めて英文字表記するのは固有名詞だけです。 +- Use periods in your descriptions. Avoid exclamation marks. -- 説明では句点を使用します。 感嘆符は避けてください。 +- Don't use punctuation at the end of your value proposition titles. Value proposition titles should not include complete sentences, and should not include more than one sentence. -- バリュープロポジションのタイトルの終わりには句読点を付けません。 バリュープロポジションのタイトルを完全文では書かないようにし、複数文は避けてください。 +- For each value proposition, include a title followed by a paragraph of description. Format the title as a [level-three header](/articles/basic-writing-and-formatting-syntax/#headings) using Markdown. For example: -- 各バリュープロポジションには、タイトルとそれに続く説明があります。 タイトルは、Markdownを使用して[レベル3ヘッダ](/articles/basic-writing-and-formatting-syntax/#headings)としてフォーマットします。 例: + ### Learn the skills you need + GitHub Learning Lab can help you learn how to use GitHub, communicate more effectively with Markdown, handle merge conflicts, and more. - ### 必要なスキルを学ぶ +- Only capitalize proper nouns. - GitHub Learning Labでは、GitHubの使い方を学習、Markdownによる効果的な連絡、マージコンフリクトの処理などが可能です。 +- Always use the [serial comma](https://en.wikipedia.org/wiki/Serial_comma) in lists. -- 大文字で始めて英文字表記するのは固有名詞だけです。 +- Avoid referring to the GitHub community as "users." -- 3つ以上の項目を並べるとき、[最後の「および」の前には読点](https://en.wikipedia.org/wiki/Serial_comma)を打ちます。 + **DO:** Create issues automatically for people in your organization -- GitHubコミュニティを「ユーザー」と称するのは避けてください。 + **DON'T:** Create issues automatically for an organization's users - **良い例:** Organizationの人に自動的にIssueを作成する +- Avoid acronyms unless they’re well established (such as API). - **悪い例:** 組織のユーザーについて自動的にIssueを作成する +## Product screenshots -- 略語は一般的な場合 (APIなど) を除いて使用しないでください。 +You can upload up to five screenshot images of your app to display on your app's landing page. Add an optional caption to each screenshot to provide context. After you upload your screenshots, you can drag them into the order you want them to be displayed on the landing page. -## 製品のスクリーンショット +### Guidelines for screenshots -アプリケーションのランディングページで表示されるように、アプリケーションのスクリーンショット画像を5つまでアップロードできます。 スクリーンショットごとに状況がわかるキャプションをオプションとして追加します。 スクリーンショットをアップロードすると、ランディングページに表示したい順序でドラッグできます。 +- Images must be of high resolution (at least 1200px wide). +- All images must be the same height and width (aspect ratio) to avoid page jumps when people click from one image to the next. +- Show as much of the user interface as possible so people can see what your app does. +- When taking screenshots of your app in a browser, only include the content in the display window. Avoid including the address bar, title bar, or toolbar icons, which do not scale well to smaller screen sizes. +- GitHub displays the screenshots you upload in a box on your app's landing page, so you don't need to add boxes or borders around your screenshots. +- Captions are most effective when they are short and snappy. -### スクリーンショットのガイドライン - -- 画像は高解像度 (幅1200px以上) でなければなりません。 -- 画像を次から次へのクリックしたときにページが移動するのを避けるために、すべての画像は高さと幅 (アスペクト比) を等しくする必要があります。 -- アプリケーションの動作が見えるように、ユーザーインターフェースはできるだけ多く表示してください。 -- ブラウザーでアプリケーションのスクリーンショットを取得するときには、ディスプレイウィンドウの内容のみを含めるようにします。 アドレスバー、タイトルバー、ツールバーのアイコンは含めないでください。小さい画面で適切に縮小されません。 -- アップロードしたスクリーンショットは、アプリケーションのランディングページにあるボックスに表示されるので、スクリーンショットの周囲にボックスや枠線は必要ありません。 -- キャプションは、短く簡潔なほうが効果があります。 - -![GitHub Marketplaceのスクリーンショット画像](/assets/images/marketplace/marketplace-screenshots.png) +![GitHub Marketplace screenshot image](/assets/images/marketplace/marketplace-screenshots.png) diff --git a/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md b/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md index 460036f651..e7cd6e457d 100644 --- a/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md +++ b/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md @@ -1,9 +1,9 @@ --- -title: 顧客への課金 -intro: '{% data variables.product.prodname_marketplace %}上のアプリケーションは、GitHubの課金ガイドラインと、推奨サービスのサポートを遵守しなければなりません。 弊社のガイドラインに従うことで、顧客は予想外のことなく支払いプロセスを進んで行きやすくなります。' +title: Billing customers +intro: 'Apps on {% data variables.product.prodname_marketplace %} should adhere to GitHub''s billing guidelines and support recommended services. Following our guidelines helps customers navigate the billing process without any surprises.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace/ - - /apps/marketplace/selling-your-app/billing-customers-in-github-marketplace/ + - /apps/marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace + - /apps/marketplace/selling-your-app/billing-customers-in-github-marketplace - /marketplace/selling-your-app/billing-customers-in-github-marketplace - /developers/github-marketplace/billing-customers versions: @@ -12,39 +12,38 @@ versions: topics: - Marketplace --- +## Understanding the billing cycle -## 支払いを理解する +Customers can choose a monthly or yearly billing cycle when they purchase your app. All changes customers make to the billing cycle and plan selection will trigger a `marketplace_purchase` event. You can refer to the `marketplace_purchase` webhook payload to see which billing cycle a customer selects and when the next billing date begins (`effective_date`). For more information about webhook payloads, see "[Webhook events for the {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/webhook-events-for-the-github-marketplace-api)." -顧客は、アプリケーションの購入時に月次あるいは年次の支払いサイクルを選択できます。 顧客が行う支払いサイクルとプランの選択に対するすべての変更は、`marketplace_purchase`イベントを発生させます。 `marketplace_purchase` webhookのペイロードを参照すれば、顧客がどの支払いサイクルを選択したのか、そして次の支払日がいつ始まるのか（`effective_date`）を知ることができます。 webhookのペイロードに関する情報については、「[{% data variables.product.prodname_marketplace %} APIのwebhookイベント](/developers/github-marketplace/webhook-events-for-the-github-marketplace-api)」を参照してください。 +## Providing billing services in your app's UI -## アプリケーションのUIにおける支払いサービスの提供 - -アプリケーションのWebサイトからは、顧客が以下のアクションを行えなければなりません。 -- 顧客は、個人とOrganizationのアカウントで別々に{% data variables.product.prodname_marketplace %}のプランを変更したり、キャンセルしたりできなければなりません。 +Customers should be able to perform the following actions from your app's website: +- Customers should be able to modify or cancel their {% data variables.product.prodname_marketplace %} plans for personal and organizational accounts separately. {% data reusables.marketplace.marketplace-billing-ui-requirements %} -## アップグレード、ダウングレード、キャンセルのための支払いサービス +## Billing services for upgrades, downgrades, and cancellations -明確で一貫性のある支払いプロセスを保つために、アップグレード、ダウングレード、キャンセルについて以下のガイドラインに従ってください。 {% data variables.product.prodname_marketplace %}の購入イベントに関する詳細な指示については、「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。 +Follow these guidelines for upgrades, downgrades, and cancellations to maintain a clear and consistent billing process. For more detailed instructions about the {% data variables.product.prodname_marketplace %} purchase events, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -`marketplace_purchase` webhookの`effective_date`キーを使えば、プランの変更がいつ生じるのかを確認し、定期的に[プランのアカウントのリスト](/rest/reference/apps#list-accounts-for-a-plan)を同期できます。 +You can use the `marketplace_purchase` webhook's `effective_date` key to determine when a plan change will occur and periodically synchronize the [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan). -### アップグレード +### Upgrades -顧客が価格プランをアップグレードしたり、月次から年次へ支払いサイクルを変更したりした場合、その変更をすぐに有効にしなければなりません。 新しいプランに対して日割引を適用し、支払いサイクルを変更しなければなりません。 +When a customer upgrades their pricing plan or changes their billing cycle from monthly to yearly, you should make the change effective for them immediately. You need to apply a pro-rated discount to the new plan and change the billing cycle. {% data reusables.marketplace.marketplace-failed-purchase-event %} -アプリケーションでのアップグレード及びダウングレードワークフローの構築に関する情報については、「[プラン変更の処理](/developers/github-marketplace/handling-plan-changes)」を参照してください。 +For information about building upgrade and downgrade workflows into your app, see "[Handling plan changes](/developers/github-marketplace/handling-plan-changes)." -### ダウングレードとキャンセル +### Downgrades and cancellations -ダウングレードは、顧客がFreeプランから有料プランに移行し、現在のプランよりも低コストなプランを選択するか、支払いサイクルを年次から月次に変更した場合に生じます。 ダウングレードもしくはキャンセルが生じた場合、返金は必要ありません。 その代わりに、現在のプランは現在の支払いサイクルの最終日まで有効です。 顧客の次の支払いサイクルの開始時点で、新しいプランが有効になると、`marketplace_purchase`イベントが送信されます。 - -顧客がプランをキャンセルした場合、以下を行わなければなりません。 -- Freeプランがある場合には、自動的にFreeプランにダウングレードします。 +Downgrades occur when a customer moves to a free plan from a paid plan, selects a plan with a lower cost than their current plan, or changes their billing cycle from yearly to monthly. When downgrades or cancellations occur, you don't need to provide a refund. Instead, the current plan will remain active until the last day of the current billing cycle. The `marketplace_purchase` event will be sent when the new plan takes effect at the beginning of the customer's next billing cycle. +When a customer cancels a plan, you must: +- Automatically downgrade them to the free plan, if it exists. + {% data reusables.marketplace.cancellation-clarification %} -- 顧客が後でプランを継続したくなった場合には、GitHubを通じてプランをアップグレードできるようにします。 +- Enable them to upgrade the plan through GitHub if they would like to continue the plan at a later time. -アプリケーションでのキャンセルのワークフローの構築に関する情報については、「[プランのキャンセルの処理](/developers/github-marketplace/handling-plan-cancellations)」を参照してください。 +For information about building cancellation workflows into your app, see "[Handling plan cancellations](/developers/github-marketplace/handling-plan-cancellations)." diff --git a/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md b/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md index 0b874880b6..b8325be8fc 100644 --- a/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md +++ b/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md @@ -1,12 +1,12 @@ --- -title: GitHub Marketplaceでのアプリケーションの販売 -intro: 'アプリケーションを{% data variables.product.prodname_marketplace %}販売するための要件とベストプラクティスについて学んでください。' +title: Selling your app on GitHub Marketplace +intro: 'Learn about requirements and best practices for selling your app on {% data variables.product.prodname_marketplace %}.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/ - - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/ - - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/ - - /apps/marketplace/pricing-payments-and-free-trials/ - - /apps/marketplace/selling-your-app/ + - /apps/marketplace/administering-listing-plans-and-user-accounts + - /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing + - /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing + - /apps/marketplace/pricing-payments-and-free-trials + - /apps/marketplace/selling-your-app - /marketplace/selling-your-app versions: fpt: '*' @@ -17,6 +17,6 @@ children: - /pricing-plans-for-github-marketplace-apps - /billing-customers - /receiving-payment-for-app-purchases -shortTitle: Marketplaceでアプリケーションを販売 +shortTitle: Sell apps on the Marketplace --- diff --git a/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md b/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md index 999f345c3d..98d5bcce1c 100644 --- a/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md +++ b/translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md @@ -2,7 +2,7 @@ title: Pricing plans for GitHub Marketplace apps intro: 'Pricing plans allow you to provide your app with different levels of service or resources. You can offer up to 10 pricing plans in your {% data variables.product.prodname_marketplace %} listing.' redirect_from: - - /apps/marketplace/selling-your-app/github-marketplace-pricing-plans/ + - /apps/marketplace/selling-your-app/github-marketplace-pricing-plans - /marketplace/selling-your-app/github-marketplace-pricing-plans - /developers/github-marketplace/pricing-plans-for-github-marketplace-apps versions: diff --git a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md index bc99d680d1..54fb39ac9f 100644 --- a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md +++ b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md @@ -2,9 +2,9 @@ title: Handling new purchases and free trials intro: 'When a customer purchases a paid plan, free trial, or the free version of your {% data variables.product.prodname_marketplace %} app, you''ll receive the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook with the `purchased` action, which kicks off the purchasing flow.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-github-apps/ - - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-oauth-apps/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/ + - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-github-apps + - /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-oauth-apps + - /apps/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials - /marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials - /developers/github-marketplace/handling-new-purchases-and-free-trials versions: diff --git a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md index 68718ade5a..bc5ef37804 100644 --- a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md +++ b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md @@ -1,9 +1,9 @@ --- -title: プランのキャンセルの処理 -intro: '{% data variables.product.prodname_marketplace %}アプリケーションをキャンセルすると、[`marketplace_purchase`イベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhookが`cancelled`アクション付きでトリガされます。これによって、キャンセルのフローが開始されます。' +title: Handling plan cancellations +intro: 'Cancelling a {% data variables.product.prodname_marketplace %} app triggers the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook with the `cancelled` action, which kicks off the cancellation flow.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/cancelling-plans/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/cancelling-plans/ + - /apps/marketplace/administering-listing-plans-and-user-accounts/cancelling-plans + - /apps/marketplace/integrating-with-the-github-marketplace-api/cancelling-plans - /marketplace/integrating-with-the-github-marketplace-api/cancelling-plans - /developers/github-marketplace/handling-plan-cancellations versions: @@ -11,26 +11,25 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: プランのキャンセル +shortTitle: Plan cancellations --- +For more information about cancelling as it relates to billing, see "[Billing customers in {% data variables.product.prodname_marketplace %}](/apps//marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace)." -支払いに関連するキャンセルについての詳しい情報は、「[{% data variables.product.prodname_marketplace %}での顧客の支払い](/apps//marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace)」を参照してください。 +## Step 1. Cancellation event -## ステップ 1. キャンセルイベント +If a customer chooses to cancel a {% data variables.product.prodname_marketplace %} order, GitHub sends a [`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook with the action `cancelled` to your app when the cancellation takes effect. If the customer cancels during a free trial, your app will receive the event immediately. When a customer cancels a paid plan, the cancellation will occur at the end of the customer's billing cycle. -顧客が{% data variables.product.prodname_marketplace %}の注文をキャンセルすることにした場合、GitHubは[`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhookを`cancelled`というアクション付きで、キャンセルが有効になった時点でアプリケーションに送信します。 顧客が無料トライアル中にキャンセルした場合、アプリケーションはすぐにこのイベントを受け取ります。 顧客が有料プランをキャンセルした場合、キャンセルは顧客の支払いサイクルの終了時に行われます。 +## Step 2. Deactivating customer accounts -## ステップ 2. 顧客のアカウントのアクティベーション解除 +When a customer cancels a free or paid plan, your app must perform these steps to complete cancellation: -顧客が無料もしくは有料のプランをキャンセルした場合、アプリケーションはキャンセルを完了するために以下のステップを実行しなければなりません。 - -1. プランをキャンセルした顧客のアカウントのアクティベーションを解除する。 -1. 顧客用にアプリケーションが受け取ったOAuthトークンを取り消す。 -1. アプリケーションがOAuthアプリケーションの場合、リポジトリ用にアプリケーションが作成したすべてのwebhookを削除する。 -1. `cancelled`イベントを受け取ってから30日以内に顧客のすべてのデータを削除する。 +1. Deactivate the account of the customer who cancelled their plan. +1. Revoke the OAuth token your app received for the customer. +1. If your app is an OAuth App, remove all webhooks your app created for repositories. +1. Remove all customer data within 30 days of receiving the `cancelled` event. {% note %} -**ノート:** プランの変更がいつ生じるのかを知るために[`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhookの`effective_date`を利用し、定期的に[プランのリストアカウント](/rest/reference/apps#list-accounts-for-a-plan)を同期することをおすすめします。 webhookに関する詳しい情報については「[{% data variables.product.prodname_marketplace %}のwebhookイベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)」を参照してください。 +**Note:** We recommend using the [`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook's `effective_date` to determine when a plan change will occur and periodically synchronizing the [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan). For more information on webhooks, see "[{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)." {% endnote %} diff --git a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md index 2bb59935a9..34142dbb37 100644 --- a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md +++ b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md @@ -1,9 +1,9 @@ --- -title: プラン変更の処理 -intro: '{% data variables.product.prodname_marketplace %} アプリケーションのアップグレードあるいはダウングレードによって、[`marketplace_purchase` イベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhookが`changed`アクション付きでトリガされ、それによってアップグレードあるいはダウングレードのフローが開始されます。' +title: Handling plan changes +intro: 'Upgrading or downgrading a {% data variables.product.prodname_marketplace %} app triggers the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook with the `changed` action, which kicks off the upgrade or downgrade flow.' redirect_from: - - /apps/marketplace/administering-listing-plans-and-user-accounts/upgrading-or-downgrading-plans/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans/ + - /apps/marketplace/administering-listing-plans-and-user-accounts/upgrading-or-downgrading-plans + - /apps/marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans - /marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans - /developers/github-marketplace/handling-plan-changes versions: @@ -12,55 +12,54 @@ versions: topics: - Marketplace --- +For more information about upgrading and downgrading as it relates to billing, see "[Integrating with the {% data variables.product.prodname_marketplace %} API](/marketplace/integrating-with-the-github-marketplace-api/)." -支払いに関連するアップグレード及びダウングレードに関する詳しい説明については「[{% data variables.product.prodname_marketplace %} APIとのインテグレーション](/marketplace/integrating-with-the-github-marketplace-api/)」を参照してください。 +## Step 1. Pricing plan change event -## ステップ 1. 料金プランの変更イベント +GitHub send the `marketplace_purchase` webhook with the `changed` action to your app, when a customer makes any of these changes to their {% data variables.product.prodname_marketplace %} order: +* Upgrades to a more expensive pricing plan or downgrades to a lower priced plan. +* Adds or removes seats to their existing plan. +* Changes the billing cycle. -顧客が{% data variables.product.prodname_marketplace %}の注文に対して以下のいずれかの変更を行うと、GitHubは`marketplace_purchase` webhookを`changed`アクション付きでアプリケーションに送信します。 -* より高価な価格プランへのアップグレードあるいは低価格なプランへのダウングレード -* 既存のプランへのシートの追加あるいはシートの削除 -* 支払いサイクルの変更 +GitHub will send the webhook when the change takes effect. For example, when a customer downgrades a plan, GitHub sends the webhook at the end of the customer's billing cycle. GitHub sends a webhook to your app immediately when a customer upgrades their plan to allow them access to the new service right away. If a customer switches from a monthly to a yearly billing cycle, it's considered an upgrade. See "[Billing customers in {% data variables.product.prodname_marketplace %}](/marketplace/selling-your-app/billing-customers-in-github-marketplace/)" to learn more about what actions are considered an upgrade or downgrade. -GitHubは、変更が有効になるとwebhookを送信します。 たとえば、顧客がプランをダウングレードすると、その顧客の支払いサイクルの終了時点でwebhookを送信します。 顧客がプランをアップグレードした場合には、新しいサービスをすぐに利用できるようにするため、GitHubは即座にアプリケーションにwebhookを送信します。 顧客が支払いサイクルを月次から年次に切り替えた場合は、アップグレードと見なされます。 どういったアクションがアップグレードやダウングレードと見なされるかを詳しく学ぶには、「[{% data variables.product.prodname_marketplace %}での顧客への課金](/marketplace/selling-your-app/billing-customers-in-github-marketplace/)」を参照してください。 +Read the `effective_date`, `marketplace_purchase`, and `previous_marketplace_purchase` from the `marketplace_purchase` webhook to update the plan's start date and make changes to the customer's billing cycle and pricing plan. See "[{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)" for an example of the `marketplace_purchase` event payload. -プランの開始日を更新し、顧客の支払いサイクルと価格プランを変更するために、`marketplace_purchase`から`effective_date`、`marketplace_purchase`、`previous_marketplace_purchase`を読み取ってください。 `marketplace_purchase`イベントペイロードの例については「[{% data variables.product.prodname_marketplace %} webhookイベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)」を参照してください。 +If your app offers free trials, you'll receive the `marketplace_purchase` webhook with the `changed` action when the free trial expires. If the customer's free trial expires, upgrade the customer to the paid version of the free-trial plan. -アプリケーションが無料トライアルを提供しているなら、無料トライアルの有効期限が切れると`marketplace_purchase` webhookを`changed`アクション付きで受け取ります。 顧客の無料トライアル期間が終了したら、その顧客を無料トライアルプランの有料バージョンにアップグレードしてください。 +## Step 2. Updating customer accounts -## ステップ 2. 顧客アカウントの更新 +You'll need to update the customer's account information to reflect the billing cycle and pricing plan changes the customer made to their {% data variables.product.prodname_marketplace %} order. Display upgrades to the pricing plan, `seat_count` (for per-unit pricing plans), and billing cycle on your Marketplace app's website or your app's UI when you receive the `changed` action webhook. -顧客が{% data variables.product.prodname_marketplace %}の注文に対して行った支払いサイクルや価格プランの変更を反映させるために、顧客のアカウント情報を更新しなければなりません。 `changed`アクションwebhookを受信した際に、MarketplaceアプリケーションのWebサイトか、アプリケーションのUIに、価格プラン、`seat_count`（ユニット単位の価格プランの場合）、支払いサイクルのアップグレードを表示してください。 +When a customer downgrades a plan, it's recommended to review whether a customer has exceeded their plan limits and engage with them directly in your UI or by reaching out to them by phone or email. -顧客がプランをダウングレードした場合には、顧客がプランの制限を超えているかをレビューし、UIで直接関わるか、電話やメールで連絡することをおすすめします。 - -アップグレードを促すために、アップグレードのURLをアプリケーションのUIに表示できます。 詳細については「[アップグレードURLについて](#about-upgrade-urls)」を参照してください。 +To encourage people to upgrade you can display an upgrade URL in your app's UI. See "[About upgrade URLs](#about-upgrade-urls)" for more details. {% note %} -**ノート:** `GET /marketplace_listing/plans/:id/accounts`を使って定期的に同期を行い、それぞれのアカウントに対してアプリケーションが正しいプラン、支払いサイクルの情報、ユニット数（ユニット単位の料金の場合）を保持していることを確認するようおすすめします。 +**Note:** We recommend performing a periodic synchronization using `GET /marketplace_listing/plans/:id/accounts` to ensure your app has the correct plan, billing cycle information, and unit count (for per-unit pricing) for each account. {% endnote %} -## アップグレードの支払いの失敗 +## Failed upgrade payments {% data reusables.marketplace.marketplace-failed-purchase-event %} -## アップグレードURLについて +## About upgrade URLs -アップグレードURLを使い、ユーザをアプリケーションのUIからGitHub上でのアップグレードへリダイレクトできます。 +You can redirect users from your app's UI to upgrade on GitHub using an upgrade URL: ``` https://www.github.com/marketplace//upgrade// ``` -たとえば、顧客が5人のプランを使っていて、10人のプランに移行する必要があることに気づいた場合、アプリケーションのUIに「アップグレードの方法はこちら」というボタンを表示したり、アップグレードURLへのリンクを持つバナーを表示したりできます。 アップグレードURLは顧客をリストされたプランのアップグレードの確認ページへ移動させます。 +For example, if you notice that a customer is on a 5 person plan and needs to move to a 10 person plan, you could display a button in your app's UI that says "Here's how to upgrade" or show a banner with a link to the upgrade URL. The upgrade URL takes the customer to your listing plan's upgrade confirmation page. -顧客が購入したいであろうプランの`LISTING_PLAN_NUMBER`を使ってください。 新しい価格プランを作成すると、それらにはリスト内で各プランに対してユニークな`LISTING_PLAN_NUMBER`と、{% data variables.product.prodname_marketplace %}内で各プランに対してユニークな`LISTING_PLAN_ID`が与えられます。 [プランをリスト](/rest/reference/apps#list-plans)する際にはこれらの番号があり、リストの価格プランを特定できます。 `LISTING_PLAN_ID`と「[プランに対するアカウントのリスト](/rest/reference/apps#list-accounts-for-a-plan)」エンドポイントを使って、`CUSTOMER_ACCOUNT_ID`を取得してください。 +Use the `LISTING_PLAN_NUMBER` for the plan the customer would like to purchase. When you create new pricing plans they receive a `LISTING_PLAN_NUMBER`, which is unique to each plan across your listing, and a `LISTING_PLAN_ID`, which is unique to each plan in the {% data variables.product.prodname_marketplace %}. You can find these numbers when you [List plans](/rest/reference/apps#list-plans), which identifies your listing's pricing plans. Use the `LISTING_PLAN_ID` and the "[List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan)" endpoint to get the `CUSTOMER_ACCOUNT_ID`. {% note %} -**ノート:** 顧客が追加ユニット（シートなど）のアップグレードをした場合でも、顧客に購入に対する適切なプランを送信することはできますが、その時点で弊社は`unit_count`パラメータをサポートできません。 +**Note:** If your customer upgrades to additional units (such as seats), you can still send them to the appropriate plan for their purchase, but we are unable to support `unit_count` parameters at this time. {% endnote %} diff --git a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md index 86256e65d9..074d42544b 100644 --- a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md +++ b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md @@ -1,9 +1,9 @@ --- -title: アプリケーション内でのGitHub marketplace APIの使用 -intro: '{% data variables.product.prodname_marketplace %}用に、アプリケーションに{% data variables.product.prodname_marketplace %} APIとwebhookイベントを統合する方法を学んでください。' +title: Using the GitHub Marketplace API in your app +intro: 'Learn how to integrate the {% data variables.product.prodname_marketplace %} API and webhook events into your app for the {% data variables.product.prodname_marketplace %} .' redirect_from: - - /apps/marketplace/setting-up-github-marketplace-webhooks/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/ + - /apps/marketplace/setting-up-github-marketplace-webhooks + - /apps/marketplace/integrating-with-the-github-marketplace-api - /marketplace/integrating-with-the-github-marketplace-api versions: fpt: '*' @@ -17,6 +17,6 @@ children: - /handling-new-purchases-and-free-trials - /handling-plan-changes - /handling-plan-cancellations -shortTitle: Marketplace APIの使い方 +shortTitle: Marketplace API usage --- diff --git a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md index fa78b632e0..8a02a458a7 100644 --- a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md +++ b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md @@ -1,9 +1,9 @@ --- -title: GItHub Marketplace API用のRESTエンドポイント -intro: '{% data variables.product.prodname_marketplace %}上でのアプリケーションの管理を支援するために、以下の{% data variables.product.prodname_marketplace %} APIエンドポイントを使ってください。' +title: REST endpoints for the GitHub Marketplace API +intro: 'To help manage your app on {% data variables.product.prodname_marketplace %}, use these {% data variables.product.prodname_marketplace %} API endpoints.' redirect_from: - - /apps/marketplace/github-marketplace-api-endpoints/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints/ + - /apps/marketplace/github-marketplace-api-endpoints + - /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints - /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints - /developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api versions: @@ -13,21 +13,20 @@ topics: - Marketplace shortTitle: REST API --- +Here are some useful endpoints available for Marketplace listings: -以下は、Marketplaceのリストで利用できる便利なエンドポイントです。 +* [List plans](/rest/reference/apps#list-plans) +* [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan) +* [Get a subscription plan for an account](/rest/reference/apps#get-a-subscription-plan-for-an-account) +* [List subscriptions for the authenticated user](/rest/reference/apps#list-subscriptions-for-the-authenticated-user) -* [プランのリスト](/rest/reference/apps#list-plans) -* [プランのアカウントのリスト](/rest/reference/apps#list-accounts-for-a-plan) -* [アカウントのサブスクリプションプランの取得](/rest/reference/apps#get-a-subscription-plan-for-an-account) -* [認証されたユーザのサブスクリプションのリスト](/rest/reference/apps#list-subscriptions-for-the-authenticated-user) +See these pages for details on how to authenticate when using the {% data variables.product.prodname_marketplace %} API: -{% data variables.product.prodname_marketplace %} APIを使用する際の認証の受け方の詳細については、以下のページを参照してください。 - -* [OAuth Appの認可オプション](/apps/building-oauth-apps/authorizing-oauth-apps/) -* [GitHub Appの認可オプション](/apps/building-github-apps/authenticating-with-github-apps/) +* [Authorization options for OAuth Apps](/apps/building-oauth-apps/authorizing-oauth-apps/) +* [Authentication options for GitHub Apps](/apps/building-github-apps/authenticating-with-github-apps/) {% note %} -**ノート:** [REST APIのためのレート制限](/rest#rate-limiting)は、{% data variables.product.prodname_marketplace %} APIのすべてのエンドポイントに適用されます。 +**Note:** [Rate limits for the REST API](/rest#rate-limiting) apply to all {% data variables.product.prodname_marketplace %} API endpoints. {% endnote %} diff --git a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md index 990d35ec9f..537d8fe792 100644 --- a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md +++ b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md @@ -1,9 +1,9 @@ --- -title: アプリをテストする -intro: 'リストを{% data variables.product.prodname_marketplace %}にサブミットする前に、APIとwebhookを使ってアプリケーションをテストし、顧客に理想的な体験を提供できるようにすることをGitHubはおすすめします。 オンボーディングの専門家の検証前に、アプリケーションは支払いフローを適切に処理しなければなりません。' +title: Testing your app +intro: 'GitHub recommends testing your app with APIs and webhooks before submitting your listing to {% data variables.product.prodname_marketplace %} so you can provide an ideal experience for customers. Before an onboarding expert approves your app, it must adequately handle the billing flows.' redirect_from: - - /apps/marketplace/testing-apps-apis-and-webhooks/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/ + - /apps/marketplace/testing-apps-apis-and-webhooks + - /apps/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps - /marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps - /developers/github-marketplace/testing-your-app versions: @@ -12,35 +12,34 @@ versions: topics: - Marketplace --- +## Testing apps -## アプリケーションのテスト +You can use a draft {% data variables.product.prodname_marketplace %} listing to simulate each of the billing flows. A listing in the draft state means that it has not been submitted for approval. Any purchases you make using a draft {% data variables.product.prodname_marketplace %} listing will _not_ create real transactions, and GitHub will not charge your credit card. Note that you can only simulate purchases for plans published in the draft listing and not for draft plans. For more information, see "[Drafting a listing for your app](/developers/github-marketplace/drafting-a-listing-for-your-app)" and "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)." -ドラフトの{% data variables.product.prodname_marketplace %}リストを使って、それぞれの支払いフローをシミュレートできます。 リストがドラフト状態にあるということは、まだそれが承認のためにサブミットされていないということです。 ドラフトの{% data variables.product.prodname_marketplace %}リストを使って行った購入は、実際の取引には_ならず_、GitHubはクレジットカードへの課金をしません。 シミュレートできるのはドラフトのリストに掲載されているプランの購入のみであり、ドラフトのプラン購入はシミュレートできません。 詳細な情報については、「[アプリケーションのリストのドラフト](/developers/github-marketplace/drafting-a-listing-for-your-app)」及び「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。 +### Using a development app with a draft listing to test changes -### 変更のテストのために開発アプリケーションをドラフトリストと使用する +A {% data variables.product.prodname_marketplace %} listing can only be associated with a single app registration, and each app can only access its own {% data variables.product.prodname_marketplace %} listing. For these reasons, we recommend configuring a separate development app, with the same configuration as your production app, and creating a _draft_ {% data variables.product.prodname_marketplace %} listing that you can use for testing. The draft {% data variables.product.prodname_marketplace %} listing allows you to test changes without affecting the active users of your production app. You will never have to submit your development {% data variables.product.prodname_marketplace %} listing, since you will only use it for testing. -{% data variables.product.prodname_marketplace %}リストは、1つのアプリケーションの登録とのみ関連づけることができ、それぞれのアプリケーションは自身の{% data variables.product.prodname_marketplace %}リストにのみアクセスできます。 そのため、プロダクションのアプリケーションと同じ設定で別個の開発アプリケーションを設定し、テストに使用できる_ドラフト_の{% data variables.product.prodname_marketplace %}リストを作成することをおすすめします。 ドラフトの{% data variables.product.prodname_marketplace %}リストを使えば、プロダクションのアプリケーションのアクティブなユーザに影響することなく変更をテストできます。 開発の{% data variables.product.prodname_marketplace %}リストはテストにのみ使われるので、サブミットする必要はありません。 +Because you can only create draft {% data variables.product.prodname_marketplace %} listings for public apps, you must make your development app public. Public apps are not discoverable outside of published {% data variables.product.prodname_marketplace %} listings as long as you don't share the app's URL. A Marketplace listing in the draft state is only visible to the app's owner. -ドラフトの{% data variables.product.prodname_marketplace %}リストは公開アプリケーションに対してのみ作成できるので、開発アプリケーションは公開しなければなりません。 公開アプリケーションは、アプリケーションのURLを共有しないかぎり、公開された{% data variables.product.prodname_marketplace %}リスト外で見つかることはありません。 ドラフト状態のMarketplaceリストは、アプリケーションの所有者にしか見えません。 - -ドラフトリストと共に開発アプリケーションができたら、{% data variables.product.prodname_marketplace %} APIやwebhookと統合しながらそれを使ってアプリケーションの変更をテストできます。 +Once you have a development app with a draft listing, you can use it to test changes you make to your app while integrating with the {% data variables.product.prodname_marketplace %} API and webhooks. {% warning %} -{% data variables.product.prodname_marketplace %}で公開されているアプリケーションでは、購入のテストを行わないでください。 +Do not make test purchases with an app that is live in {% data variables.product.prodname_marketplace %}. {% endwarning %} -### Marketplaceの購入イベントのシミュレーション +### Simulating Marketplace purchase events -テストのシナリオでは、無料トライアルを提供するリストプランをセットアップし、無料と有料のサブスクリプション間の切り替えが必要になるかもしれません。 ダウングレードやキャンセルは、次回の支払いサイクルまでは有効にならないので、GitHubは開発者のみの機能として、`changed`及び`cancelled`のプランアクションを強制的にすぐに有効にする「保留中の変更の適用」機能を提供しています。 _ドラフト_Marketplaceリストのアプリケーションのための**保留中の変更の適用**には、https://github.com/settings/billing#pending-cycleでアクセスできます。 +Your testing scenarios may require setting up listing plans that offer free trials and switching between free and paid subscriptions. Because downgrades and cancellations don't take effect until the next billing cycle, GitHub provides a developer-only feature to "Apply Pending Change" to force `changed` and `cancelled` plan actions to take effect immediately. You can access **Apply Pending Change** for apps with _draft_ Marketplace listings in https://github.com/settings/billing#pending-cycle: -![保留中の変更の適用](/assets/images/github-apps/github-apps-apply-pending-changes.png) +![Apply pending change](/assets/images/github-apps/github-apps-apply-pending-changes.png) -## APIのテスト +## Testing APIs -ほとんどの{% data variables.product.prodname_marketplace %} APIエンドポイントに対しては、テストに利用できるハードコーディングされた偽のデータを返すスタブのAPIエンドポイントも提供されています。 スタブのデータを受信するには、ルートに`/stubbed`を含むスタブURL（たとえば`/user/marketplace_purchases/stubbed`）を指定してください。 スタブデータのアプローチをサポートしているエンドポイントのリストは、[{% data variables.product.prodname_marketplace %}エンドポイント](/rest/reference/apps#github-marketplace)を参照してください。 +For most {% data variables.product.prodname_marketplace %} API endpoints, we also provide stubbed API endpoints that return hard-coded, fake data you can use for testing. To receive stubbed data, you must specify stubbed URLs, which include `/stubbed` in the route (for example, `/user/marketplace_purchases/stubbed`). For a list of endpoints that support this stubbed-data approach, see [{% data variables.product.prodname_marketplace %} endpoints](/rest/reference/apps#github-marketplace). -## webhookのテスト +## Testing webhooks -GitHubは、デプロイされたペイロードをテストするためのツールを提供しています。 詳しい情報については「[webhookのテスト](/webhooks/testing/)」を参照してください。 +GitHub provides tools for testing your deployed payloads. For more information, see "[Testing webhooks](/webhooks/testing/)." diff --git a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md index 6ff6d216e7..eb0ffba0ac 100644 --- a/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md +++ b/translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md @@ -1,9 +1,9 @@ --- -title: GitHub Marketplace APIのためのwebhookイベント -intro: '{% data variables.product.prodname_marketplace %}アプリケーションは、ユーザのプランに対する変更に関する情報を、Marketplaceの購入イベントwebhookから受け取ります。 Marketplaceの購入イベントは、ユーザが支払いプランの購入、キャンセル、変更をした場合にトリガーされます。' +title: Webhook events for the GitHub Marketplace API +intro: 'A {% data variables.product.prodname_marketplace %} app receives information about changes to a user''s plan from the Marketplace purchase event webhook. A Marketplace purchase event is triggered when a user purchases, cancels, or changes their payment plan.' redirect_from: - - /apps/marketplace/setting-up-github-marketplace-webhooks/about-webhook-payloads-for-a-github-marketplace-listing/ - - /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/ + - /apps/marketplace/setting-up-github-marketplace-webhooks/about-webhook-payloads-for-a-github-marketplace-listing + - /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events - /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events - /developers/github-marketplace/webhook-events-for-the-github-marketplace-api versions: @@ -11,66 +11,65 @@ versions: ghec: '*' topics: - Marketplace -shortTitle: webhook イベント +shortTitle: Webhook events --- +## {% data variables.product.prodname_marketplace %} purchase webhook payload -## {% data variables.product.prodname_marketplace %}購入webhookのペイロード +Webhooks `POST` requests have special headers. See "[Webhook delivery headers](/webhooks/event-payloads/#delivery-headers)" for more details. GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub. -webhookの`POST`リクエストには、特別なヘッダがあります。 詳細については「[webhookの配信ヘッダ](/webhooks/event-payloads/#delivery-headers)」を参照してください。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。 - -キャンセル及びダウングレードは、次の支払いサイクルの初日に有効になります。 ダウングレードとキャンセルのイベントは、次の支払いサイクルの開始時に新しいプランが有効になったときに送信されます。 新規の購入とアップグレードのイベントは、すぐに開始されます。 変更がいつ始まるかを判断するには、webhookのペイロード中の`effective_date`を使ってください。 +Cancellations and downgrades take effect on the first day of the next billing cycle. Events for downgrades and cancellations are sent when the new plan takes effect at the beginning of the next billing cycle. Events for new purchases and upgrades begin immediately. Use the `effective_date` in the webhook payload to determine when a change will begin. {% data reusables.marketplace.marketplace-malicious-behavior %} -それぞれの`marketplace_purchase` webhookのペイロードは、以下の情報を持ちます。 +Each `marketplace_purchase` webhook payload will have the following information: -| キー | 種類 | 説明 | -| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `action` | `string` | webhookを生成するために行われたアクション。 `purchased`、`cancelled`、`pending_change`、`pending_change_cancelled`、`changed`のいずれかになります。 詳しい情報については、以下のwebhookペイロードの例を参照してください。 **ノート:** `pending_change`及び`pending_change_cancelled`ペイロードには、[`changed`ペイロードの例](#example-webhook-payload-for-a-changed-event)に示されているものと同じキーが含まれます。 | -| `effective_date` | `string` | `action`が有効になる日付。 | -| `sender` | `オブジェクト` | webhookをトリガーした`action`を行った人。 | -| `marketplace_purchase` | `オブジェクト` | {% data variables.product.prodname_marketplace %}の購入情報。 | +Key | Type | Description +----|------|------------- +`action` | `string` | The action performed to generate the webhook. Can be `purchased`, `cancelled`, `pending_change`, `pending_change_cancelled`, or `changed`. For more information, see the example webhook payloads below. **Note:** The `pending_change` and `pending_change_cancelled` payloads contain the same keys as shown in the [`changed` payload example](#example-webhook-payload-for-a-changed-event). +`effective_date` | `string` | The date the `action` becomes effective. +`sender` | `object` | The person who took the `action` that triggered the webhook. +`marketplace_purchase` | `object` | The {% data variables.product.prodname_marketplace %} purchase information. -`marketplace_purchase`オブジェクトは、以下のキーを持ちます。 +The `marketplace_purchase` object has the following keys: -| キー | 種類 | 説明 | -| -------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `アカウント` | `オブジェクト` | サブスクリプションに関連づけられた`organization`もしくあは`user`アカウント。 Organizationアカウントは、そのOrganizationの管理者のメールアドレスである`organization_billing_email`を含みます。 個人アカウントのメールアドレスを知るには、[認証されたユーザの取得](/rest/reference/users#get-the-authenticated-user)エンドポイントが利用できます。 | -| `billing_cycle` | `string` | `yearly`もしくは`monthly`のいずれかになります。 `account`の所有者が無料のGitHubのプランを使っており、無料の{% data variables.product.prodname_marketplace %}プランを購入した場合、`billing_cycle`は`nil`になります。 | -| `unit_count` | `integer` | 購入したユーザ数。 | -| `on_free_trial` | `boolean` | `account`が無料トライアル中の場合`true`になります。 | -| `free_trial_ends_on` | `string` | 無料トライアルが期限切れになる日付。 | -| `next_billing_date` | `string` | 次の支払いサイクルが始まる日付。 `account`の所有者が無料のGitHub.comのプランを使っており、無料の{% data variables.product.prodname_marketplace %}プランを購入した場合、`next_billing_date`は`nil`になります。 | -| `plan` | `オブジェクト` | `user`または`organization`が購入したプラン。 | +Key | Type | Description +----|------|------------- +`account` | `object` | The `organization` or `user` account associated with the subscription. Organization accounts will include `organization_billing_email`, which is the organization's administrative email address. To find email addresses for personal accounts, you can use the [Get the authenticated user](/rest/reference/users#get-the-authenticated-user) endpoint. +`billing_cycle` | `string` | Can be `yearly` or `monthly`. When the `account` owner has a free GitHub plan and has purchased a free {% data variables.product.prodname_marketplace %} plan, `billing_cycle` will be `nil`. +`unit_count` | `integer` | Number of units purchased. +`on_free_trial` | `boolean` | `true` when the `account` is on a free trial. +`free_trial_ends_on` | `string` | The date the free trial will expire. +`next_billing_date` | `string` | The date that the next billing cycle will start. When the `account` owner has a free GitHub.com plan and has purchased a free {% data variables.product.prodname_marketplace %} plan, `next_billing_date` will be `nil`. +`plan` | `object` | The plan purchased by the `user` or `organization`. -`plan`オブジェクトには以下のキーがあります。 +The `plan` object has the following keys: -| キー | 種類 | 説明 | -| ------------------------ | ------------------ | ------------------------------------------------------ | -| `id` | `integer` | このプランの一意の識別子。 | -| `name` | `string` | プラン名。 | -| `説明` | `string` | プランの説明。 | -| `monthly_price_in_cents` | `integer` | このプランのセント (米国の通貨) 単位の月額。 たとえば、月額10米ドルのリストは1000セントです。 | -| `yearly_price_in_cents` | `integer` | このプランのセント (米国の通貨) 単位の年額。 たとえば、月額100米ドルのリストは10000セントです。 | -| `price_model` | `string` | このリストの価格モデル。 `flat-rate`、`per-unit`、`free`のいずれかです。 | -| `has_free_trial` | `boolean` | このリストが無料トライアルを提供する場合は`true`になります。 | -| `unit_name` | `string` | ユニットの名前。 価格モデルが`per-unit`でない場合、これは`nil`になります。 | -| `bullet` | `array of strings` | 価格プランに設定されている箇条書きの名前。 | +Key | Type | Description +----|------|------------- +`id` | `integer` | The unique identifier for this plan. +`name` | `string` | The plan's name. +`description` | `string` | This plan's description. +`monthly_price_in_cents` | `integer` | The monthly price of this plan in cents (US currency). For example, a listing that costs 10 US dollars per month will be 1000 cents. +`yearly_price_in_cents` | `integer` | The yearly price of this plan in cents (US currency). For example, a listing that costs 100 US dollars per month will be 10000 cents. +`price_model` | `string` | The pricing model for this listing. Can be one of `flat-rate`, `per-unit`, or `free`. +`has_free_trial` | `boolean` | `true` when this listing offers a free trial. +`unit_name` | `string` | The name of the unit. If the pricing model is not `per-unit` this will be `nil`. +`bullet` | `array of strings` | The names of the bullets set in the pricing plan.
-### `purchased`イベントのサンプルwebhookペイロード -次の例は、`purchased`イベントのペイロードを示しています。 +### Example webhook payload for a `purchased` event +This example provides the `purchased` event payload. {{ webhookPayloadsForCurrentVersion.marketplace_purchase.purchased }} -### `changed`イベントのサンプルwebhookペイロード +### Example webhook payload for a `changed` event -プランの変更には、アップグレードとダウンロードがあります。 この例は、`changed`、`pending_change`、および`pending_change_cancelled`イベントのペイロードを表しています。 このアクションは、これら3つのイベントのうちどれが発生したかを示します。 +Changes in a plan include upgrades and downgrades. This example represents the `changed`,`pending_change`, and `pending_change_cancelled` event payloads. The action identifies which of these three events has occurred. {{ webhookPayloadsForCurrentVersion.marketplace_purchase.changed }} -### `cancelled`イベントのサンプルwebhookペイロード +### Example webhook payload for a `cancelled` event {{ webhookPayloadsForCurrentVersion.marketplace_purchase.cancelled }} diff --git a/translations/ja-JP/content/developers/overview/managing-deploy-keys.md b/translations/ja-JP/content/developers/overview/managing-deploy-keys.md index b651619a2c..6d51247d42 100644 --- a/translations/ja-JP/content/developers/overview/managing-deploy-keys.md +++ b/translations/ja-JP/content/developers/overview/managing-deploy-keys.md @@ -2,7 +2,7 @@ title: Managing deploy keys intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you. redirect_from: - - /guides/managing-deploy-keys/ + - /guides/managing-deploy-keys - /v3/guides/managing-deploy-keys versions: fpt: '*' diff --git a/translations/ja-JP/content/developers/overview/replacing-github-services.md b/translations/ja-JP/content/developers/overview/replacing-github-services.md index c9e8488379..7e39883b4a 100644 --- a/translations/ja-JP/content/developers/overview/replacing-github-services.md +++ b/translations/ja-JP/content/developers/overview/replacing-github-services.md @@ -1,9 +1,9 @@ --- -title: GitHub Servicesの置き換え -intro: '非推奨となった{% data variables.product.prodname_dotcom %} Servicesにまだ依存しているなら、サービスフックをwebhookに移行する方法を学んでください。' +title: Replacing GitHub Services +intro: 'If you''re still relying on the deprecated {% data variables.product.prodname_dotcom %} Services, learn how to migrate your service hooks to webhooks.' redirect_from: - - /guides/replacing-github-services/ - - /v3/guides/automating-deployments-to-integrators/ + - /guides/replacing-github-services + - /v3/guides/automating-deployments-to-integrators - /v3/guides/replacing-github-services versions: fpt: '*' @@ -14,61 +14,61 @@ topics: --- -GitHub Servicesは、webhookとの統合を進めるために非推奨となりました。 このガイドは、GitHub Servicesからwebhookへの移行を支援します。 このアナウンスに関する詳細については、[ブログポスト](https://developer.github.com/changes/2018-10-01-denying-new-github-services)を参照してください。 +We have deprecated GitHub Services in favor of integrating with webhooks. This guide helps you transition to webhooks from GitHub Services. For more information on this announcement, see the [blog post](https://developer.github.com/changes/2018-10-01-denying-new-github-services). {% note %} -メールサービスに代わるものとして、リポジトリへのプッシュに対するメール通知を利用しはじめられるようになりました。 コミットメール通知の設定方法については、「[リポジトリへのプッシュに対するメール通知について](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)」を参照してください。 +As an alternative to the email service, you can now start using email notifications for pushes to your repository. See "[About email notifications for pushes to your repository](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)" to learn how to configure commit email notifications. {% endnote %} -## 非推奨のタイムライン +## Deprecation timeline -- **2018年10月1日**: GitHubはユーザがサービスをインストールするのを禁止しました。 GitHub.comのユーザインターフェースから、GitHub Servicesを削除しました。 -- **2019年1月29日**: メールサービスの代替として、リポジトリへのプッシュに対するメール通知を使い始められるようになりました。 コミットメール通知の設定方法については、「[リポジトリへのプッシュに対するメール通知について](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)」を参照してください。 -- **2019年1月31日**: GitHubはGitHub.com上でのインストールされたサービスのイベント配信を停止しました。 +- **October 1, 2018**: GitHub discontinued allowing users to install services. We removed GitHub Services from the GitHub.com user interface. +- **January 29, 2019**: As an alternative to the email service, you can now start using email notifications for pushes to your repository. See "[About email notifications for pushes to your repository](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)" to learn how to configure commit email notifications. +- **January 31, 2019**: GitHub will stop delivering installed services' events on GitHub.com. -## GitHub Servicesの背景 +## GitHub Services background -GitHub Services（Service Hooksと呼ばれることもあります）は、インテグレーションの旧来の方法であり、GitHubがインテグレーターのサービスの一部を[`github-services`リポジトリ](https://github.com/github/github-services)を通じてホストします。 GitHub上で行われたアクションがこれらのサービスをトリガーし、これらのサービスを使ってGitHubの外部のアクションをトリガーできます。 +GitHub Services (sometimes referred to as Service Hooks) is the legacy method of integrating where GitHub hosted a portion of our integrator’s services via [the `github-services` repository](https://github.com/github/github-services). Actions performed on GitHub trigger these services, and you can use these services to trigger actions outside of GitHub. {% ifversion ghes or ghae %} -## GitHub Servicesを使っているリポジトリを探す -アプライアンス上でどのリポジトリがGitHub Servicesを使っているかを特定するためのコマンドラインスクリプトが提供されています。 詳しい情報については[ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report)を参照してください。{% endif %} +## Finding repositories that use GitHub Services +We provide a command-line script that helps you identify which repositories on your appliance use GitHub Services. For more information, see [ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report).{% endif %} -## GitHub Servicesとwebhook +## GitHub Services vs. webhooks -GitHub Servicesとwebhookとの主な違いは以下のとおりです。 -- **設定**: GitHub Servicesにはサービス固有の設定オプションがありますが、webhookはURLとイベント群を指定するだけで単純に設定できます。 -- **カスタムロジック**: GitHub Servicesは1つのイベントの処理の一部として、複数のアクションで反応するカスタムロジックを持つことができますが、webhookにはカスタムロジックはありません。 -- **リクエストの種類**: GitHub ServicesはHTTP及び非HTTPリクエストを発行できますが、webhookが発行できるのはHTTPリクエストのみです。 +The key differences between GitHub Services and webhooks: +- **Configuration**: GitHub Services have service-specific configuration options, while webhooks are simply configured by specifying a URL and a set of events. +- **Custom logic**: GitHub Services can have custom logic to respond with multiple actions as part of processing a single event, while webhooks have no custom logic. +- **Types of requests**: GitHub Services can make HTTP and non-HTTP requests, while webhooks can make HTTP requests only. -## webhookでのServicesの置き換え +## Replacing Services with webhooks -GitHub Servicesをwebhookで置き換えるには、以下のようにします。 +To replace GitHub Services with Webhooks: -1. [このリスト](/webhooks/#events)から、サブスクライブする必要がある関連webhookイベントを特定してください。 +1. Identify the relevant webhook events you’ll need to subscribe to from [this list](/webhooks/#events). -2. GitHub Servicesを現在使っている方法に応じて、設定を変更してください。 +2. Change your configuration depending on how you currently use GitHub Services: - - **GitHub Apps**: アプリケーションの権限とサブスクライブしているイベントを更新し、関連するwebhookイベントを受信するようにアプリケーションを設定してください。 - - **OAuth Apps**: `repo_hook`や`org_hook`スコープをリクエストして、ユーザの代わりに関連するイベントを管理してください。 - - **GitHub Serviceプロバイダー**: ユーザが手動で、送信された関連するイベントとあわせてwebhookを設定するように要求するか、この機会にこの機能を管理するアプリケーションを構築してください。 詳しい情報については「[アプリケーションについて](/apps/about-apps/)」を参照してください。 + - **GitHub Apps**: Update your app's permissions and subscribed events to configure your app to receive the relevant webhook events. + - **OAuth Apps**: Request either the `repo_hook` and/or `org_hook` scope(s) to manage the relevant events on behalf of users. + - **GitHub Service providers**: Request that users manually configure a webhook with the relevant events sent to you, or take this opportunity to build an app to manage this functionality. For more information, see "[About apps](/apps/about-apps/)." -3. GitHubの外部から、追加の設定を移動してください。 GitHub Servicesの中には、GitHub内の設定ページで追加のカスタム設定が必要になるものがあります。 使っているサービスがそうなら、この機能をアプリケーションに移すか、可能な場合はGitHub AppもしくはOAuth Appに依存する必要があります。 +3. Move additional configuration from outside of GitHub. Some GitHub Services require additional, custom configuration on the configuration page within GitHub. If your service does this, you will need to move this functionality into your application or rely on GitHub or OAuth Apps where applicable. -## {% data variables.product.prodname_ghe_server %}のサポート +## Supporting {% data variables.product.prodname_ghe_server %} -- **{% data variables.product.prodname_ghe_server %} 2.17**: {% data variables.product.prodname_ghe_server %} リリース2.17以降では、管理者がサービスをインストールできなくなります。 {% data variables.product.prodname_ghe_server %}リリース2.17から2.19では、管理者は引き続き既存のサービスフックを変更し、サービスフックを受信できます。 {% data variables.product.prodname_ghe_server %} 2.17以降では、メールサービスの代替としてリポジトリへのプッシュに対するメール通知が使えます。 詳細については[このブログポスト](https://developer.github.com/changes/2019-01-29-life-after-github-services)を参照してください。 -- **{% data variables.product.prodname_ghe_server %} 2.20**: {% data variables.product.prodname_ghe_server %}リリース2.20以降では、インストールされたすべてのサービスイベントの配信が停止されます。 +- **{% data variables.product.prodname_ghe_server %} 2.17**: {% data variables.product.prodname_ghe_server %} release 2.17 and higher will discontinue allowing admins to install services. Admins will continue to be able to modify existing service hooks and receive service hooks in {% data variables.product.prodname_ghe_server %} release 2.17 through 2.19. As an alternative to the email service, you will be able to use email notifications for pushes to your repository in {% data variables.product.prodname_ghe_server %} 2.17 and higher. See [this blog post](https://developer.github.com/changes/2019-01-29-life-after-github-services) to learn more. +- **{% data variables.product.prodname_ghe_server %} 2.20**: {% data variables.product.prodname_ghe_server %} release 2.20 and higher will stop delivering all installed services' events. -{% data variables.product.prodname_ghe_server %} 2.17リリースは、管理者がGitHub Servicesをインストールできない最初のリリースになります。 既存のGitHub Servicesは、{% data variables.product.prodname_ghe_server %} 2.20リリースまでしかサポートされません。 また、2019年10月1日まで{% data variables.product.prodname_ghe_server %}上で動作しているGitHub Serviceに対する重要なパッチを受け付けます。 +The {% data variables.product.prodname_ghe_server %} 2.17 release will be the first release that does not allow admins to install GitHub Services. We will only support existing GitHub Services until the {% data variables.product.prodname_ghe_server %} 2.20 release. We will also accept any critical patches for your GitHub Service running on {% data variables.product.prodname_ghe_server %} until October 1, 2019. -## 弊社の支援を受けての移行 +## Migrating with our help -質問があれば、[お問い合わせ](https://github.com/contact?form%5Bsubject%5D=GitHub+Services+Deprecation)ください。 +Please [contact us](https://github.com/contact?form%5Bsubject%5D=GitHub+Services+Deprecation) with any questions. -高レベルの概要としては、移行のプロセスは通常以下を含みます。 - - 製品がどこでどのようにGitHub Servicesを使っているかの特定。 - - 通常のwebhookに移行するために設定する必要がある、対応するwebhookイベントの特定。 - - [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/)または[{% data variables.product.prodname_github_apps %}のいずれかを利用して設計を実装。 {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/)の方が望ましいです。 {% data variables.product.prodname_github_apps %}が望ましい理由の詳細を学ぶには、「[{% data variables.product.prodname_github_apps %}に切り替える理由](/apps/migrating-oauth-apps-to-github-apps/#reasons-for-switching-to-github-apps)」を参照してください。 +As a high-level overview, the process of migration typically involves: + - Identifying how and where your product is using GitHub Services. + - Identifying the corresponding webhook events you need to configure in order to move to plain webhooks. + - Implementing the design using either [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/) or [{% data variables.product.prodname_github_apps %}. {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) are preferred. To learn more about why {% data variables.product.prodname_github_apps %} are preferred, see "[Reasons for switching to {% data variables.product.prodname_github_apps %}](/apps/migrating-oauth-apps-to-github-apps/#reasons-for-switching-to-github-apps)." diff --git a/translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md b/translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md index a67ec00631..c1967ee2cc 100644 --- a/translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md +++ b/translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md @@ -3,7 +3,7 @@ title: Secret scanning partner program intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' miniTocMaxHeadingLevel: 3 redirect_from: - - /partnerships/token-scanning/ + - /partnerships/token-scanning - /partnerships/secret-scanning - /developers/overview/secret-scanning versions: diff --git a/translations/ja-JP/content/developers/overview/using-ssh-agent-forwarding.md b/translations/ja-JP/content/developers/overview/using-ssh-agent-forwarding.md index 540fcd3b00..1a5c54cd28 100644 --- a/translations/ja-JP/content/developers/overview/using-ssh-agent-forwarding.md +++ b/translations/ja-JP/content/developers/overview/using-ssh-agent-forwarding.md @@ -1,8 +1,8 @@ --- -title: SSHエージェント転送の利用 -intro: サーバーへのデプロイを簡単にするために、SSHエージェント転送をセットアップして、安全にローカルのSSHキーを使うことができます。 +title: Using SSH agent forwarding +intro: 'To simplify deploying to a server, you can set up SSH agent forwarding to securely use local SSH keys.' redirect_from: - - /guides/using-ssh-agent-forwarding/ + - /guides/using-ssh-agent-forwarding - /v3/guides/using-ssh-agent-forwarding versions: fpt: '*' @@ -11,50 +11,50 @@ versions: ghec: '*' topics: - API -shortTitle: SSHエージェントのフォワーディング +shortTitle: SSH agent forwarding --- -SSHエージェント転送を使って、サーバーへのデプロイをシンプルにすることができます。 そうすることで、キー（パスフレーズなしの！）をサーバー上に残さずに、ローカルのSSHキーを使用できます。 +SSH agent forwarding can be used to make deploying to a server simple. It allows you to use your local SSH keys instead of leaving keys (without passphrases!) sitting on your server. -{% data variables.product.product_name %}とやりとりするためのSSHキーをセットアップ済みなら、`ssh-agent`には慣れていることでしょう。 これは、バックグラウンドで実行され、キーをメモリにロードした状態にし続けるので、キーを使うたびにパスフレーズを入力する必要がなくなります。 便利なのは、ローカルの`ssh-agent`がサーバー上で動作しているかのように、サーバーからローカルの`ssh-agent`にアクセスさせられることです。 これは、友人のコンピュータをあなたが使えるように、友人のパスワードを友人に入力してもらうように頼むようなものです。 +If you've already set up an SSH key to interact with {% data variables.product.product_name %}, you're probably familiar with `ssh-agent`. It's a program that runs in the background and keeps your key loaded into memory, so that you don't need to enter your passphrase every time you need to use the key. The nifty thing is, you can choose to let servers access your local `ssh-agent` as if they were already running on the server. This is sort of like asking a friend to enter their password so that you can use their computer. -SSHエージェント転送に関するさらに詳細な説明については、[Steve Friedl's Tech Tips guide][tech-tips]をご覧ください。 +Check out [Steve Friedl's Tech Tips guide][tech-tips] for a more detailed explanation of SSH agent forwarding. -## SSHエージェント転送のセットアップ +## Setting up SSH agent forwarding -SSHキーがセットアップされており、動作していることを確認してください。 まだ確認ができていないなら、[SSHキーの生成ガイド][generating-keys]を利用できます。 +Ensure that your own SSH key is set up and working. You can use [our guide on generating SSH keys][generating-keys] if you've not done this yet. -ローカルのキーが動作しているかは、ターミナルで`ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}`と入力すればテストできます。 +You can test that your local key works by entering `ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}` in the terminal: ```shell $ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} -# SSHでgithubに入る +# Attempt to SSH in to github > Hi username! You've successfully authenticated, but GitHub does not provide > shell access. ``` -いいスタートを切ることができました。 サーバーへのエージェント転送ができるよう、SSHをセットアップしましょう。 +We're off to a great start. Let's set up SSH to allow agent forwarding to your server. -1. 好きなテキストエディタで`~/.ssh/config`にあるファイルを開いてください。 もしこのファイルがなかったなら、ターミナルで`touch ~/.ssh/config`と入力すれば作成できます。 +1. Using your favorite text editor, open up the file at `~/.ssh/config`. If this file doesn't exist, you can create it by entering `touch ~/.ssh/config` in the terminal. + +2. Enter the following text into the file, replacing `example.com` with your server's domain name or IP: -2. `example.com`のところを使用するサーバーのドメイン名もしくはIPで置き換えて、以下のテキストをこのファイルに入力してください。 - Host example.com ForwardAgent yes {% warning %} -**警告:** すべてのSSH接続のこの設定を適用するために、`Host *`のようなワイルドカードを使いたくなるかもしれません。 これはローカルのSSHキーをSSHで入る*すべての*サーバーと共有することになるので、実際には良い考えではありません。 キーに直接アクセスされることはないかもしれませんが、接続が確立されている間はそれらのキーが*あなたのかわりに*使われるかもしれません。 **追加するサーバーは、信用でき、エージェント転送で使おうとしているサーバーのみにすべきです。** +**Warning:** You may be tempted to use a wildcard like `Host *` to just apply this setting to all SSH connections. That's not really a good idea, as you'd be sharing your local SSH keys with *every* server you SSH into. They won't have direct access to the keys, but they will be able to use them *as you* while the connection is established. **You should only add servers you trust and that you intend to use with agent forwarding.** {% endwarning %} -## SSHエージェント転送のテスト +## Testing SSH agent forwarding -エージェント転送がサーバーで動作しているかをテストするには、サーバーにSSHで入ってもう一度`ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}`と実行してみてください。 すべてうまくいっているなら、ローカルでやった場合と同じプロンプトが返ってくるでしょう。 +To test that agent forwarding is working with your server, you can SSH into your server and run `ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}` once more. If all is well, you'll get back the same prompt as you did locally. -ローカルのキーが使われているか確信が持てない場合は、サーバー上で`SSH_AUTH_SOCK`変数を調べてみることもできます。 +If you're unsure if your local key is being used, you can also inspect the `SSH_AUTH_SOCK` variable on your server: ```shell $ echo "$SSH_AUTH_SOCK" @@ -62,24 +62,24 @@ $ echo "$SSH_AUTH_SOCK" > /tmp/ssh-4hNGMk8AZX/agent.79453 ``` -この変数が設定されていないなら、エージェント転送は動作していないということです。 +If the variable is not set, it means that agent forwarding is not working: ```shell $ echo "$SSH_AUTH_SOCK" -# SSH_AUTH_SOCK変数の出力 +# Print out the SSH_AUTH_SOCK variable > [No output] $ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} -# SSHでgithubに入る +# Try to SSH to github > Permission denied (publickey). ``` -## SSHエージェント転送のトラブルシューティング +## Troubleshooting SSH agent forwarding -以下は、SSHエージェント転送のトラブルシューティングの際に注意すべきことです。 +Here are some things to look out for when troubleshooting SSH agent forwarding. -### コードをのチェックアウトにはSSH URLを使わなければならない +### You must be using an SSH URL to check out code -SSH転送はHTTP(s) URLでは動作せず、SSH URLでのみ動作します。 サーバー上の*.git/config*ファイルを調べて、URLが以下のようなSSHスタイルのURLになっていることを確認してください。 +SSH forwarding only works with SSH URLs, not HTTP(s) URLs. Check the *.git/config* file on your server and ensure the URL is an SSH-style URL like below: ```shell [remote "origin"] @@ -87,18 +87,18 @@ SSH転送はHTTP(s) URLでは動作せず、SSH URLでのみ動作します。 fetch = +refs/heads/*:refs/remotes/origin/* ``` -### SSHキーはローカルで動作していなければならない +### Your SSH keys must work locally -エージェント転送を通じてキーを動作させるには、まずキーがローカルで動作していなければなりません。 SSHキーをローカルでセットアップするには、[SSHキーの生成ガイド][generating-keys]が役に立つでしょう。 +Before you can make your keys work through agent forwarding, they must work locally first. [Our guide on generating SSH keys][generating-keys] can help you set up your SSH keys locally. -### システムがSSHエージェント転送を許可していなければならない +### Your system must allow SSH agent forwarding -システム設定でSSHエージェント転送が許可されていないことがあります。 システム設定ファイルが使われているかは、ターミナルで以下のコマンドを入力してみればチェックできます。 +Sometimes, system configurations disallow SSH agent forwarding. You can check if a system configuration file is being used by entering the following command in the terminal: ```shell $ ssh -v example.com # Connect to example.com with verbose debug output -> OpenSSH_5.6p1, OpenSSL 0.9.8r 8 Feb 2011 +> OpenSSH_8.1p1, LibreSSL 2.7.3 > debug1: Reading configuration data /Users/you/.ssh/config > debug1: Applying options for example.com > debug1: Reading configuration data /etc/ssh_config @@ -107,7 +107,7 @@ $ exit # Returns to your local command prompt ``` -上の例では、*~/.ssh/config*というファイルがまずロードされ、それから*/etc/ssh_config*が読まれます。 以下のコマンドを実行すれば、そのファイルが設定を上書きしているかを調べることができます。 +In the example above, the file *~/.ssh/config* is loaded first, then */etc/ssh_config* is read. We can inspect that file to see if it's overriding our options by running the following commands: ```shell $ cat /etc/ssh_config @@ -117,17 +117,17 @@ $ cat /etc/ssh_config > ForwardAgent no ``` -この例では、*/etc/ssh_config*ファイルが`ForwardAgent no`と具体的に指定しており、これはエージェント転送をブロックするやり方です。 この行をファイルから削除すれば、エージェント転送は改めて動作するようになります。 +In this example, our */etc/ssh_config* file specifically says `ForwardAgent no`, which is a way to block agent forwarding. Deleting this line from the file should get agent forwarding working once more. -### サーバーはインバウンド接続でSSHエージェント転送を許可していなければならない +### Your server must allow SSH agent forwarding on inbound connections -エージェント転送は、サーバーでブロックされているかもしれません。 エージェント転送が許可されているかは、サーバーにSSHで入り、`sshd_config`を実行してみれば確認できます。 このコマンドからの出力で、`AllowAgentForwarding`が設定されていることが示されていなければなりません。 +Agent forwarding may also be blocked on your server. You can check that agent forwarding is permitted by SSHing into the server and running `sshd_config`. The output from this command should indicate that `AllowAgentForwarding` is set. -### ローカルの`ssh-agent`が動作していなければならない +### Your local `ssh-agent` must be running -ほとんどのコンピュータでは、オペレーティングシステムは自動的に`ssh-agent`を起動してくれます。 しかし、Windowsではこれを手動で行わなければなりません。 [Git Bashを開いたときに`ssh-agent`を起動する方法のガイド][autolaunch-ssh-agent]があります。 +On most computers, the operating system automatically launches `ssh-agent` for you. On Windows, however, you need to do this manually. We have [a guide on how to start `ssh-agent` whenever you open Git Bash][autolaunch-ssh-agent]. -コンピュータで`ssh-agent`が動作しているかを確認するには、ターミナルで以下のコマンドを入力してください。 +To verify that `ssh-agent` is running on your computer, type the following command in the terminal: ```shell $ echo "$SSH_AUTH_SOCK" @@ -135,15 +135,15 @@ $ echo "$SSH_AUTH_SOCK" > /tmp/launch-kNSlgU/Listeners ``` -### キーが`ssh-agent`から利用可能でなければならない +### Your key must be available to `ssh-agent` -`ssh-agent`からキーが見えるかは、以下のコマンドを実行すれば確認できます。 +You can check that your key is visible to `ssh-agent` by running the following command: ```shell ssh-add -L ``` -このコマンドが識別情報が利用できないと言ってきたなら、キーを追加しなければなりません。 +If the command says that no identity is available, you'll need to add your key: ```shell $ ssh-add yourkey @@ -151,7 +151,7 @@ $ ssh-add yourkey {% tip %} -macOSでは、再起動時に`ssh-agent`が起動し直されると、キーは「忘れられて」しまいます。 ただし、以下のコマンドでキーチェーンにSSHキーをインポートできます。 +On macOS, `ssh-agent` will "forget" this key, once it gets restarted during reboots. But you can import your SSH keys into Keychain using this command: ```shell $ ssh-add -K yourkey @@ -161,4 +161,5 @@ $ ssh-add -K yourkey [tech-tips]: http://www.unixwiz.net/techtips/ssh-agent-forwarding.html [generating-keys]: /articles/generating-ssh-keys +[ssh-passphrases]: /ssh-key-passphrases/ [autolaunch-ssh-agent]: /github/authenticating-to-github/working-with-ssh-key-passphrases#auto-launching-ssh-agent-on-git-for-windows diff --git a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 83686ec401..f98ec58b61 100644 --- a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -3,8 +3,8 @@ title: Webhook events and payloads intro: 'For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.' product: '{% data reusables.gated-features.enterprise_account_webhooks %}' redirect_from: - - /early-access/integrations/webhooks/ - - /v3/activity/events/types/ + - /early-access/integrations/webhooks + - /v3/activity/events/types - /webhooks/event-payloads - /developers/webhooks-and-events/webhook-events-and-payloads versions: @@ -1197,8 +1197,9 @@ Key | Type | Description {% ifversion fpt or ghes or ghec %} ## security_advisory -Activity related to a security advisory. A security advisory provides information about security-related vulnerabilities in software on GitHub. The security advisory dataset also powers the GitHub security alerts, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." -{% endif %} +Activity related to a security advisory that has been reviewed by {% data variables.product.company_short %}. A {% data variables.product.company_short %}-reviewed security advisory provides information about security-related vulnerabilities in software on {% data variables.product.prodname_dotcom %}. + +The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)." ### Availability @@ -1215,6 +1216,8 @@ Key | Type | Description {{ webhookPayloadsForCurrentVersion.security_advisory.published }} +{% endif %} + {% ifversion fpt or ghec %} ## sponsorship diff --git a/translations/ja-JP/content/get-started/index.md b/translations/ja-JP/content/get-started/index.md index 8917ef270e..8131599b42 100644 --- a/translations/ja-JP/content/get-started/index.md +++ b/translations/ja-JP/content/get-started/index.md @@ -37,6 +37,7 @@ featuredLinks: - /github/getting-started-with-github/signing-up-for-a-new-github-account - /get-started/quickstart/hello-world - /github/getting-started-with-github/set-up-git + - /get-started/learning-about-github/about-versions-of-github-docs - /github/getting-started-with-github/github-glossary - /github/getting-started-with-github/fork-a-repo - /github/getting-started-with-github/keyboard-shortcuts diff --git a/translations/ja-JP/content/get-started/learning-about-github/about-versions-of-github-docs.md b/translations/ja-JP/content/get-started/learning-about-github/about-versions-of-github-docs.md new file mode 100644 index 0000000000..71486683c9 --- /dev/null +++ b/translations/ja-JP/content/get-started/learning-about-github/about-versions-of-github-docs.md @@ -0,0 +1,56 @@ +--- +title: About versions of GitHub Docs +intro: "You can read documentation that reflects the {% data variables.product.company_short %} product you're currently using." +versions: '*' +shortTitle: Docs versions +--- + +## About versions of {% data variables.product.prodname_docs %} + +{% data variables.product.company_short %} offers different products for storing and collaborating on code. The product you use determines which features are available to you. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)." + +This website, {% data variables.product.prodname_docs %}, provides documentation for all of {% data variables.product.company_short %}'s products. If the content you're reading applies to more than one product, you can choose the version of the documentation that's relevant to you by selecting the product you're currently using. + +At the top of a page on {% data variables.product.prodname_docs %}, select the dropdown menu and click a product. If your browser window is not wide enough to display the full navigation bar, you may need to click {% octicon "three-bars" aria-label="The three bars icon" %} first. + +![Screenshot of the dropdown menu for picking a version of {% data variables.product.prodname_docs %} to view](/assets/images/help/docs/version-picker.png) + +{% note %} + +**Note**: You can try changing the version now. You're viewing {% ifversion ghes %}a{% else %}the{% endif %} {% ifversion fpt %}Free, Pro, & Team{% else %}{% data variables.product.product_name %}{% endif %} version of this article. + +{% endnote %} + +## Determining which {% data variables.product.company_short %} product you use + +You can determine which {% data variables.product.company_short %} product you're currently using by reviewing the URL in the address bar of your browser and the heading for the {% data variables.product.prodname_dotcom %} website you're on. + +You may use more than one {% data variables.product.company_short %} product. For example, you might contribute to open source on {% data variables.product.prodname_dotcom_the_website %} and collaborate on code on your employer's {% data variables.product.prodname_ghe_server %} instance. You may need to view different versions of the same article at different times, depending on the problem you're currently trying to solve. + +### {% data variables.product.prodname_dotcom_the_website %} plans or {% data variables.product.prodname_ghe_cloud %} + +If you access {% data variables.product.prodname_dotcom %} at https://github.com, you're either using the features of a Free, Pro, or Team plan, or you're using {% data variables.product.prodname_ghe_cloud %}. + +In a wide browser window, there is no text that immediately follows the {% data variables.product.company_short %} logo on the left side of the header. + +![Screenshot of the address bar and the {% data variables.product.prodname_dotcom_the_website %} header in a browser](/assets/images/help/docs/header-dotcom.png) + +On {% data variables.product.prodname_dotcom_the_website %}, each account has its own plan. Each personal account has an associated plan that provides access to certain features, and each organization has a different associated plan. If your personal account is a member of an organization on {% data variables.product.prodname_dotcom_the_website %}, you may have access to different features when you use resources owned by that organization than when you use resources owned by your personal account. For more information, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)." + +If you don't know whether an organization uses {% data variables.product.prodname_ghe_cloud %}, ask an organization owner. For more information, see "[Viewing people's roles in an organization](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization)." + +### {% data variables.product.prodname_ghe_server %} + +If you access {% data variables.product.prodname_dotcom %} at a URL other than https://github.com, `https://*.githubenterprise.com`, `https://*.github.us`, or `https://*.ghe.com`, you're using {% data variables.product.prodname_ghe_server %}. For example, you may access {% data variables.product.prodname_ghe_server %} at `https://github.YOUR-COMPANY-NAME.com`. Your administrators may choose a URL that doesn't include the word "{% data variables.product.company_short %}." + +In a wide browser window, the word "Enterprise" immediately follows the {% data variables.product.company_short %} logo on the left side of the header. + +![Screenshot of address bar and {% data variables.product.prodname_ghe_server %} header in a browser](/assets/images/help/docs/header-ghes.png) + +### {% data variables.product.prodname_ghe_managed %} + +If you access {% data variables.product.prodname_dotcom %} at `https://*.githubenterprise.com`, `https://*.github.us`, or `https://*.ghe.com`, you're using {% data variables.product.prodname_ghe_managed %}. + +In a wide browser window, the words "{% data variables.product.prodname_ghe_managed %}" immediately follow the {% data variables.product.company_short %} logo in the header. + +![Address bar and {% data variables.product.prodname_ghe_managed %} header in a browser](/assets/images/help/docs/header-ghae.png) diff --git a/translations/ja-JP/content/get-started/learning-about-github/githubs-products.md b/translations/ja-JP/content/get-started/learning-about-github/githubs-products.md index c5927d487d..a45107bd4c 100644 --- a/translations/ja-JP/content/get-started/learning-about-github/githubs-products.md +++ b/translations/ja-JP/content/get-started/learning-about-github/githubs-products.md @@ -24,6 +24,8 @@ topics: You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %} +When you read {% data variables.product.prodname_docs %}, make sure to select the version that reflects your product. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + ## {% data variables.product.prodname_free_user %} for user accounts With {% data variables.product.prodname_free_team %} for user accounts, you can work with unlimited collaborators on unlimited public repositories with a full feature set, and on unlimited private repositories with a limited feature set. diff --git a/translations/ja-JP/content/get-started/learning-about-github/index.md b/translations/ja-JP/content/get-started/learning-about-github/index.md index 32d67d6de5..5861d232ae 100644 --- a/translations/ja-JP/content/get-started/learning-about-github/index.md +++ b/translations/ja-JP/content/get-started/learning-about-github/index.md @@ -17,10 +17,11 @@ topics: - Security children: - /githubs-products + - /about-versions-of-github-docs - /github-language-support - - /about-github-advanced-security - /types-of-github-accounts - /access-permissions-on-github + - /about-github-advanced-security - /faq-about-changes-to-githubs-plans --- diff --git a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-ae.md b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-ae.md index 59ecae212e..013ac1a1af 100644 --- a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-ae.md @@ -16,13 +16,13 @@ You will first need to purchase {% data variables.product.product_name %}. For m {% data reusables.github-ae.initialize-enterprise %} ### 2. Initializing {% data variables.product.product_name %} -After {% data variables.product.company_short %} creates the owner account for {% data variables.product.product_location %} on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name {% data variables.product.product_location %}, configure SAML SSO, create policies for all organizations in {% data variables.product.product_location %}, and configure a support contact for your enterprise members. 詳しい情報については、「[{% data variables.product.prodname_ghe_managed %} を初期化する](/admin/configuration/configuring-your-enterprise/initializing-github-ae)」を参照してください。 +After {% data variables.product.company_short %} creates the owner account for {% data variables.product.product_location %} on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name {% data variables.product.product_location %}, configure SAML SSO, create policies for all organizations in {% data variables.product.product_location %}, and configure a support contact for your enterprise members. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." -### 3. ネットワークトラフィックを制限する -You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. 詳しい情報については、「[Enterprise へのネットワークトラフィックを制限する](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)」を参照してください。 +### 3. Restricting network traffic +You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)." ### 4. Managing identity and access for {% data variables.product.product_location %} -You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. 詳しい情報については、「[Enterprise のアイデンティティとアクセス管理について](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)」を参照してください。 +You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." ### 5. Managing billing for {% data variables.product.product_location %} Owners of the subscription for {% data variables.product.product_location %} on {% data variables.product.product_name %} can view billing details for {% data variables.product.product_name %} in the Azure portal. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." @@ -33,13 +33,13 @@ As an enterprise owner for {% data variables.product.product_name %}, you can ma ### 1. Managing members of {% data variables.product.product_location %} {% data reusables.getting-started.managing-enterprise-members %} -### 2. Organizationの作成 +### 2. Creating organizations {% data reusables.getting-started.creating-organizations %} ### 3. Adding members to organizations {% data reusables.getting-started.adding-members-to-organizations %} -### 4. Teamの作成 +### 4. Creating teams {% data reusables.getting-started.creating-teams %} ### 5. Setting organization and repository permission levels @@ -68,13 +68,16 @@ You can customize and automate work in organizations in {% data variables.produc For more information on enabling and configuring {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)." -### 3. {% data variables.product.prodname_pages %}を使用する +### 3. Using {% data variables.product.prodname_pages %} {% data reusables.getting-started.github-pages-enterprise %} ## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need with {% data variables.product.prodname_dotcom %} Enterprise Support. -### 1. Learning with {% data variables.product.prodname_learning %} +### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} +You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_managed %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 2. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab-enterprise %} -### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support +### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data reusables.getting-started.contact-support-enterprise %} diff --git a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md index d8227e1740..9598e02d65 100644 --- a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md @@ -199,14 +199,18 @@ Members of your organization or enterprise can use tools from the {% data variab ## Part 7: Participating in {% data variables.product.prodname_dotcom %}'s community Members of your organization or enterprise can use GitHub's learning and support resources to get the help they need. You can also support the open source community. -### 1. Learning with {% data variables.product.prodname_learning %} + +### 1. Reading about {% data variables.product.prodname_ghe_cloud %} on {% data variables.product.prodname_docs %} +You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 2. Learning with {% data variables.product.prodname_learning %} Members of your organization or enterprise can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by the friendly Learning Lab bot. For more information, see "[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." -### 2. Supporting the open source community +### 3. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 3. Contacting {% data variables.contact.github_support %} +### 4. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} {% data variables.product.prodname_ghe_cloud %} allows you to submit priority support requests with a target eight-hour response time. For more information, see "[{% data variables.product.prodname_ghe_cloud %} support](/github/working-with-github-support/github-enterprise-cloud-support)." diff --git a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-server.md b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-server.md index 2d6b792ad2..4637e3b623 100644 --- a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-server.md +++ b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-server.md @@ -1,5 +1,5 @@ --- -title: GitHub Enterprise Serverを使い始める +title: Getting started with GitHub Enterprise Server intro: 'Get started with setting up and managing {% data variables.product.product_location %}.' versions: ghes: '*' @@ -16,31 +16,31 @@ This guide will walk you through setting up, configuring and managing {% data va For an overview of how {% data variables.product.product_name %} works, see "[System overview](/admin/overview/system-overview)." -## パート 1: {% data variables.product.product_name %} のインストール方法 -To get started with {% data variables.product.product_name %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. +## Part 1: Installing {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. ### 1. Creating your enterprise account -Before you install {% data variables.product.product_name %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. 詳細は「[Enterprise アカウントについて](/admin/overview/about-enterprise-accounts)」を参照してください。 -### 2. {% data variables.product.product_name %}のインストール -To get started with {% data variables.product.product_name %}, you will need to install the appliance on a virtualization platform of your choice. 詳細は「[{% data variables.product.prodname_ghe_server %}インスタンスをセットアップする](/admin/installation/setting-up-a-github-enterprise-server-instance)」を参照してください。 +Before you install {% data variables.product.product_name %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +### 2. Installing {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you will need to install the appliance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." ### 3. Using the Management Console You will use the Management Console to walk through the initial setup process when first launching {% data variables.product.product_location %}. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." -### 4. {% data variables.product.product_location %} を設定する +### 4. Configuring {% data variables.product.product_location %} In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage {% data variables.product.product_location %}. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)." -You can use the default network settings used by {% data variables.product.product_name %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. プロキシサーバあるいはファイアウォールルールを設定することもできます。 For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." +You can use the default network settings used by {% data variables.product.product_name %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." -### 5. High Availability の設定 +### 5. Configuring high availability You can configure {% data variables.product.product_location %} for high availability to minimize the impact of hardware failures and network outages. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)." -### 6. ステージングインスタンスのセットアップ -You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to {% data variables.product.product_location %}. 詳しい情報については "[ステージングインスタンスのセットアップ](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)"を参照してください。 +### 6. Setting up a staging instance +You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to {% data variables.product.product_location %}. For more information, see "[Setting up a staging instance](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)." ### 7. Designating backups and disaster recovery -To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. 詳しくは、"[ アプライアンスでのバックアップの設定](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)。"を参照してください。 +To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see "[Configuring backups on your appliance](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)." -### 8. Enterprise の支払いを管理する +### 8. Managing billing for your enterprise Billing for all the organizations and {% data variables.product.product_name %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." ## Part 2: Organizing and managing your team @@ -49,13 +49,13 @@ As an enterprise owner or administrator, you can manage settings on user, reposi ### 1. Managing members of {% data variables.product.product_location %} {% data reusables.getting-started.managing-enterprise-members %} -### 2. Organizationの作成 +### 2. Creating organizations {% data reusables.getting-started.creating-organizations %} ### 3. Adding members to organizations {% data reusables.getting-started.adding-members-to-organizations %} -### 4. Teamの作成 +### 4. Creating teams {% data reusables.getting-started.creating-teams %} ### 5. Setting organization and repository permission levels @@ -88,7 +88,7 @@ You can upgrade your {% data variables.product.product_name %} license to includ You can customize and automate work in organizations in your enterprise with {% data variables.product.prodname_dotcom %} and {% data variables.product.prodname_oauth_apps %}, {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %} , and {% data variables.product.prodname_pages %}. ### 1. Building {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} -You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. 詳しい情報については「[アプリケーションについて](/developers/apps/getting-started-with-apps/about-apps)」を参照してください。 +You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. For more information, see "[About apps](/developers/apps/getting-started-with-apps/about-apps)." ### 2. Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API {% data reusables.getting-started.api %} @@ -98,23 +98,29 @@ You can build integrations with the {% ifversion fpt or ghec %}{% data variables For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." -### 4. Publishing and managing {% data variables.product.prodname_registry %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} For more information on enabling and configuring {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, see "[Getting started with {% data variables.product.prodname_registry %} for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)." {% endif %} -### 5. {% data variables.product.prodname_pages %}を使用する +### 5. Using {% data variables.product.prodname_pages %} {% data reusables.getting-started.github-pages-enterprise %} ## Part 5: Connecting with other {% data variables.product.prodname_dotcom %} resources You can use {% data variables.product.prodname_github_connect %} to share resources. -If you are the owner of both a {% data variables.product.product_name %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. 詳細は、「[{% data variables.product.prodname_ghe_server %}を{% data variables.product.prodname_ghe_cloud %}に接続する](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)」を参照してください。 +If you are the owner of both a {% data variables.product.product_name %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)." ## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need when setting up and managing {% data variables.product.product_location %} with {% data variables.product.prodname_dotcom %} Enterprise Support. -### 1. Learning with {% data variables.product.prodname_learning %} + +### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} + +You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_server %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 2. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab-enterprise %} -### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support + +### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data reusables.getting-started.contact-support-enterprise %} diff --git a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-team.md b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-team.md index 6cf0699959..27e6ee5e6a 100644 --- a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-team.md +++ b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-team.md @@ -10,16 +10,16 @@ This guide will walk you through setting up, configuring and managing your {% da ## Part 1: Configuring your account on {% data variables.product.product_location %} As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. -### 1. Organizationについて -Organizationは、企業やオープンソースプロジェクトが多くのプロジェクトにわたって一度にコラボレーションできる共有アカウントです。 オーナーと管理者は、Organizationのデータとプロジェクトへのメンバーのアクセスを、洗練されたセキュリティ及び管理機能で管理できます。 For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)." +### 1. About organizations +Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)." ### 2. Creating an organization and signing up for {% data variables.product.prodname_team %} -Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. 詳しい情報については、「[新しい {% data variables.product.prodname_dotcom %} アカウントにサインアップする](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)」を参照してください。 +Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)." -Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. 詳しい情報については、「[新しい Organization をゼロから作成する](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)」を参照してください。 +Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." ### 3. Managing billing for an organization -You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. 詳しい情報については「[様々なアカウントの設定の切り替え](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)」を参照してください。 +You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)." Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)." @@ -64,7 +64,7 @@ You can help to make your organization more secure by recommending or requiring ## Part 5: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} -### 1. {% data variables.product.prodname_marketplace %}を使用する +### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} ### 2. Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API {% data reusables.getting-started.api %} @@ -72,7 +72,7 @@ You can help to make your organization more secure by recommending or requiring ### 3. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### 4. Publishing and managing {% data variables.product.prodname_registry %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community @@ -83,14 +83,17 @@ You can help to make your organization more secure by recommending or requiring ### 2. Interacting with the {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### 3. Learning with {% data variables.product.prodname_learning %} +### 3. Reading about {% data variables.product.prodname_team %} on {% data variables.product.prodname_docs %} +You can read documentation that reflects the features available with {% data variables.product.prodname_team %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 4. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} -### 4. Supporting the open source community +### 5. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 5. {% data variables.contact.github_support %} への連絡 +### 6. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} -## 参考リンク +## Further reading - "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)" diff --git a/translations/ja-JP/content/get-started/onboarding/getting-started-with-your-github-account.md b/translations/ja-JP/content/get-started/onboarding/getting-started-with-your-github-account.md index 4f50e87904..245a75c61f 100644 --- a/translations/ja-JP/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/translations/ja-JP/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -23,18 +23,18 @@ The first steps in starting with {% data variables.product.product_name %} are t {% ifversion fpt or ghec %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. {% ifversion fpt or ghec %} -### 1. アカウントを作成する +### 1. Creating an account To sign up for an account on {% data variables.product.product_location %}, navigate to https://github.com/ and follow the prompts. -To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. 詳しい情報については、「[強力なパスワードを作成する](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)」を参照してください。 +To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)." ### 2. Choosing your {% data variables.product.prodname_dotcom %} product You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. You can upgrade at any time if you are unsure at first which product you want. For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)." -### 3. メールアドレスを検証する -To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. 詳細は「[メールアドレスを検証する](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)」を参照してください。 +### 3. Verifying your email address +To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} {% ifversion ghes %} @@ -49,20 +49,20 @@ You will receive an email notification once your enterprise owner for {% data va {% ifversion fpt or ghes or ghec %} ### {% ifversion fpt or ghec %}4.{% else %}2.{% endif %} Configuring two-factor authentication -2 要素認証、あるいは 2FA は、Web サイトあるいはアプリケーションにログインする際に使われる追加のセキュリティレイヤーです。 We strongly urge you to configure 2FA for the safety of your account. 詳しい情報については「[2 要素認証について](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)」を参照してください。 +Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} ### {% ifversion fpt or ghec %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Viewing your {% data variables.product.prodname_dotcom %} profile and contribution graph Your {% data variables.product.prodname_dotcom %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see "[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and "[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes -To best use {% data variables.product.product_name %}, you'll need to set up Git. Git は、{% data variables.product.prodname_dotcom %} に関連してローカルコンピュータで発生するすべての動作の根本を担っています。 To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. +To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. ### 1. Learning Git {% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the "[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see "[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." -### 2. Git をセットアップする -If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. 詳細は「[Git のセットアップ](/get-started/quickstart/set-up-git)」を参照してください。を参照してください。 +### 2. Setting up Git +If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see "[Set up Git](/get-started/quickstart/set-up-git)." -If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. 詳細は「[{% data variables.product.prodname_desktop %} を使ってみる](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)」を参照してください。 +If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. For more information, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." @@ -71,15 +71,15 @@ Everyone has their own unique workflow for interacting with {% data variables.pr For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)." -| **方法** | **説明** | **Use cases** | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests. | This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | -| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} は、コマンドライン上でテキストコマンドを使うのではなく、ビジュアルインターフェースを使って、あなたの {% data variables.product.prodname_dotcom_the_website %} ワークフローを拡張し簡略化します。 For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | -| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | -| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | -| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | +| **Method** | **Description** | **Use cases** | +| ------------- | ------------- | ------------- | +| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | +| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | +| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | +| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | +| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} -To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. 詳しい情報については、「[{% data variables.product.prodname_dotcom %}での執筆とフォーマットについて](/github/writing-on-github/about-writing-and-formatting-on-github)」を参照してください。 +To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. @@ -96,56 +96,56 @@ Any number of people can work together in repositories across {% data variables. ### 1. Working with repositories -#### リポジトリを作成する -リポジトリは、プロジェクトのフォルダーのようなものです。 You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." +#### Creating a repository +A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." -When you create a new repository, you should initialize the repository with a README file to let people know about your project. 詳しい情報については「[新しいリポジトリの作成](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)」を参照してください。 +When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." -#### リポジトリをクローンする -You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. リポジトリをクローンすると、その時点で {% data variables.product.prodname_dotcom %} にあるすべてのリポジトリデータの完全なコピーがプルダウンされます。これには、プロジェクトのすべてのファイルとフォルダのすべてのバージョンも含まれます。 詳しい情報については[リポジトリのクローン](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)を参照してください。 +#### Cloning a repository +You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)." -#### リポジトリをフォークする -A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. 一般的にフォークは、他のユーザのプロジェクトへの変更を提案するため、あるいは他のユーザのプロジェクトを自分のアイディアの出発点として活用するために使用します。 For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)." -### 2. プロジェクトのインポート +#### Forking a repository +A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)." +### 2. Importing your projects If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see "[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." ### 3. Managing collaborators and permissions -リポジトリの Issue、プルリクエスト、プロジェクトボードを使ってプロジェクトで他者とコラボレーションできます。 You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. 詳しい情報については、「[コラボレータを個人リポジトリに招待する](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)」を参照してください。 +You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." -You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. 詳しい情報については[ユーザアカウントのリポジトリ権限レベル](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)を参照してください。 +You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." -### 4. リポジトリ設定を管理する -As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. 詳しい情報については、「[リポジトリ設定を管理する](/github/administering-a-repository/managing-repository-settings)」を参照してください。 +### 4. Managing repository settings +As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." -### 5. 健全なコントリビューションを促すプロジェクトをセットアップする +### 5. Setting up your project for healthy contributions {% ifversion fpt or ghec %} To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see "[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. -By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. 詳しい情報については、「[健全なコントリビューションを促すプロジェクトをセットアップする](/communities/setting-up-your-project-for-healthy-contributions)」を参照してください。 +By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} {% ifversion ghes or ghae %} -By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. 詳しい情報については、「[健全なコントリビューションを促すプロジェクトをセットアップする](/communities/setting-up-your-project-for-healthy-contributions)」を参照してください。 +By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} ### 6. Using GitHub Issues and project boards You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[About issues](/issues/tracking-your-work-with-issues/about-issues)" and "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." ### 7. Managing notifications -Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} you've subscribed to or participated in. 会話に関心がなくなった場合は、今後受信する通知の種類を、サブスクライブ解除、Watch 解除、またはカスタマイズできます。 詳しい情報については、「[通知について](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)」を参照してください。 +Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." -### 8. {% data variables.product.prodname_pages %} の活用 +### 8. Working with {% data variables.product.prodname_pages %} You can use {% data variables.product.prodname_pages %} to create and host a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." {% ifversion fpt or ghec %} -### 9. {% data variables.product.prodname_discussions %}を使用する -You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. 詳しい情報については「[ディスカッションについて](/discussions/collaborating-with-your-community-using-discussions/about-discussions)」を参照してください。 +### 9. Using {% data variables.product.prodname_discussions %} +You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% endif %} ## Part 4: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} {% ifversion fpt or ghec %} -### 1. {% data variables.product.prodname_marketplace %}を使用する +### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} {% endif %} ### {% ifversion fpt or ghec %}2.{% else %}1.{% endif %} Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API @@ -154,20 +154,20 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi ### {% ifversion fpt or ghec %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} +### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 5: Building securely on {% data variables.product.product_name %} {% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." -### 1. リポジトリを保護する -As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. +### 1. Securing your repository +As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)." {% ifversion fpt or ghec %} ### 2. Managing your dependencies -A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. +A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)." {% endif %} @@ -182,18 +182,22 @@ For more information, see "[Securing your software supply chain](/code-security/ ### 2. Interacting with {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### 3. Learning with {% data variables.product.prodname_learning %} +### 3. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} + +{% data reusables.docs.you-can-read-docs-for-your-product %} + +### 4. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} {% ifversion fpt or ghec %} -### 4. Supporting the open source community +### 5. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 5. {% data variables.contact.github_support %} への連絡 +### 6. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} {% ifversion fpt %} -## 参考リンク -- 「[{% data variables.product.prodname_team %} を使ってみる](/get-started/onboarding/getting-started-with-github-team)」 +## Further reading +- "[Getting started with {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)" {% endif %} {% endif %} diff --git a/translations/ja-JP/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md b/translations/ja-JP/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md index 0a60c0a9d2..f5c9633c79 100644 --- a/translations/ja-JP/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md +++ b/translations/ja-JP/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -56,6 +56,8 @@ Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be After setting up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the [Enterprise Onboarding Guide](https://resources.github.com/enterprise-onboarding/). +{% data reusables.docs.you-can-read-docs-for-your-product %} + {% data reusables.products.product-roadmap %} ## Finishing your trial diff --git a/translations/ja-JP/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md b/translations/ja-JP/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md index 6b47866c00..1328f54580 100644 --- a/translations/ja-JP/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md +++ b/translations/ja-JP/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md @@ -41,6 +41,7 @@ To get the most out of your trial, follow these steps: - [Quick start guide to {% data variables.product.prodname_dotcom %}](https://resources.github.com/webcasts/Quick-start-guide-to-GitHub/) webcast - [Understanding the {% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow/) in {% data variables.product.prodname_dotcom %} Guides - [Hello World](https://guides.github.com/activities/hello-world/) in {% data variables.product.prodname_dotcom %} Guides + - "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)" 3. To configure your instance to meet your organization's needs, see "[Configuring your enterprise](/enterprise-server@latest/admin/configuration/configuring-your-enterprise)." 4. To integrate {% data variables.product.prodname_ghe_server %} with your identity provider, see "[Using SAML](/enterprise-server@latest/admin/user-management/using-saml)" and "[Using LDAP](/enterprise-server@latest/admin/authentication/using-ldap)." 5. Invite an unlimited number of people to join your trial. diff --git a/translations/ja-JP/content/issues/index.md b/translations/ja-JP/content/issues/index.md index 8efa7aef14..7b78e0992a 100644 --- a/translations/ja-JP/content/issues/index.md +++ b/translations/ja-JP/content/issues/index.md @@ -1,7 +1,7 @@ --- -title: GitHubのIssue -shortTitle: GitHubのIssue -intro: '作業を計画し、追跡するために{% data variables.product.prodname_github_issues %}を使う方法を学んでください。' +title: GitHub Issues +shortTitle: GitHub Issues +intro: 'Learn how you can use {% data variables.product.prodname_github_issues %} to plan and track your work.' introLinks: overview: /issues/tracking-your-work-with-issues/creating-issues/about-issues quickstart: /issues/tracking-your-work-with-issues/quickstart @@ -44,9 +44,9 @@ redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests - /github/managing-your-work-on-github/managing-your-work-with-issues - /github/managing-your-work-on-github - - /categories/100/articles/ - - /categories/managing-projects/ - - /categories/managing-projects-on-github/ + - /categories/100/articles + - /categories/managing-projects + - /categories/managing-projects-on-github - /categories/managing-your-work-on-github - /about-issues - /creating-an-issue diff --git a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md index 567d3c964f..833004a4f8 100644 --- a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md +++ b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md @@ -1,9 +1,9 @@ --- -title: プロジェクトボードについて -intro: '{% data variables.product.product_name %}のプロジェクトボードは、作業を整理して優先順位付けするための役に立ちます。 プロジェクトボードは、特定の機能の作業、包括的なロードマップ、さらにはリリースのチェックリストのためにも作成できます。 プロジェクトボードを使うと、要求に適したカスタマイズされたワークフローを作成する柔軟性が得られます。' +title: About project boards +intro: 'Project boards on {% data variables.product.product_name %} help you organize and prioritize your work. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. With project boards, you have the flexibility to create customized workflows that suit your needs.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/about-project-boards - - /articles/about-projects/ + - /articles/about-projects - /articles/about-project-boards - /github/managing-your-work-on-github/about-project-boards versions: @@ -17,59 +17,58 @@ topics: {% data reusables.projects.project_boards_old %} -プロジェクトボードは、Issue、プルリクエスト、選択した列内でカードとして分類されるノートから構成されます。 列内のカードの並び替え、列から列へのカードの移動、および列の順序の変更には、ドラッグアンドドロップまたはキーボードショートカットが利用できます。 +Project boards are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can drag and drop or use keyboard shortcuts to reorder cards within a column, move cards from column to column, and change the order of columns. -プロジェクトボードのカードには、ラベル、アサインされた人、スタータス、オープンした人など、Issueやプルリクエストに関連するメタデータが含まれます。 {% data reusables.project-management.edit-in-project %} +Project board cards contain relevant metadata for issues and pull requests, like labels, assignees, the status, and who opened it. {% data reusables.project-management.edit-in-project %} -タスクのリマインダとして機能するノートを列内に作成し、{% data variables.product.product_location %} 上の任意のリポジトリからの Issue やプルリクエストを参照させたり、プロジェクトボードに関係する情報を追加したりすることができます。 ノートにリンクを追加することで、他のプロジェクトを参照するカードを作成することもできます。 ノートでは要求を満たせない場合、ノートを Issue に変換することができます。 プロジェクトボードのノートのIssueへの変換に関する詳しい情報については[プロジェクトボードへのノートの追加](/articles/adding-notes-to-a-project-board)を参照してください。 +You can create notes within columns to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.product_location %}, or to add information related to the project board. You can create a reference card for another project board by adding a link to a note. If the note isn't sufficient for your needs, you can convert it to an issue. For more information on converting project board notes to issues, see "[Adding notes to a project board](/articles/adding-notes-to-a-project-board)." -プロジェクトボードには以下の種類があります: +Types of project boards: -- **ユーザが所有するプロジェクトボード**には、任意の個人リポジトリからの Issue およびプルリクエストを含めることができます。 -- **Organization内プロジェクトボード**は、Organizationに属する任意のリポジトリからのIssueやプルリクエストを含むことができます。 {% data reusables.project-management.link-repos-to-project-board %}詳細は「[リポジトリをプロジェクトボードにリンクする](/articles/linking-a-repository-to-a-project-board)」を参照してください。 -- **リポジトリプロジェクトボード**は、単一のリポジトリ内の Issue とプルリクエストを対象とします。 他のリポジトリの Issue やプルリクエストを参照するノートも含まれます。 +- **User-owned project boards** can contain issues and pull requests from any personal repository. +- **Organization-wide project boards** can contain issues and pull requests from any repository that belongs to an organization. {% data reusables.project-management.link-repos-to-project-board %} For more information, see "[Linking a repository to a project board](/articles/linking-a-repository-to-a-project-board)." +- **Repository project boards** are scoped to issues and pull requests within a single repository. They can also include notes that reference issues and pull requests in other repositories. -## プロジェクトボードの作成と表示 +## Creating and viewing project boards -Organization にプロジェクトボードを作成するには、Organization のメンバーでなければなりません。 Organization のオーナーおよびプロジェクトボードの管理者権限を持っている人は、プロジェクトボードへのアクセスをカスタマイズできます。 +To create a project board for your organization, you must be an organization member. Organization owners and people with project board admin permissions can customize access to the project board. -Organization が所有するプロジェクトボードに、あなたが表示する権限を持っていないリポジトリからの Issue あるいはプルリクエストが含まれている場合、そのカードは削除編集されます。 詳しい情報については、「[Organization のプロジェクトボードの権限](/articles/project-board-permissions-for-an-organization)」を参照してください。 +If an organization-owned project board includes issues or pull requests from a repository that you don't have permission to view, the card will be redacted. For more information, see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)." -アクティビティビューには、誰かが作成したカードや、列間での移動など、プロジェクトの最近の履歴が表示されます。 アクティビティビューにアクセスするには、[**Menu**] をクリックしてスクロールダウンします。 +The activity view shows the project board's recent history, such as cards someone created or moved between columns. To access the activity view, click **Menu** and scroll down. -プロジェクトボード上で特定のカードを見つける、あるいはカード群の一部を見るために、プロジェクトボードカードをフィルタリングできます。 詳細は「[プロジェクトボード上でカードをフィルタリングする](/articles/filtering-cards-on-a-project-board)」を参照してください。 +To find specific cards on a project board or view a subset of the cards, you can filter project board cards. For more information, see "[Filtering cards on a project board](/articles/filtering-cards-on-a-project-board)." -ワークフローをシンプルにし、完了したタスクをプロジェクトボードから外しておくために、カードをアーカイブできます。 詳細は「[プロジェクトボードのカードをアーカイブする](/articles/archiving-cards-on-a-project-board)」を参照してください。 +To simplify your workflow and keep completed tasks off your project board, you can archive cards. For more information, see "[Archiving cards on a project board](/articles/archiving-cards-on-a-project-board)." -プロジェクトボードのタスクがすべて完了した、あるいはプロジェクトボードを使う必要がなくなったりした場合には、プロジェクトボードをクローズできます。 詳しい情報については[プロジェクトボードのクローズ](/articles/closing-a-project-board)を参照してください。 +If you've completed all of your project board tasks or no longer need to use your project board, you can close the project board. For more information, see "[Closing a project board](/articles/closing-a-project-board)." -また、別の方法で作業を追跡したい場合は、[リポジトリ中でプロジェクトボードを無効化する](/articles/disabling-project-boards-in-a-repository)、あるいは[Organization 内でプロジェクトボードを無効化する](/articles/disabling-project-boards-in-your-organization)こともできます。 +You can also [disable project boards in a repository](/articles/disabling-project-boards-in-a-repository) or [disable project boards in your organization](/articles/disabling-project-boards-in-your-organization), if you prefer to track your work in a different way. {% data reusables.project-management.project-board-import-with-api %} -## プロジェクトボードのテンプレート +## Templates for project boards -テンプレートを使って、新しいプロジェクトボードを素早くセットアップできます。 テンプレートを使用してプロジェクトボードを作成すると、新しいボードには、列だけでなく、プロジェクトボードの便利な利用方法が書かれたカードが付きます。 また、自動化が設定済みのテンプレートを選択することもできます。 +You can use templates to quickly set up a new project board. When you use a template to create a project board, your new board will include columns as well as cards with tips for using project boards. You can also choose a template with automation already configured. -| テンプレート | 説明 | -| ---------------------------- | ------------------------------------------------------------------------------ | -| Basic kanban | [To do]、[In progress]、[Done] 列でタスクを追跡します。 | -| Automated kanban | カードは自動的に [To do]、[In progress]、[Done] の列間を移動します。 | -| Automated kanban with review | プルリクエストレビューのステータスのための追加のトリガーで、カードは [To do]、[In progress]、[Done] 列の間を自動的に移動します。 | -| Bug triage | [To do]、[High priority]、[Low priority]、[Closed] 列でバグのトリアージと優先順位付けをします。 | +| Template | Description | +| --- | --- | +| Basic kanban | Track your tasks with To do, In progress, and Done columns | +| Automated kanban | Cards automatically move between To do, In progress, and Done columns | +| Automated kanban with review | Cards automatically move between To do, In progress, and Done columns, with additional triggers for pull request review status | +| Bug triage | Triage and prioritize bugs with To do, High priority, Low priority, and Closed columns | -プロジェクトボードのための自動化に関する詳しい情報については、「[プロジェクトボードの自動化について](/articles/about-automation-for-project-boards)」を参照してください。 +For more information on automation for project boards, see "[About automation for project boards](/articles/about-automation-for-project-boards)." -![basic kanban テンプレートでのプロジェクトボード](/assets/images/help/projects/project-board-basic-kanban-template.png) +![Project board with basic kanban template](/assets/images/help/projects/project-board-basic-kanban-template.png) {% data reusables.project-management.copy-project-boards %} -## 参考リンク +## Further reading -- [プロジェクトボードの作成](/articles/creating-a-project-board) -- [プロジェクトボードの編集](/articles/editing-a-project-board){% ifversion fpt or ghec %} -- [プロジェクトボードのコピー](/articles/copying-a-project-board) -{% endif %} -- [プロジェクトボードへの Issue およびプルリクエストの追加](/articles/adding-issues-and-pull-requests-to-a-project-board) -- [Organization のプロジェクトボード権限](/articles/project-board-permissions-for-an-organization) -- [キーボードショートカット](/articles/keyboard-shortcuts/#project-boards) +- "[Creating a project board](/articles/creating-a-project-board)" +- "[Editing a project board](/articles/editing-a-project-board)"{% ifversion fpt or ghec %} +- "[Copying a project board](/articles/copying-a-project-board)"{% endif %} +- "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)" +- "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)" +- "[Keyboard shortcuts](/articles/keyboard-shortcuts/#project-boards)" diff --git a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md index b5ae2c5a9a..868b241f59 100644 --- a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md +++ b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md @@ -1,9 +1,9 @@ --- -title: プロジェクトボードをクローズする -intro: プロジェクトボードのタスクをすべて完了したか、プロジェクトボードを使う必要がなくなった場合、そのプロジェクトボードをクローズできます。 +title: Closing a project board +intro: 'If you''ve completed all the tasks in a project board or no longer need to use a project board, you can close the project board.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/closing-a-project-board - - /articles/closing-a-project/ + - /articles/closing-a-project - /articles/closing-a-project-board - /github/managing-your-work-on-github/closing-a-project-board versions: @@ -14,21 +14,22 @@ versions: topics: - Pull requests --- - {% data reusables.projects.project_boards_old %} -プロジェクトボードをクローズすると、設定されたワークフローの自動化はデフォルトですべて停止します。 +When you close a project board, any configured workflow automation will pause by default. -プロジェクトボードを再びオープンする場合、自動化を*同期*するよう設定することができます。それにより、ボードに設定されている自動化設定に従ってボード上のカードのポジションが更新されます。 詳しい情報については、「[クローズされたプロジェクトボードを再びオープンする](/articles/reopening-a-closed-project-board)」や「[プロジェクトボードの自動化について](/articles/about-automation-for-project-boards)」を参照してください。 +If you reopen a project board, you have the option to *sync* automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[Reopening a closed project board](/articles/reopening-a-closed-project-board)" or "[About automation for project boards](/articles/about-automation-for-project-boards)." -1. リポジトリまたは Organization の、またはあなたのユーザアカウントが所有する、プロジェクトボードの一覧に移動します。 -2. プロジェクトリストで、クローズしたいプロジェクトボードの隣にある {% octicon "chevron-down" aria-label="The chevron icon" %}をクリックします。 ![プロジェクトボードの名前の右にある、V 字型のアイコン](/assets/images/help/projects/project-list-action-chevron.png) -3. [**Close**] をクリックします。 ![プロジェクトボードのドロップダウンメニューにある [Close] アイテム](/assets/images/help/projects/close-project.png) +1. Navigate to list of project boards in your repository or organization, or owned by your user account. +2. In the projects list, next to the project board you want to close, click {% octicon "chevron-down" aria-label="The chevron icon" %}. +![Chevron icon to the right of the project board's name](/assets/images/help/projects/project-list-action-chevron.png) +3. Click **Close**. +![Close item in the project board's drop-down menu](/assets/images/help/projects/close-project.png) -## 参考リンク +## Further reading -- [プロジェクトボードについて](/articles/about-project-boards) -- [プロジェクトボードの削除](/articles/deleting-a-project-board) -- [リポジトリ内のプロジェクトボードを無効化](/articles/disabling-project-boards-in-a-repository) -- "[Organization 内のプロジェクトボードの無効化](/articles/disabling-project-boards-in-your-organization)" -- [Organization のプロジェクトボード権限](/articles/project-board-permissions-for-an-organization) +- "[About project boards](/articles/about-project-boards)" +- "[Deleting a project board](/articles/deleting-a-project-board)" +- "[Disabling project boards in a repository](/articles/disabling-project-boards-in-a-repository)" +- "[Disabling project boards in your organization](/articles/disabling-project-boards-in-your-organization)" +- "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)" diff --git a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md index b324f1e459..712cb6f12d 100644 --- a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md +++ b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md @@ -1,9 +1,9 @@ --- -title: プロジェクトボードの作成 -intro: プロジェクトボードは、特定機能の働きの追跡と優先度付け、総合的なロードマップ、さらにはリリースチェックリストなど、ニーズを満たすカスタマイズワークフローを作成するために使用できます。 +title: Creating a project board +intro: 'Project boards can be used to create customized workflows to suit your needs, like tracking and prioritizing specific feature work, comprehensive roadmaps, or even release checklists.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/creating-a-project-board - - /articles/creating-a-project/ + - /articles/creating-a-project - /articles/creating-a-project-board - /github/managing-your-work-on-github/creating-a-project-board versions: @@ -18,25 +18,25 @@ topics: - Project management type: how_to --- - {% data reusables.projects.project_boards_old %} {% data reusables.project-management.use-automated-template %} {% data reusables.project-management.copy-project-boards %} -{% data reusables.project-management.link-repos-to-project-board %}詳細は「[リポジトリをプロジェクトボードにリンクする](/articles/linking-a-repository-to-a-project-board)」を参照してください。 +{% data reusables.project-management.link-repos-to-project-board %} For more information, see "[Linking a repository to a project board](/articles/linking-a-repository-to-a-project-board)." -プロジェクトボードの作成が完了すると、そこへ Issue、プルリクエスト、およびノートを追加できます。 詳細は「[プロジェクトボードに Issue およびプルリクエストを追加する](/articles/adding-issues-and-pull-requests-to-a-project-board)」および「[プロジェクトボードにノートを追加する](/articles/adding-notes-to-a-project-board)」を参照してください。 +Once you've created your project board, you can add issues, pull requests, and notes to it. For more information, see "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)" and "[Adding notes to a project board](/articles/adding-notes-to-a-project-board)." -また、プロジェクトボードが Issue やプルリクエストのステータスと同期を保てるよう、ワークフローの自動化を設定することもできます。 詳しい情報については「[プロジェクトボードの自動化について](/articles/about-automation-for-project-boards)」を参照してください。 +You can also configure workflow automations to keep your project board in sync with the status of issues and pull requests. For more information, see "[About automation for project boards](/articles/about-automation-for-project-boards)." {% data reusables.project-management.project-board-import-with-api %} -## ユーザが所有するプロジェクトボードの作成 +## Creating a user-owned project board {% data reusables.profile.access_profile %} -2. プロフィールページの一番上のメインナビゲーションにある{% octicon "project" aria-label="The project board icon" %}[**Projects**] をクリックします。 ![プロジェクトタブ](/assets/images/help/projects/user-projects-tab.png) +2. On the top of your profile page, in the main navigation, click {% octicon "project" aria-label="The project board icon" %} **Projects**. +![Project tab](/assets/images/help/projects/user-projects-tab.png) {% data reusables.project-management.click-new-project %} {% data reusables.project-management.create-project-name-description %} {% data reusables.project-management.choose-template %} @@ -52,7 +52,7 @@ type: how_to {% data reusables.project-management.edit-project-columns %} -## Organization 全体のプロジェクトボードの作成 +## Creating an organization-wide project board {% data reusables.profile.access_org %} {% data reusables.user_settings.access_org %} @@ -72,10 +72,11 @@ type: how_to {% data reusables.project-management.edit-project-columns %} -## リポジトリのプロジェクトボードの作成 +## Creating a repository project board {% data reusables.repositories.navigate-to-repo %} -2. リポジトリ名の下にある {% octicon "project" aria-label="The project board icon" %}[**Projects**] をクリックします。 ![プロジェクトタブ](/assets/images/help/projects/repo-tabs-projects.png) +2. Under your repository name, click {% octicon "project" aria-label="The project board icon" %} **Projects**. +![Project tab](/assets/images/help/projects/repo-tabs-projects.png) {% data reusables.project-management.click-new-project %} {% data reusables.project-management.create-project-name-description %} {% data reusables.project-management.choose-template %} @@ -89,11 +90,10 @@ type: how_to {% data reusables.project-management.edit-project-columns %} -## 参考リンク +## Further reading -- "[プロジェクトボードについて](/articles/about-project-boards)" -- [プロジェクトボードの編集](/articles/editing-a-project-board){% ifversion fpt or ghec %} -- [プロジェクトボードのコピー](/articles/copying-a-project-board) -{% endif %} -- "[プロジェクトボードをクローズする](/articles/closing-a-project-board)" -- [プロジェクトボードの自動化について](/articles/about-automation-for-project-boards) +- "[About projects boards](/articles/about-project-boards)" +- "[Editing a project board](/articles/editing-a-project-board)"{% ifversion fpt or ghec %} +- "[Copying a project board](/articles/copying-a-project-board)"{% endif %} +- "[Closing a project board](/articles/closing-a-project-board)" +- "[About automation for project boards](/articles/about-automation-for-project-boards)" diff --git a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md index 2109d6ed58..1c13437734 100644 --- a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md +++ b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md @@ -1,9 +1,9 @@ --- -title: プロジェクトボードの削除 -intro: 既存のプロジェクトボードのコンテンツにアクセスする必要がない場合、削除することができます。 +title: Deleting a project board +intro: You can delete an existing project board if you no longer need access to its contents. redirect_from: - /github/managing-your-work-on-github/managing-project-boards/deleting-a-project-board - - /articles/deleting-a-project/ + - /articles/deleting-a-project - /articles/deleting-a-project-board - /github/managing-your-work-on-github/deleting-a-project-board versions: @@ -14,23 +14,23 @@ versions: topics: - Pull requests --- - {% data reusables.projects.project_boards_old %} {% tip %} -**参考**: 完了したあるいは不要なプロジェクトボードへのアクセスを維持し、そのコンテンツへのアクセスも失いたくない場合、削除する代わりに[プロジェクトボードを閉じる](/articles/closing-a-project-board)ことができます。 +**Tip**: If you'd like to retain access to a completed or unneeded project board without losing access to its contents, you can [close the project board](/articles/closing-a-project-board) instead of deleting it. {% endtip %} -1. 削除対象のプロジェクトボードに移動します。 +1. Navigate to the project board you want to delete. {% data reusables.project-management.click-menu %} {% data reusables.project-management.click-edit-sidebar-menu-project-board %} -4. [**Delete project**] をクリックします。 ![[Delete project] ボタン](/assets/images/help/projects/delete-project-button.png) -5. プロジェクトボードの削除を確定するには [**OK**] をクリックします。 +4. Click **Delete project**. +![Delete project button](/assets/images/help/projects/delete-project-button.png) +5. To confirm that you want to delete the project board, click **OK**. -## 参考リンク +## Further reading -- "[プロジェクトボードをクローズする](/articles/closing-a-project-board)" -- [リポジトリ内のプロジェクトボードを無効化](/articles/disabling-project-boards-in-a-repository) -- "[Organization 内のプロジェクトボードの無効化](/articles/disabling-project-boards-in-your-organization)" +- "[Closing a project board](/articles/closing-a-project-board)" +- "[Disabling project boards in a repository](/articles/disabling-project-boards-in-a-repository)" +- "[Disabling project boards in your organization](/articles/disabling-project-boards-in-your-organization)" diff --git a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md index 985a494dec..e80b1eec6e 100644 --- a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md +++ b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md @@ -1,10 +1,10 @@ --- -title: プロジェクトボードの編集 -intro: 既存のプロジェクトボードのタイトルと説明を編集できます。 +title: Editing a project board +intro: You can edit the title and description of an existing project board. redirect_from: - /github/managing-your-work-on-github/managing-project-boards/editing-a-project-board - - /articles/editing-a-project/ - - /articles/editing-and-deleting-a-project/ + - /articles/editing-a-project + - /articles/editing-and-deleting-a-project - /articles/editing-a-project-board - /github/managing-your-work-on-github/editing-a-project-board versions: @@ -15,22 +15,22 @@ versions: topics: - Pull requests --- - {% data reusables.projects.project_boards_old %} {% tip %} -**ヒント:** プロジェクトボード内での列の追加、削除、編集の詳細については、「[プロジェクトボードの作成](/articles/creating-a-project-board)」を参照してください。 +**Tip:** For details on adding, removing, or editing columns in your project board, see "[Creating a project board](/articles/creating-a-project-board)." {% endtip %} -1. 編集するプロジェクトボードに移動します。 +1. Navigate to the project board you want to edit. {% data reusables.project-management.click-menu %} -{% data reusables.project-management.click-edit-sidebar-menu-project-board %} -4. プロジェクトボードの名前と説明を必要に応じて修正し、[**Save project**] をクリックします。 ![プロジェクトボードの名前と説明欄に記入し、[Save project] ボタンをクリックします。](/assets/images/help/projects/edit-project-board-save-button.png) +{% data reusables.project-management.click-edit-sidebar-menu-project-board %} +4. Modify the project board name and description as needed, then click **Save project**. +![Fields with the project board name and description, and Save project button](/assets/images/help/projects/edit-project-board-save-button.png) -## 参考リンク +## Further reading -- [プロジェクトボードについて](/articles/about-project-boards) -- [プロジェクトボードへの Issue およびプルリクエストの追加](/articles/adding-issues-and-pull-requests-to-a-project-board) -- [プロジェクトボードの削除](/articles/deleting-a-project-board) +- "[About project boards](/articles/about-project-boards)" +- "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)" +- "[Deleting a project board](/articles/deleting-a-project-board)" diff --git a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md index e2e4b51965..6c67376231 100644 --- a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md +++ b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md @@ -1,9 +1,9 @@ --- -title: プロジェクトボードへの Issue およびプルリクエストの追加 -intro: Issue やプルリクエストはカードの形でプロジェクトボードに追加し、列にトリアージしていくことができます。 +title: Adding issues and pull requests to a project board +intro: You can add issues and pull requests to a project board in the form of cards and triage them into columns. redirect_from: - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board - - /articles/adding-issues-and-pull-requests-to-a-project/ + - /articles/adding-issues-and-pull-requests-to-a-project - /articles/adding-issues-and-pull-requests-to-a-project-board - /github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board versions: @@ -13,61 +13,67 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: ボードへのIssueとPRの追加 +shortTitle: Add issues & PRs to board --- - {% data reusables.projects.project_boards_old %} -以下のようにして、プロジェクトボードに Issue またはプルリクエストカードを追加できます: -- サイドバーの [**Triage**] セクションからカードをドラッグする。 -- Issue またはプルリクエストの URL をカード内に入力する。 -- プロジェクトボードの検索サイドバーで Issue またはプルリクエストを検索する。 +You can add issue or pull request cards to your project board by: +- Dragging cards from the **Triage** section in the sidebar. +- Typing the issue or pull request URL in a card. +- Searching for issues or pull requests in the project board search sidebar. -各プロジェクト列には最大 2,500 のカードを置くことができます。 列のカード数が最大に達すると、その列にカードを移動させることはできません。 +You can put a maximum of 2,500 cards into each project column. If a column has reached the maximum number of cards, no cards can be moved into that column. -![トリアージサイドバーからプロジェクトボードの列へ Issue カードを移動させるカーソル](/assets/images/help/projects/add-card-from-sidebar.gif) +![Cursor moves issue card from triaging sidebar to project board column](/assets/images/help/projects/add-card-from-sidebar.gif) {% note %} -**注釈:** ノートをタスクのリマインダ、{% data variables.product.product_name %} 上の任意のリポジトリからの Issue やプルリクエストへの参照、プロジェクトボードへの関連情報の追加として働くようにプロジェクトボードに追加することもできます。 詳細は「[プロジェクトボードにノートを追加する](/articles/adding-notes-to-a-project-board)」を参照してください。 +**Note:** You can also add notes to your project board to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.product_name %}, or to add related information to your project board. For more information, see "[Adding notes to a project board](/articles/adding-notes-to-a-project-board)." {% endnote %} {% data reusables.project-management.edit-in-project %} -{% data reusables.project-management.link-repos-to-project-board %}プロジェクトボードに追加するために Issue やプルリクエストを検索する場合、自動的にその検索の対象はリンクされたリポジトリになります。 それらの条件を取り除いて、Organization のすべてのリポジトリを対象に検索することができます。 詳しい情報については、「[リポジトリをプロジェクトボードにリンクする](/articles/linking-a-repository-to-a-project-board)」を参照してください。 +{% data reusables.project-management.link-repos-to-project-board %} When you search for issues and pull requests to add to your project board, the search automatically scopes to your linked repositories. You can remove these qualifiers to search within all organization repositories. For more information, see "[Linking a repository to a project board](/articles/linking-a-repository-to-a-project-board)." -## プロジェクトボードへの Issue およびプルリクエストの追加 +## Adding issues and pull requests to a project board -1. Issue およびプルリクエストを追加するプロジェクトボードに移動します。 -2. プロジェクトボードで {% octicon "plus" aria-label="The plus icon" %} [**Add cards**] をクリックします。 ![カードの追加ボタン](/assets/images/help/projects/add-cards-button.png) -3. 検索条件を使って、プロジェクトボードに追加したい Issue と Pull Request を検索してください。 利用できる検索条件に関する詳しい情報については「[Issue を検索する](/articles/searching-issues)」を参照してください。 ![Issue およびプルリクエストを検索](/assets/images/help/issues/issues_search_bar.png) +1. Navigate to the project board where you want to add issues and pull requests. +2. In your project board, click {% octicon "plus" aria-label="The plus icon" %} **Add cards**. +![Add cards button](/assets/images/help/projects/add-cards-button.png) +3. Search for issues and pull requests to add to your project board using search qualifiers. For more information on search qualifiers you can use, see "[Searching issues](/articles/searching-issues)." + ![Search issues and pull requests](/assets/images/help/issues/issues_search_bar.png) {% tip %} - **参考:** - - Issue あるいはプルリクエストの URL をカード内でタイプして、それらを追加することもできます。 - - 特定の機能について作業をしているなら、その機能に関連する Issue あるいはプルリクエストにラベルを適用して、そのラベル名を検索することでプロジェクトボードに簡単にカードを追加することができます。 詳細は「[Issue およびプルリクエストへのラベルの適用](/articles/applying-labels-to-issues-and-pull-requests)」を参照してください。 + **Tips:** + - You can also add an issue or pull request by typing the URL in a card. + - If you're working on a specific feature, you can apply a label to each related issue or pull request for that feature, and then easily add cards to your project board by searching for the label name. For more information, see "[Apply labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests)." {% endtip %} -4. フィルタリングされた Issue とプルリクエストのリストから、プロジェクトボードに追加したいカードをドラッグして、正しい列にドロップします。 あるいは、キーボードショートカットを使ってカードを移動させることもできます。 {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} +4. From the filtered list of issues and pull requests, drag the card you'd like to add to your project board and drop it in the correct column. Alternatively, you can move cards using keyboard shortcuts. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} {% tip %} - **ヒント:** ドラッグアンドドロップやキーボードのショートカットを使用してカードを並び替えたり列間で移動させたりできます。 {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} + **Tip:** You can drag and drop or use keyboard shortcuts to reorder cards and move them between columns. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} {% endtip %} -## サイドバーからのプロジェクトボードへの Issue およびプルリクエストの追加 +## Adding issues and pull requests to a project board from the sidebar -1. Issue あるいはプルリクエストの右側で、[**Projects {% octicon "gear" aria-label="The Gear icon" %}**] をクリックします。 ![サイドバーのプロジェクトボードボタン](/assets/images/help/projects/sidebar-project.png) -2. 追加したいプロジェクトボードの [**Recent**]、[**Repository**]、[**User**]、[**Organization**] タブをクリックします。 ![Recent、Repository、Organization タブ](/assets/images/help/projects/sidebar-project-tabs.png) -3. [**Filter projects**] フィールドにプロジェクト名を入力します。 ![プロジェクトボードの検索ボックス](/assets/images/help/projects/sidebar-search-project.png) -4. Issueまたはプルリクエストを追加する1つ以上のプロジェクトボードを選択します。 ![選択されたプロジェクトボード](/assets/images/help/projects/sidebar-select-project.png) -5. {% octicon "triangle-down" aria-label="The down triangle icon" %} をクリックし、Issueまたはプルリクエストが必要な列をクリックします。 カードが、選択したプロジェクトボードの列の下部に移動します。 ![[Move card to column] メニュー](/assets/images/help/projects/sidebar-select-project-board-column-menu.png) +1. On the right side of an issue or pull request, click **Projects {% octicon "gear" aria-label="The Gear icon" %}**. + ![Project board button in sidebar](/assets/images/help/projects/sidebar-project.png) +2. Click the **Recent**, **Repository**,**User**, or **Organization** tab for the project board you would like to add to. + ![Recent, Repository and Organization tabs](/assets/images/help/projects/sidebar-project-tabs.png) +3. Type the name of the project in **Filter projects** field. + ![Project board search box](/assets/images/help/projects/sidebar-search-project.png) +4. Select one or more project boards where you want to add the issue or pull request. + ![Selected project board](/assets/images/help/projects/sidebar-select-project.png) +5. Click {% octicon "triangle-down" aria-label="The down triangle icon" %}, then click the column where you want your issue or pull request. The card will move to the bottom of the project board column you select. + ![Move card to column menu](/assets/images/help/projects/sidebar-select-project-board-column-menu.png) -## 参考リンク +## Further reading -- [プロジェクトボードについて](/articles/about-project-boards) -- [プロジェクトボードの編集](/articles/editing-a-project-board) -- 「[プロジェクトボードでカードをフィルタリングする](/articles/filtering-cards-on-a-project-board)」 +- "[About project boards](/articles/about-project-boards)" +- "[Editing a project board](/articles/editing-a-project-board)" +- "[Filtering cards on a project board](/articles/filtering-cards-on-a-project-board)" diff --git a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md index 8bf6b70449..2cf815d675 100644 --- a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md +++ b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md @@ -1,9 +1,9 @@ --- -title: プロジェクトボードへのノートの追加 -intro: タスクリマインダーとして働くノートや、プロジェクトボードに関連する情報を追加するためのノートをプロジェクトボードに追加できます。 +title: Adding notes to a project board +intro: You can add notes to a project board to serve as task reminders or to add information related to the project board. redirect_from: - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/adding-notes-to-a-project-board - - /articles/adding-notes-to-a-project/ + - /articles/adding-notes-to-a-project - /articles/adding-notes-to-a-project-board - /github/managing-your-work-on-github/adding-notes-to-a-project-board versions: @@ -13,66 +13,72 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: ボードへのノートの追加 +shortTitle: Add notes to board --- - {% data reusables.projects.project_boards_old %} {% tip %} -**参考:** -- ノートは、Markdown の構文で書式設定できます。 たとえばヘッディング、リンク、タスクリスト、絵文字を使うことができます。 詳しい情報については[基本的な書き方とフォーマットの構文](/articles/basic-writing-and-formatting-syntax)を参照してください。 -- ドラッグアンドドロップやキーボードのショートカットを使用してノートを並び替えたり列間で移動させたりできます。 {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} -- ノートを追加するには、少なくとも 1 つの列がプロジェクトボードになければなりません。 詳しい情報については[プロジェクトボードの作成](/articles/creating-a-project-board)を参照してください。 +**Tips:** +- You can format your note using Markdown syntax. For example, you can use headings, links, task lists, or emoji. For more information, see "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)." +- You can drag and drop or use keyboard shortcuts to reorder notes and move them between columns. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} +- Your project board must have at least one column before you can add notes. For more information, see "[Creating a project board](/articles/creating-a-project-board)." {% endtip %} -Issue、プルリクエスト、あるいは他のプロジェクトボードの URL をノートに追加すると、テキストの下のサマリーカードにプレビューが表示されます。 +When you add a URL for an issue, pull request, or another project board to a note, you'll see a preview in a summary card below your text. -![Issue および他のプロジェクトボードのプレビューを表示しているプロジェクトボードカード](/assets/images/help/projects/note-with-summary-card.png) +![Project board cards showing a preview of an issue and another project board](/assets/images/help/projects/note-with-summary-card.png) -## プロジェクトボードへのノートの追加 +## Adding notes to a project board -1. ノートを追加したいプロジェクトボードに移動します。 -2. ノートを追加したい列で {% octicon "plus" aria-label="The plus icon" %} をクリックします。 ![列ヘッダ内のプラスアイコン](/assets/images/help/projects/add-note-button.png) -3. ノートを入力し、[**Add**] をクリックします。 ![ノートの入力フィールドとカードの追加ボタン](/assets/images/help/projects/create-and-add-note-button.png) +1. Navigate to the project board where you want to add notes. +2. In the column you want to add a note to, click {% octicon "plus" aria-label="The plus icon" %}. +![Plus icon in the column header](/assets/images/help/projects/add-note-button.png) +3. Type your note, then click **Add**. +![Field for typing a note and Add card button](/assets/images/help/projects/create-and-add-note-button.png) {% tip %} - **ヒント:** ノート内では、Issue やプルリクエストの URL をカード内に入力してそれらを参照できます。 + **Tip:** You can reference an issue or pull request in your note by typing its URL in the card. {% endtip %} -## ノートの Issue への変換 +## Converting a note to an issue -ノートを作成した後に、それでは必要を十分満たせないことが分かった場合、Issue に変換できます。 +If you've created a note and find that it isn't sufficient for your needs, you can convert it to an issue. -ノートを Issue に変換した場合、ノートの内容を使って Issue が自動的に作成されます。 ノートの先頭行が Issue のタイトルになり、ノートのそれ以降の内容が Issue の説明に追加されます。 +When you convert a note to an issue, the issue is automatically created using the content from the note. The first line of the note will be the issue title and any additional content from the note will be added to the issue description. {% tip %} -**ヒント:** ノートの本体には誰かへの @メンション、他の Issue あるいはプルリクエストへのリンクを追加したり、絵文字を追加したりできます。 これらの {% data variables.product.prodname_dotcom %}形式の Markdown の機能はプロジェクトボードのノート内ではサポートされていませんが、ノートが Issue に変換されれば、正しく表示されるようになります。 これらの機能の使い方に関する詳しい情報については[{% data variables.product.prodname_dotcom %}上での書き込みと書式設定について](/articles/about-writing-and-formatting-on-github)を参照してください。 +**Tip:** You can add content in the body of your note to @mention someone, link to another issue or pull request, and add emoji. These {% data variables.product.prodname_dotcom %} Flavored Markdown features aren't supported within project board notes, but once your note is converted to an issue, they'll appear correctly. For more information on using these features, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github)." {% endtip %} -1. Issue に変換したいノートにアクセスしてください。 +1. Navigate to the note that you want to convert to an issue. {% data reusables.project-management.project-note-more-options %} -3. [**Convert to issue**] をクリックします。 ![[Convert to issue] ボタン](/assets/images/help/projects/convert-to-issue.png) -4. カードが Organization 全体のプロジェクトボード上にあるなら、ドロップダウンメニューから Issue を追加したいリポジトリを選択してください。 ![Issue を作成できるリポジトリのリストを示しているドロップダウンメニュー](/assets/images/help/projects/convert-note-choose-repository.png) -5. 事前に記入された Issue のタイトルを編集することもできます。そして Issue の本文を入力してください。 ![Issue のタイトルと本体のためのフィールド](/assets/images/help/projects/convert-note-issue-title-body.png) -6. [**Convert to issue**] をクリックします。 -7. ノートは自動的に Issue に変換されます。 プロジェクトボードでは、新しい Issue のカードが以前のノートと同じ場所に置かれます。 +3. Click **Convert to issue**. + ![Convert to issue button](/assets/images/help/projects/convert-to-issue.png) +4. If the card is on an organization-wide project board, in the drop-down menu, choose the repository you want to add the issue to. + ![Drop-down menu listing repositories where you can create the issue](/assets/images/help/projects/convert-note-choose-repository.png) +5. Optionally, edit the pre-filled issue title, and type an issue body. + ![Fields for issue title and body](/assets/images/help/projects/convert-note-issue-title-body.png) +6. Click **Convert to issue**. +7. The note is automatically converted to an issue. In the project board, the new issue card will be in the same location as the previous note. -## ノートの編集と削除 +## Editing and removing a note -1. 編集あるいは削除したいノートにアクセスします。 +1. Navigate to the note that you want to edit or remove. {% data reusables.project-management.project-note-more-options %} -3. ノートの内容を編集したい場合には、**[Edit note]** をクリックしてください。 ![ノートの編集ボタン](/assets/images/help/projects/edit-note.png) -4. ノートの内容を削除するには、[**Delete note**] をクリックします。 ![ノートの削除ボタン](/assets/images/help/projects/delete-note.png) +3. To edit the contents of the note, click **Edit note**. + ![Edit note button](/assets/images/help/projects/edit-note.png) +4. To delete the contents of the notes, click **Delete note**. + ![Delete note button](/assets/images/help/projects/delete-note.png) -## 参考リンク +## Further reading -- [プロジェクトボードについて](/articles/about-project-boards) -- [プロジェクトボードの作成](/articles/creating-a-project-board) -- [プロジェクトボードの編集](/articles/editing-a-project-board) -- [プロジェクトボードへの Issue およびプルリクエストの追加](/articles/adding-issues-and-pull-requests-to-a-project-board) +- "[About project boards](/articles/about-project-boards)" +- "[Creating a project board](/articles/creating-a-project-board)" +- "[Editing a project board](/articles/editing-a-project-board)" +- "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)" diff --git a/translations/ja-JP/content/issues/tracking-your-work-with-issues/about-issues.md b/translations/ja-JP/content/issues/tracking-your-work-with-issues/about-issues.md index db4ca68dfc..ebd5ac6cf6 100644 --- a/translations/ja-JP/content/issues/tracking-your-work-with-issues/about-issues.md +++ b/translations/ja-JP/content/issues/tracking-your-work-with-issues/about-issues.md @@ -1,10 +1,10 @@ --- -title: Issueについて -intro: '{% data variables.product.prodname_github_issues %}を使って、{% data variables.product.company_short %}での作業に関するアイデア、フィードバック、タスク、バグを追跡してください。' +title: About issues +intro: 'Use {% data variables.product.prodname_github_issues %} to track ideas, feedback, tasks, or bugs for work on {% data variables.product.company_short %}.' redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-issues - - /articles/creating-issues/ - - /articles/about-issues/ + - /articles/creating-issues + - /articles/about-issues - /github/managing-your-work-on-github/about-issues - /issues/tracking-your-work-with-issues/creating-issues/about-issues versions: @@ -17,39 +17,38 @@ topics: - Issues - Project management --- +## Integrated with GitHub -## GitHubとの統合 +Issues let you track your work on {% data variables.product.company_short %}, where development happens. When you mention an issue in another issue or pull request, the issue's timeline reflects the cross-reference so that you can keep track of related work. To indicate that work is in progress, you can link an issue to a pull request. When the pull request merges, the linked issue automatically closes. -Issueを使って、開発が行われる{% data variables.product.company_short %}上での作業を追跡できます。 他のIssueもしくはPull Request内のIssueにメンションすると、そのIssueのタイムラインにはクロスリファレンスが反映され、関連する作業を追跡できるようになります。 作業が進行中であることを示すために、Pull RequestにIssueをリンクできます。 Pull Requestがマージされると、リンクされたIssueは自動的にクローズされます。 +## Quickly create issues -## 素早いIssueの作成 +Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository,{% ifversion fpt or ghec %} an item in a task list,{% endif %} a note in a project, a comment in an issue or pull request, a specific line of code, or a URL query. You can also create an issue from your platform of choice: through the web UI, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_cli %}, GraphQL and REST APIs, or {% data variables.product.prodname_mobile %}. For more information, see "[Creating an issue](/issues/tracking-your-work-with-issues/creating-issues/creating-an-issue)." -Issueは様々な方法で作成できるので、ワークフローで最も便利な方法を選択できます。 Issueの作成は、たとえばリポジトリから、{% ifversion fpt or ghec %}タスクリストのアイテムから、{% endif %}プロジェクトのノート、IssueあるいはPull Requestのコメント、コードの特定の行、URLクエリから作成できます。 Issueは、Web UI、{% data variables.product.prodname_desktop %}、{% data variables.product.prodname_cli %}、GraphQL及びREST API、{% data variables.product.prodname_mobile %}といった好きなプラットフォームから作成することもできます。 詳しい情報については、「[Issue を作成する](/issues/tracking-your-work-with-issues/creating-issues/creating-an-issue)」を参照してください。 +## Track work -## 作業の追跡 +You can organize and prioritize issues with projects. {% ifversion fpt or ghec %}To track issues as part of a larger issue, you can use task lists.{% endif %} To categorize related issues, you can use labels and milestones. -プロジェクトで、Issueを整理して優先順位付けできます。 {% ifversion fpt or ghec %}大きなIssueの一部であるIssueを追跡するには、タスクリストが使えます。{% endif %}関連するIssueを分類するには、ラベルとマイルストーンが使えます。 +For more information about projects, see {% ifversion fpt or ghec %}"[About projects (beta)](/issues/trying-out-the-new-projects-experience/about-projects)" and {% endif %}"[Organizing your work with project boards](/issues/organizing-your-work-with-project-boards)." {% ifversion fpt or ghec %}For more information about task lists, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." {% endif %}For more information about labels and milestones, see "[Using labels and milestones to track work](/issues/using-labels-and-milestones-to-track-work)." -プロジェクトに関する詳しい情報については{% ifversion fpt or ghec %}「[プロジェクト（ベータ）について](/issues/trying-out-the-new-projects-experience/about-projects)」及び{% endif %}「[プロジェクトボードでの作業の整理](/issues/organizing-your-work-with-project-boards)」を参照してください。 {% ifversion fpt or ghec %}タスクリストに関する詳しい情報については「[タスクリストについて](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)」を参照してください。 {% endif %}ラベルとマイルストーンに関する詳しい情報については「[作業を追跡するためのラベルとマイルストーンの利用](/issues/using-labels-and-milestones-to-track-work)」を参照してください。 +## Stay up to date -## 最新情報の確認 +To stay updated on the most recent comments in an issue, you can subscribe to an issue to receive notifications about the latest comments. To quickly find links to recently updated issues you're subscribed to, visit your dashboard. For more information, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}" and "[About your personal dashboard](/articles/about-your-personal-dashboard)." -Issueの最新のコメントの情報を得ておきたい場合には、Issueをサブスクライブして最新のコメントに関する通知を受け取ることができます。 サブスクライブした Issue の最新の更新へのリンクを素早く見つけるには、ダッシュボードにアクセスしてください。 詳しい情報については{% ifversion fpt or ghes or ghae or ghec %}「[通知について](/github/managing-subscriptions-and-notifications-on-github/about-notifications)」{% else %}「[通知について](/github/receiving-notifications-about-activity-on-github/about-notifications)」{% endif %}及び「[個人ダッシュボードについて](/articles/about-your-personal-dashboard)」を参照してください。 +## Community management -## コミュニティの管理 +To help contributors open meaningful issues that provide the information that you need, you can use {% ifversion fpt or ghec %}issue forms and {% endif %}issue templates. For more information, see "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)." -必要な情報を提供する、意味のあるIssueをコントリビューターがオープンするのを支援するために、{% ifversion fpt or ghec %}Issueフォームと{% endif %}Issueテンプレートが利用できます。 詳しい情報については「[有益なIssueとPull Requestを促進するためのテンプレートの利用](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)」を参照してください。 +{% ifversion fpt or ghec %}To maintain a healthy community, you can report comments that violate {% data variables.product.prodname_dotcom %}'s [Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). For more information, see "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)."{% endif %} -{% ifversion fpt or ghec %}コミュニティを健全に保つために、{% data variables.product.prodname_dotcom %}の[コミュニティガイドライン](/free-pro-team@latest/github/site-policy/github-community-guidelines)に違反するコメントを報告できます。 詳細は「[乱用やスパムをレポートする](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)」を参照してください。{% endif %} +## Efficient communication -## 効率的なコミュニケーション +You can @mention collaborators who have access to your repository in an issue to draw their attention to a comment. To link related issues in the same repository, you can type `#` followed by part of the issue title and then clicking the issue that you want to link. To communicate responsibility, you can assign issues. If you find yourself frequently typing the same comment, you can use saved replies. +{% ifversion fpt or ghec %} For more information, see "[Basic writing and formatting syntax](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" and "[Assigning issues and pull requests to other GitHub users](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)." -コメントに注意してもらうために、Issue内でリポジトリにアクセスできるコラボレータを@メンションできます。 同じリポジトリ内の関連するIssueをリンクするために、`#`につづいてIssueのタイトルの一部を続け、リンクしたいIssueをクリックできます。 責任を伝えるために、Issueを割り当てることができます。 同じコメントを頻繁に入力しているなら、返信テンプレートを利用できます。 -{% ifversion fpt or ghec %}詳しい情報については「[基本的な記述とフォーマットの構文](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)」及び「[他のGitHubユーザへのIssueやPull Requestの割り当て](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)」を参照してください。 +## Comparing issues and discussions -## Issueとディスカッションの比較 +Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see "[Communicating on GitHub](/github/getting-started-with-github/quickstart/communicating-on-github)." -Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} Issueあるいはディスカッションを使う場合のガイダンスについては「[GitHubでのコミュニケーション](/github/getting-started-with-github/quickstart/communicating-on-github)」を参照してください。 - -Issue内での会話にディスカッションの方が適している場合は、Issueをディスカッションに変換できます。 +When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion. {% endif %} diff --git a/translations/ja-JP/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md b/translations/ja-JP/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md index aa0b6278ba..8eca5faf19 100644 --- a/translations/ja-JP/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md +++ b/translations/ja-JP/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md @@ -1,10 +1,10 @@ --- -title: プルリクエストをIssueにリンクする -intro: プルリクエストをIssueにリンクして、修正が進行中であることを示し、プルリクエストがマージされるときIssueを自動的にクローズすることができます。 +title: Linking a pull request to an issue +intro: You can link a pull request to an issue to show that a fix is in progress and to automatically close the issue when the pull request is merged. redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/linking-a-pull-request-to-an-issue - - /articles/closing-issues-via-commit-message/ - - /articles/closing-issues-via-commit-messages/ + - /articles/closing-issues-via-commit-message + - /articles/closing-issues-via-commit-messages - /articles/closing-issues-using-keywords - /github/managing-your-work-on-github/closing-issues-using-keywords - /github/managing-your-work-on-github/linking-a-pull-request-to-an-issue @@ -16,26 +16,25 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: IssueへのPRのリンク +shortTitle: Link PR to issue --- - {% note %} -**注釈:** プルリクエストにおける特別なキーワードは、プルリクエストがリポジトリの*デフォルト* ブランチをターゲットするときに解釈されます。 ただし、PRのベースが*それ以外のブランチ*である場合、それらのキーワードは無視され、リンクは作成されません。PRのマージはこのIssueに対して何の効果も持ちません。 **キーワードの1つを使用してプルリクエストをIssueにリンクしたい場合は、PRがデフォルトブランチ上になければなりません。** +**Note:** The special keywords in a pull request description are interpreted when the pull request targets the repository's *default* branch. However, if the PR's base is *any other branch*, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** {% endnote %} -## リンクされたIssueとプルリクエストについて +## About linked issues and pull requests -{% ifversion fpt or ghes or ghae or ghec %}手動で、または{% endif %}プルリクエストの説明でサポートされているキーワードを使用して、Issueをプルリクエストにリンクすることができます。 +You can link an issue to a pull request {% ifversion fpt or ghes or ghae or ghec %}manually or {% endif %}using a supported keyword in the pull request description. -プルリクエストが対処するIssueにそのプルリクエストにリンクすると、コラボレータは、誰かがそのIssueに取り組んでいることを確認できます。 +When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. -リンクされたプルリクエストをリポジトリのデフォルトブランチにマージすると、それにリンクされているIssueは自動的にクローズされます。 デフォルトブランチの詳細については、「[デフォルトブランチを変更する](/github/administering-a-repository/changing-the-default-branch)」を参照してください。 +When you merge a linked pull request into the default branch of a repository, its linked issue is automatically closed. For more information about the default branch, see "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." -## キーワードを使用してプルリクエストをIssueにリンクする +## Linking a pull request to an issue using a keyword -プルリクエストの説明で、またはコミットメッセージで、サポートされているキーワードを使用してプルリクエストにIssueにリンクすることができます (プルリクエストはデフォルトブランチになければなりません)。 +You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message (please note that the pull request must be on the default branch). * close * closes @@ -43,39 +42,41 @@ shortTitle: IssueへのPRのリンク * fix * fixes * fixed -* 解決 +* resolve * resolves * resolved If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request will also close the referenced pull request. -クローズするキーワードの構文は、Issueがプルリクエストと同じリポジトリにあるかどうかによって異なります。 +The syntax for closing keywords depends on whether the issue is in the same repository as the pull request. -| リンクするIssue | 構文 | サンプル | -| ---------------- | --------------------------------------------- | -------------------------------------------------------------- | -| Issueが同じリポジトリにある | *KEYWORD* #*ISSUE-NUMBER* | `Closes #10` | -| Issueが別のリポジトリにある | *KEYWORD* *OWNER*/*REPOSITORY*#*ISSUE-NUMBER* | `Fixes octo-org/octo-repo#100` | -| 複数の Issue | Issueごとに完全な構文を使用 | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100` | +Linked issue | Syntax | Example +--------------- | ------ | ------ +Issue in the same repository | *KEYWORD* #*ISSUE-NUMBER* | `Closes #10` +Issue in a different repository | *KEYWORD* *OWNER*/*REPOSITORY*#*ISSUE-NUMBER* | `Fixes octo-org/octo-repo#100` +Multiple issues | Use full syntax for each issue | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100` -{% ifversion fpt or ghes or ghae or ghec %}手動でリンクを解除できるのは、手動でリンクされたプルリクエストだけです。 キーワードを使用してリンクしたIssueのリンクを解除するには、プルリクエストの説明を編集してそのキーワードを削除する必要があります。{% endif %} +{% ifversion fpt or ghes or ghae or ghec %}Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword.{% endif %} -クローズするキーワードは、コミットメッセージでも使用できます。 デフォルトブランチにコミットをマージするとIssueはクローズされますが、そのコミットを含むプルリクエストは、リンクされたプルリクエストとしてリストされません。 +You can also use closing keywords in a commit message. The issue will be closed when you merge the commit into the default branch, but the pull request that contains the commit will not be listed as a linked pull request. {% ifversion fpt or ghes or ghae or ghec %} -## 手動でプルリクエストをIssueにリンクする +## Manually linking a pull request to an issue -リポジトリへの書き込み権限があるユーザなら誰でも、手動でプルリクエストをIssueにリンクできます。 +Anyone with write permissions to a repository can manually link a pull request to an issue. -手動で1つのプルリクエストごとに最大10個のIssueをリンクできます。 Issueとプルリクエストは同じリポジトリになければなりません。 +You can manually link up to ten issues to each pull request. The issue and pull request must be in the same repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-pr %} -3. プルリクエストのリストで、Issueにリンクしたいプルリクエストをクリックします。 -4. 右のサイドバーで、[**Linked issues**] をクリックします。 ![右サイドバーの [Linked issues]](/assets/images/help/pull_requests/linked-issues.png) -5. プルリクエストにリンクするIssueをクリックします。 ![Issueをリンクするドロップダウン](/assets/images/help/pull_requests/link-issue-drop-down.png) +3. In the list of pull requests, click the pull request that you'd like to link to an issue. +4. In the right sidebar, click **Linked issues**. + ![Linked issues in the right sidebar](/assets/images/help/pull_requests/linked-issues.png) +5. Click the issue you want to link to the pull request. + ![Drop down to link issue](/assets/images/help/pull_requests/link-issue-drop-down.png) {% endif %} -## 参考リンク +## Further reading -- [自動リンクされた参照と URL](/articles/autolinked-references-and-urls/#issues-and-pull-requests) +- "[Autolinked references and URLs](/articles/autolinked-references-and-urls/#issues-and-pull-requests)" diff --git a/translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md b/translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md index 3c3792e698..c008e01a7b 100644 --- a/translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md +++ b/translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md @@ -1,9 +1,9 @@ --- -title: Issue とPull Requestのマイルストーンの作成と削除 -intro: リポジトリ内にある Issue やPull Requestのグループに関する進行状況を追跡するためのマイルストーンを作成できます。 +title: Creating and editing milestones for issues and pull requests +intro: You can create a milestone to track progress on groups of issues or pull requests in a repository. redirect_from: - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones/creating-and-editing-milestones-for-issues-and-pull-requests - - /articles/creating-milestones-for-issues-and-pull-requests/ + - /articles/creating-milestones-for-issues-and-pull-requests - /articles/creating-and-editing-milestones-for-issues-and-pull-requests - /github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests versions: @@ -15,30 +15,32 @@ topics: - Pull requests - Issues - Project management -shortTitle: マイルストーンの作成と編集 +shortTitle: Create & edit milestones type: how_to --- +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +{% data reusables.project-management.milestones %} +4. Choose one of these options: + - To create a new milestone, click **New Milestone**. + ![New milestone button](/assets/images/help/repository/new-milestone.png) + - To edit a milestone, next to the milestone you want to edit, click **Edit**. + ![Edit milestone option](/assets/images/help/repository/edit-milestone.png) +5. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**. Milestones will render Markdown syntax. For more information about Markdown syntax, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)." + +## Deleting milestones + +When you delete milestones, issues and pull requests are not affected. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.milestones %} -4. 以下のオプションから 1 つ選択します: - - 新しいマイルストーンを作成するには、[**New Milestone**] をクリックします。 ![[New milestone] ボタン](/assets/images/help/repository/new-milestone.png) - - マイルストーンを編集するには、編集対象のマイルストーンの隣にある [**Edit**] をクリックします。 ![マイルストーンの編集](/assets/images/help/repository/edit-milestone.png) -5. マイルストーンのタイトル、説明、その他の変更を入力し、[**Create milestone**] または [**Save changes**] をクリックします。 マイルストーンはMarkdown構文をレンダリングします。 Markdown構文に関する詳しい情報については「[基本的な書き込みとフォーマットの構文](/github/writing-on-github/basic-writing-and-formatting-syntax)」を参照してください。 +4. Next to the milestone you want to delete, click **Delete**. +![Delete milestone option](/assets/images/help/repository/delete-milestone.png) -## マイルストーンの削除 +## Further reading -マイルストーンを削除しても、Issue やPull Requestに影響はありません。 - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.milestones %} -4. 削除対象のマイルストーンの隣にある [**Delete**] をクリックします。 ![マイルストーンの削除](/assets/images/help/repository/delete-milestone.png) - -## 参考リンク - -- [マイルストーンについて](/articles/about-milestones) -- [Issue及びPull Requestとのマイルストーンの関連づけ](/articles/associating-milestones-with-issues-and-pull-requests) -- [マイルストーンの進捗の表示](/articles/viewing-your-milestone-s-progress) -- [マイルストーンによるIssue及びPull Requestのフィルタリング](/articles/filtering-issues-and-pull-requests-by-milestone) +- "[About milestones](/articles/about-milestones)" +- "[Associating milestones with issues and pull requests](/articles/associating-milestones-with-issues-and-pull-requests)" +- "[Viewing your milestone's progress](/articles/viewing-your-milestone-s-progress)" +- "[Filtering issues and pull requests by milestone](/articles/filtering-issues-and-pull-requests-by-milestone)" diff --git a/translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md b/translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md index edacdd65c0..f5f9e3b136 100644 --- a/translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md +++ b/translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md @@ -1,6 +1,6 @@ --- -title: ラベルを管理する -intro: 'ラベルの作成、編集、適用、削除によって、{% ifversion fpt or ghec %}Issue、Pull Request、ディスカッション{% else %}IssueとPull Request{% endif %}を分類できます。' +title: Managing labels +intro: 'You can classify {% ifversion fpt or ghec %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %} by creating, editing, applying, and deleting labels.' permissions: '{% data reusables.enterprise-accounts.emu-permission-repo %}' redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/managing-labels @@ -12,7 +12,7 @@ redirect_from: - /articles/creating-and-editing-labels-for-issues-and-pull-requests - /articles/creating-a-label - /github/managing-your-work-on-github/creating-a-label - - /articles/customizing-issue-labels/ + - /articles/customizing-issue-labels - /articles/applying-labels-to-issues-and-pull-requests - /github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests - /articles/editing-a-label @@ -31,42 +31,42 @@ topics: - Project management type: how_to --- - ## ラベルについて +## About labels -{% data variables.product.product_name %}上の作業を、{% ifversion fpt or ghec %}Issue、Pull Request、ディスカッション{% else %}IssueとPull Request{% endif %}を分類するためのラベルを作成することによって管理できます。 ラベルが作成されたリポジトリ内にラベルを適用できます。 ラベルがあれば、そのリポジトリ内の任意の{% ifversion fpt or ghec %}Issue、Pull Request、ディスカッション{% else %}IssueやPull Request{% endif %}にそのラベルを使用できます。 +You can manage your work on {% data variables.product.product_name %} by creating labels to categorize {% ifversion fpt or ghec %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %}. You can apply labels in the repository the label was created in. Once a label exists, you can use the label on any {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} within that repository. -## デフォルトラベルについて +## About default labels -{% data variables.product.product_name %} は、すべての新しいリポジトリにデフォルトのラベルを提供します。 これらのデフォルトラベルを使用して、リポジトリに標準のワークフローを作成しやすくすることができます。 +{% data variables.product.product_name %} provides default labels in every new repository. You can use these default labels to help create a standard workflow in a repository. -| ラベル | 説明 | -| ------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `bug` | 予想外の問題あるいは意図しない振る舞いを示します{% ifversion fpt or ghes or ghec %} -| `documentation` | ドキュメンテーションに改善や追加が必要であることを示します{% endif %} -| `duplicate` | 同様の{% ifversion fpt or ghec %}Issue、Pull Request、ディスカッション{% else %}IssueやPull Request{% endif %}を示します。 | -| `enhancement` | 新しい機能のリクエストを示します | -| `good first issue` | 初回のコントリビューターに適した Issue を示します | -| `help wanted` | メンテナーが Issue もしくはプルリクエストに助けを求めていることを示します | -| `invalid` | {% ifversion fpt or ghec %}Issue、Pull Request、ディスカッション{% else %}IssueやPull Request{% endif %}が関係なくなっていることを示します。 | -| `question` | {% ifversion fpt or ghec %}Issue、Pull Request、ディスカッション{% else %}IssueやPull Request{% endif %}にさらに情報が必要であることを示します。 | -| `wontfix` | {% ifversion fpt or ghec %}Issue、Pull Request、ディスカッション{% else %}IssueやPull Request{% endif %}に対する作業が継続されないことを示します。 | +Label | Description +--- | --- +`bug` | Indicates an unexpected problem or unintended behavior{% ifversion fpt or ghes or ghec %} +`documentation` | Indicates a need for improvements or additions to documentation{% endif %} +`duplicate` | Indicates similar {% ifversion fpt or ghec %}issues, pull requests, or discussions{% else %}issues or pull requests{% endif %} +`enhancement` | Indicates new feature requests +`good first issue` | Indicates a good issue for first-time contributors +`help wanted` | Indicates that a maintainer wants help on an issue or pull request +`invalid` | Indicates that an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} is no longer relevant +`question` | Indicates that an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} needs more information +`wontfix` | Indicates that work won't continue on an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} -リポジトリの作成時に、すべての新しいリポジトリにデフォルトのラベルが含められますが、後でそのラベルを編集または削除できます。 +Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later. -Issues with the `good first issue` label are used to populate the repository's `contribute` page. `contribute`ページの例については[github/docs/contribute](https://github.com/github/docs/contribute)を参照してください。 +Issues with the `good first issue` label are used to populate the repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute). {% ifversion fpt or ghes or ghec %} -Organization のオーナーは、Organization 内のリポジトリのためのデフォルトラベルをカスタマイズできます。 詳しい情報については、「[Organization 内のリポジトリのためのデフォルトラベルを管理する](/articles/managing-default-labels-for-repositories-in-your-organization)」を参照してください。 +Organization owners can customize the default labels for repositories in their organization. For more information, see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)." {% endif %} -## ラベルの作成 +## Creating a label Anyone with write access to a repository can create a label. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.labels %} -4. 検索フィールドの右にある、[**New label**] をクリックします。 +4. To the right of the search field, click **New label**. {% data reusables.project-management.name-label %} {% data reusables.project-management.label-description %} {% data reusables.project-management.label-color-randomizer %} @@ -76,10 +76,11 @@ Anyone with write access to a repository can create a label. Anyone with triage access to a repository can apply and dismiss labels. -1. {% ifversion fpt or ghec %}Issue、Pull Request、ディスカッション{% else %}IssueあるいはPull Request{% endif %}にアクセスしてください。 -1. 右のサイドバーで、"Labels（ラベル）"の右の{% octicon "gear" aria-label="The gear icon" %}をクリックし、続いてラベルをクリックしてください !["ラベル" ドロップダウンメニュー](/assets/images/help/issues/labels-drop-down.png) +1. Navigate to the {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %}. +1. In the right sidebar, to the right of "Labels", click {% octicon "gear" aria-label="The gear icon" %}, then click a label. + !["Labels" drop-down menu](/assets/images/help/issues/labels-drop-down.png) -## ラベルの編集 +## Editing a label Anyone with write access to a repository can edit existing labels. @@ -92,18 +93,18 @@ Anyone with write access to a repository can edit existing labels. {% data reusables.project-management.label-color-randomizer %} {% data reusables.project-management.save-label %} -## ラベルの削除 +## Deleting a label Anyone with write access to a repository can delete existing labels. -ラベルを削除すると、Issue とプルリクエストからラベルが削除されます。 +Deleting a label will remove the label from issues and pull requests. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.labels %} {% data reusables.project-management.delete-label %} -## 参考リンク +## Further reading - "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)"{% ifversion fpt or ghes or ghec %} -- 「[Organization 内のリポジトリのためのデフォルトラベルを管理する](/articles/managing-default-labels-for-repositories-in-your-organization)」{% endif %}{% ifversion fpt or ghec %} -- 「[ラベルを使用してプロジェクトに役立つコントリビューションを促す](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)」{% endif %} +- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"{% endif %}{% ifversion fpt or ghec %} +- "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)"{% endif %} diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md index dd40cb5a26..80fb7f8cb7 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -2,12 +2,12 @@ title: About GitHub Pages intro: 'You can use {% data variables.product.prodname_pages %} to host a website about yourself, your organization, or your project directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' redirect_from: - - /articles/what-are-github-pages/ - - /articles/what-is-github-pages/ - - /articles/user-organization-and-project-pages/ - - /articles/using-a-static-site-generator-other-than-jekyll/ - - /articles/mime-types-on-github-pages/ - - /articles/should-i-rename-usernamegithubcom-repositories-to-usernamegithubio/ + - /articles/what-are-github-pages + - /articles/what-is-github-pages + - /articles/user-organization-and-project-pages + - /articles/using-a-static-site-generator-other-than-jekyll + - /articles/mime-types-on-github-pages + - /articles/should-i-rename-usernamegithubcom-repositories-to-usernamegithubio - /articles/about-github-pages - /github/working-with-github-pages/about-github-pages product: '{% data reusables.gated-features.pages %}' diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md index b0134278c0..6f568026a7 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md @@ -1,9 +1,9 @@ --- -title: テーマ選択画面で GitHub Pages サイトにテーマを追加する -intro: 'サイトの見た目をカスタマイズするため、{% data variables.product.prodname_pages %} サイトにテーマを追加できます。' +title: Adding a theme to your GitHub Pages site with the theme chooser +intro: 'You can add a theme to your {% data variables.product.prodname_pages %} site to customize your site’s look and feel.' redirect_from: - - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser/ - - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser/ + - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser + - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser - /articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser product: '{% data reusables.gated-features.pages %}' @@ -12,37 +12,40 @@ versions: ghec: '*' topics: - Pages -shortTitle: Pagesサイトへのテーマの追加 +shortTitle: Add theme to a Pages site --- -リポジトリの管理者権限があるユーザは、{% data variables.product.prodname_pages %} サイトにテーマを追加するため、テーマ選択画面を使用できます。 +People with admin permissions for a repository can use the theme chooser to add a theme to a {% data variables.product.prodname_pages %} site. -## テーマ選択画面について +## About the theme chooser -テーマ選択画面は、リポジトリに Jekyll テーマを追加するためのものです。 Jekyll に関する詳しい情報については、「[{% data variables.product.prodname_pages %} と Jekyll](/articles/about-github-pages-and-jekyll)」を参照してください。 +The theme chooser adds a Jekyll theme to your repository. For more information about Jekyll, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." -テーマ選択画面の動作は、リポジトリがパブリックかプライベートかにより異なります。 - - {% data variables.product.prodname_pages %} がリポジトリに対して既に有効である場合、テーマ選択画面は、現在の公開元にテーマを追加します。 - - リポジトリがパブリックで、{% data variables.product.prodname_pages %} がリポジトリに対して無効である場合、テーマ選択画面を使用することで {% data variables.product.prodname_pages %} が有効となり、デフォルトブランチを公開元として設定します。 - - リポジトリがプライベートで、{% data variables.product.prodname_pages %}がリポジトリに対して無効である場合、テーマ選択画面を使用する前に、公開元を設定して {% data variables.product.prodname_pages %} を有効にする必要があります。 +How the theme chooser works depends on whether your repository is public or private. + - If {% data variables.product.prodname_pages %} is already enabled for your repository, the theme chooser will add your theme to the current publishing source. + - If your repository is public and {% data variables.product.prodname_pages %} is disabled for your repository, using the theme chooser will enable {% data variables.product.prodname_pages %} and configure the default branch as your publishing source. + - If your repository is private and {% data variables.product.prodname_pages %} is disabled for your repository, you must enable {% data variables.product.prodname_pages %} by configuring a publishing source before you can use the theme chooser. -公開元に関する詳しい情報については、「[{% data variables.product.prodname_pages %} について](/articles/about-github-pages#publishing-sources-for-github-pages-sites)」を参照してください。 +For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)." -Jekyll テーマをリポジトリに手動で追加したことがある場合には、それらのファイルが、テーマ選択画面を使用した後も適用されることがあります。 競合を避けるため、テーマ選択画面を使用する前に、手動で追加したテーマフォルダおよびファイルをすべて削除してください。 詳しい情報については、「[Jekyll を使用して {% data variables.product.prodname_pages %} サイトにテーマを追加する](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)」を参照してください。 +If you manually added a Jekyll theme to your repository in the past, those files may be applied even after you use the theme chooser. To avoid conflicts, remove all manually added theme folders and files before using the theme chooser. For more information, see "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." -## テーマ選択画面でテーマを追加する +## Adding a theme with the theme chooser {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -3. [{% data variables.product.prodname_pages %}] で、[**Choose a theme**] または [**Change theme**] をクリックします。 ![[Choose a theme] ボタン](/assets/images/help/pages/choose-a-theme.png) -4. ページ上部の、選択したいテーマをクリックし、[**Select theme**] をクリックします。 ![テーマのオプションおよび [Select theme] ボタン](/assets/images/help/pages/select-theme.png) -5. サイトの *README.md* ファイルを編集するようプロンプトが表示される場合があります。 - - ファイルを後で編集する場合、[**Cancel**] をクリックします。 ![ファイルを編集する際の [Cancel] リンク](/assets/images/help/pages/cancel-edit.png) +3. Under "{% data variables.product.prodname_pages %}," click **Choose a theme** or **Change theme**. + ![Choose a theme button](/assets/images/help/pages/choose-a-theme.png) +4. On the top of the page, click the theme you want, then click **Select theme**. + ![Theme options and Select theme button](/assets/images/help/pages/select-theme.png) +5. You may be prompted to edit your site's *README.md* file. + - To edit the file later, click **Cancel**. + ![Cancel link when editing a file](/assets/images/help/pages/cancel-edit.png) - To edit the file now, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." -選択したテーマは、リポジトリの Markdown ファイルに自動的に適用されます。 テーマをリポジトリの HTML ファイルに適用するには、各ファイルのレイアウトを指定する YAML front matter を追加する必要があります。 詳しい情報については、Jekyll サイトの「[Front Matter](https://jekyllrb.com/docs/front-matter/)」を参照してください。 +Your chosen theme will automatically apply to markdown files in your repository. To apply your theme to HTML files in your repository, you need to add YAML front matter that specifies a layout to each file. For more information, see "[Front Matter](https://jekyllrb.com/docs/front-matter/)" on the Jekyll site. -## 参考リンク +## Further reading -- Jekyll サイトの「[Themes](https://jekyllrb.com/docs/themes/)」 +- [Themes](https://jekyllrb.com/docs/themes/) on the Jekyll site diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index bdfed89c0b..5e931e4862 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -1,8 +1,8 @@ --- -title: GitHub Pages サイトの公開元を設定する -intro: '{% data variables.product.prodname_pages %} サイトでデフォルトの公開元を使用している場合、サイトは自動的に公開されます。 You can also choose to publish your site from a different branch or folder.' +title: Configuring a publishing source for your GitHub Pages site +intro: 'If you use the default publishing source for your {% data variables.product.prodname_pages %} site, your site will publish automatically. You can also choose to publish your site from a different branch or folder.' redirect_from: - - /articles/configuring-a-publishing-source-for-github-pages/ + - /articles/configuring-a-publishing-source-for-github-pages - /articles/configuring-a-publishing-source-for-your-github-pages-site - /github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site product: '{% data reusables.gated-features.pages %}' @@ -14,24 +14,41 @@ versions: ghec: '*' topics: - Pages -shortTitle: 公開ソースの設定 +shortTitle: Configure publishing source --- -公開元に関する詳しい情報については、「[{% data variables.product.prodname_pages %} について](/articles/about-github-pages#publishing-sources-for-github-pages-sites)」を参照してください。 +For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)." -## 公開元を選択する +## Choosing a publishing source Before you configure a publishing source, make sure the branch you want to use as your publishing source already exists in your repository. {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -3. [{% data variables.product.prodname_pages %}] で、[**None**] または [**Branch**] ドロップダウンメニューから公開元を選択します。 ![公開元を選択するドロップダウンメニュー](/assets/images/help/pages/publishing-source-drop-down.png) -4. 必要に応じて、ドロップダウンメニューで発行元のフォルダを選択します。 ![公開元のフォルダを選択するドロップダウンメニュー](/assets/images/help/pages/publishing-source-folder-drop-down.png) -5. [**Save**] をクリックします。 ![公開元の設定への変更を保存するボタン](/assets/images/help/pages/publishing-source-save.png) +3. Under "{% data variables.product.prodname_pages %}", use the **None** or **Branch** drop-down menu and select a publishing source. + ![Drop-down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) +4. Optionally, use the drop-down menu to select a folder for your publishing source. + ![Drop-down menu to select a folder for publishing source](/assets/images/help/pages/publishing-source-folder-drop-down.png) +5. Click **Save**. + ![Button to save changes to publishing source settings](/assets/images/help/pages/publishing-source-save.png) -## {% data variables.product.prodname_pages %} サイトの公開に関するトラブルシューティング +## Troubleshooting publishing problems with your {% data variables.product.prodname_pages %} site {% data reusables.pages.admin-must-push %} -If you choose the `docs` folder on any branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. 詳細については、「[{% data variables.product.prodname_pages %} サイトの Jekyll ビルドエラーに関するトラブルシューティング](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)」を参照してください。 +If you choose the `docs` folder on any branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. For more information, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)." + +{% ifversion fpt %} + +Your {% data variables.product.prodname_pages %} site will always be deployed with a {% data variables.product.prodname_actions %} workflow run, even if you've configured your {% data variables.product.prodname_pages %} site to be built using a different CI tool. Most external CI workflows "deploy" to GitHub Pages by committing the build output to the `gh-pages` branch of the repository, and typically include a `.nojekyll` file. When this happens, the {% data variables.product.prodname_actions %} worfklow will detect the state that the branch does not need a build step, and will execute only the steps necessary to deploy the site to {% data variables.product.prodname_pages %} servers. + +To find potential errors with either the build or deployment, you can check the workflow run for your {% data variables.product.prodname_pages %} site by reviewing your repository's workflow runs. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." For more information about how to re-run the workflow in case of an error, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)." + +{% note %} + +{% data reusables.pages.pages-builds-with-github-actions-public-beta %} + +{% endnote %} + +{% endif %} diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md index 6fd4b232f1..e2a6857bc7 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md @@ -1,8 +1,8 @@ --- -title: GitHub Pages サイトのカスタム 404 ページを作成する -intro: サイト上の存在しないページにアクセスしようとした際に表示される、404 エラーページをカスタマイズできます。 +title: Creating a custom 404 page for your GitHub Pages site +intro: You can display a custom 404 error page when people try to access nonexistent pages on your site. redirect_from: - - /articles/custom-404-pages/ + - /articles/custom-404-pages - /articles/creating-a-custom-404-page-for-your-github-pages-site - /github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site product: '{% data reusables.gated-features.pages %}' @@ -13,25 +13,26 @@ versions: ghec: '*' topics: - Pages -shortTitle: カスタム404ページの作成 +shortTitle: Create custom 404 page --- {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} {% data reusables.files.add-file %} -3. ファイル名のフィールドに、`404.html` または `404.md` と入力します。 ![ファイル名フィールド](/assets/images/help/pages/404-file-name.png) -4. ファイル名を `404.md` とした場合、ファイルの先頭に以下の YAML front matter を追加します。 +3. In the file name field, type `404.html` or `404.md`. + ![File name field](/assets/images/help/pages/404-file-name.png) +4. If you named your file `404.md`, add the following YAML front matter to the beginning of the file: ```yaml --- permalink: /404.html --- ``` -5. YAML front matter の下に、404 ページに表示したいコンテンツがある場合には、それを追加します。 +5. Below the YAML front matter, if present, add the content you want to display on your 404 page. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} -## 参考リンク +## Further reading -- Jekyll ドキュメンテーションの [Front matter](http://jekyllrb.com/docs/frontmatter) +- [Front matter](http://jekyllrb.com/docs/frontmatter) in the Jekyll documentation diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index 1c908c2cc3..fd7bb21e9a 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -1,11 +1,11 @@ --- -title: GitHub Pages サイトを作成する -intro: '新規または既存のリポジトリ内に、{% data variables.product.prodname_pages %} サイトを作成できます。' +title: Creating a GitHub Pages site +intro: 'You can create a {% data variables.product.prodname_pages %} site in a new or existing repository.' redirect_from: - - /articles/creating-pages-manually/ - - /articles/creating-project-pages-manually/ - - /articles/creating-project-pages-from-the-command-line/ - - /articles/creating-project-pages-using-the-command-line/ + - /articles/creating-pages-manually + - /articles/creating-project-pages-manually + - /articles/creating-project-pages-from-the-command-line + - /articles/creating-project-pages-using-the-command-line - /articles/creating-a-github-pages-site - /github/working-with-github-pages/creating-a-github-pages-site product: '{% data reusables.gated-features.pages %}' @@ -16,12 +16,12 @@ versions: ghec: '*' topics: - Pages -shortTitle: GitHub Pagesのサイトの作成 +shortTitle: Create a GitHub Pages site --- {% data reusables.pages.org-owners-can-restrict-pages-creation %} -## サイト用にリポジトリを作成する +## Creating a repository for your site {% data reusables.pages.new-or-existing-repo %} @@ -32,7 +32,7 @@ shortTitle: GitHub Pagesのサイトの作成 {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -## サイトを作成する +## Creating your site {% data reusables.pages.must-have-repo-first %} @@ -40,8 +40,8 @@ shortTitle: GitHub Pagesのサイトの作成 {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.decide-publishing-source %} -3. 選択した公開元が既に存在する場合、公開元に移動します。 選択した公開元がまだ存在しない場合は、公開元を作成します。 -4. 公開元のルートに、サイトのメインページに表示したいコンテンツを含んだ、`index.md` という名前の新しいファイルを作成します。 +3. If your chosen publishing source already exists, navigate to the publishing source. If your chosen publishing source doesn't exist, create the publishing source. +4. In the root of the publishing source, create a new file called `index.md` that contains the content you want to display on the main page of your site. {% tip %} @@ -53,19 +53,20 @@ shortTitle: GitHub Pagesのサイトの作成 {% data reusables.pages.sidebar-pages %}{% ifversion fpt or ghec %} {% data reusables.pages.choose-visibility %}{% endif %} {% data reusables.pages.visit-site %} +{% data reusables.pages.check-workflow-run %} {% data reusables.pages.admin-must-push %} -## 次のステップ +## Next steps -新しいファイルを追加で作成することにより、ページを追加できます。 各ファイルは、公開元と同じディレクトリ構造で、サイト上に表示されます。 たとえば、プロジェクトサイトの公開元が `gh-pages` ブランチで、新しいファイル `/about/contact-us.md` を `gh-pages` ブランチに作成した場合、ファイルは {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html` で表示されます。 +You can add more pages to your site by creating more new files. Each file will be available on your site in the same directory structure as your publishing source. For example, if the publishing source for your project site is the `gh-pages` branch, and you create a new file called `/about/contact-us.md` on the `gh-pages` branch, the file will be available at {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html`. -また、サイトの見た目をカスタマイズするため、テーマを追加できます。 詳しい情報については、{% ifversion fpt or ghec %}「[テーマ選択画面で {% data variables.product.prodname_pages %} サイトにテーマを追加する](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}「[Jekyll テーマ選択画面で {% data variables.product.prodname_pages %} サイトにテーマを追加する](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}」を参照してください。 +You can also add a theme to customize your site’s look and feel. For more information, see {% ifversion fpt or ghec %}"[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}"[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}." -サイトを更にカスタマイズするには、Jekyll を使用できます。Jekyll は、{% data variables.product.prodname_pages %} に組み込まれている静的サイトジェネレータです。 詳しい情報については、「[{% data variables.product.prodname_pages %} と Jekyll](/articles/about-github-pages-and-jekyll)」を参照してください。 +To customize your site even more, you can use Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %}. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." -## 参考リンク +## Further reading -- [{% data variables.product.prodname_pages %} サイトの Jekyll ビルドエラーに関するトラブルシューティング](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites) -- [リポジトリ内でブランチを作成および削除する](/articles/creating-and-deleting-branches-within-your-repository) -- [新しいファイルの作成](/articles/creating-new-files) +- "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)" +- "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)" +- "[Creating new files](/articles/creating-new-files)" diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/index.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/index.md index b24ccda345..b391a4458c 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/index.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/index.md @@ -1,9 +1,9 @@ --- -title: GitHub Pages を使ってみる -intro: '基本的な {% data variables.product.prodname_pages %} サイトを、あなたやあなたの Organization、またはあなたのプロジェクトのためにセットアップできます。' +title: Getting started with GitHub Pages +intro: 'You can set up a basic {% data variables.product.prodname_pages %} site for yourself, your organization, or your project.' redirect_from: - /categories/github-pages-basics - - /articles/additional-customizations-for-github-pages/ + - /articles/additional-customizations-for-github-pages - /articles/getting-started-with-github-pages - /github/working-with-github-pages/getting-started-with-github-pages product: '{% data reusables.gated-features.pages %}' @@ -24,6 +24,6 @@ children: - /securing-your-github-pages-site-with-https - /using-submodules-with-github-pages - /unpublishing-a-github-pages-site -shortTitle: 始めましょう！ +shortTitle: Get started --- diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md index 9dbb9d98e5..bcc60251c3 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md @@ -1,11 +1,11 @@ --- -title: GitHub Pages サイトを取り下げる -intro: '{% data variables.product.prodname_pages %} サイトを取り下げて、サイトを利用不可にすることができます。' +title: Unpublishing a GitHub Pages site +intro: 'You can unpublish your {% data variables.product.prodname_pages %} site so that the site is no longer available.' redirect_from: - - /articles/how-do-i-unpublish-a-project-page/ - - /articles/unpublishing-a-project-page/ - - /articles/unpublishing-a-project-pages-site/ - - /articles/unpublishing-a-user-pages-site/ + - /articles/how-do-i-unpublish-a-project-page + - /articles/unpublishing-a-project-page + - /articles/unpublishing-a-project-pages-site + - /articles/unpublishing-a-user-pages-site - /articles/unpublishing-a-github-pages-site - /github/working-with-github-pages/unpublishing-a-github-pages-site product: '{% data reusables.gated-features.pages %}' @@ -17,21 +17,22 @@ versions: ghec: '*' topics: - Pages -shortTitle: Pagesサイトの公開取り下げ +shortTitle: Unpublish Pages site --- -## プロジェクトサイトを取り下げる +## Unpublishing a project site {% data reusables.repositories.navigate-to-repo %} -2. リポジトリに `gh-pages` ブランチが存在する場合は、`gh-pages` ブランチを削除します。 詳しい情報については[リポジトリ内でのブランチの作成と削除](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)を参照してください。 -3. 公開ソースが`gh-pages`ブランチなら、{% ifversion fpt or ghec %}ステップ 6 までスキップします{% else %}サイトの公開は取り消され、残りのステップをスキップできます{% endif %}。 +2. If a `gh-pages` branch exists in the repository, delete the `gh-pages` branch. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)." +3. If the `gh-pages` branch was your publishing source, {% ifversion fpt or ghec %}skip to step 6{% else %}your site is now unpublished and you can skip the remaining steps{% endif %}. {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -5. {% data variables.product.prodname_pages %} で、[**Source**] ドロップダウンメニューを使用して [**None**] を選択します。 ![公開元を選択するドロップダウンメニュー](/assets/images/help/pages/publishing-source-drop-down.png) +5. Under "{% data variables.product.prodname_pages %}", use the **Source** drop-down menu and select **None.** + ![Drop down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) {% data reusables.pages.update_your_dns_settings %} -## ユーザまたは Organization サイトを取り下げる +## Unpublishing a user or organization site {% data reusables.repositories.navigate-to-repo %} -2. 公開元として使用しているブランチを削除するか、リポジトリ全体を削除します。 詳細は「[リポジトリ内でブランチを作成および削除する](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)」および「[リポジトリを削除する](/articles/deleting-a-repository)」を参照してください。 +2. Delete the branch that you're using as a publishing source, or delete the entire repository. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" and "[Deleting a repository](/articles/deleting-a-repository)." {% data reusables.pages.update_your_dns_settings %} diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md index deb4eb6711..a29e68ab61 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md @@ -1,8 +1,8 @@ --- -title: GitHub Pages でサブモジュールを使用する -intro: '{% data variables.product.prodname_pages %} でサブモジュールを使用すると、他のサイトのコードで他のプロジェクトを含めることができます。' +title: Using submodules with GitHub Pages +intro: 'You can use submodules with {% data variables.product.prodname_pages %} to include other projects in your site''s code.' redirect_from: - - /articles/using-submodules-with-pages/ + - /articles/using-submodules-with-pages - /articles/using-submodules-with-github-pages - /github/working-with-github-pages/using-submodules-with-github-pages product: '{% data reusables.gated-features.pages %}' @@ -11,16 +11,16 @@ versions: ghec: '*' topics: - Pages -shortTitle: Pagesでのサブモジュールの利用 +shortTitle: Use submodules with Pages --- -{% data variables.product.prodname_pages %} サイトのリポジトリにサブモジュールが含まれている場合、その内容はサイトをビルドする際に自動的にプルされます。 +If the repository for your {% data variables.product.prodname_pages %} site contains submodules, their contents will automatically be pulled in when your site is built. -使用できるのは、パブリックリポジトリをポイントするサブモジュールだけです。{% data variables.product.prodname_pages %} サーバーはプライベートリポジトリにはアクセスできないためです。 +You can only use submodules that point to public repositories, because the {% data variables.product.prodname_pages %} server cannot access private repositories. -ネストされたサブモジュールも含めて、サブモジュールには `https://` 読み取り専用 URL を使用してください。 この変更は _.gitmodules_ ファイルで行うことができます。 +Use the `https://` read-only URL for your submodules, including nested submodules. You can make this change in your _.gitmodules_ file. -## 参考リンク +## Further reading -- _Pro Git_ ブックの「[Git Tools - Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)」 -- [{% data variables.product.prodname_pages %} サイトの Jekyll ビルドエラーに関するトラブルシューティング](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites) +- "[Git Tools - Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" from the _Pro Git_ book +- "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)" diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 4cef579a69..8df4d200f5 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -7,15 +7,15 @@ redirect_from: - /articles/configuring-jekyll-plugins - /articles/using-syntax-highlighting-on-github-pages - /articles/files-that-start-with-an-underscore-are-missing - - /articles/sitemaps-for-github-pages/ - - /articles/search-engine-optimization-for-github-pages/ - - /articles/repository-metadata-on-github-pages/ - - /articles/atom-rss-feeds-for-github-pages/ - - /articles/redirects-on-github-pages/ - - /articles/emoji-on-github-pages/ - - /articles/mentions-on-github-pages/ - - /articles/using-jekyll-plugins-with-github-pages/ - - /articles/adding-jekyll-plugins-to-a-github-pages-site/ + - /articles/sitemaps-for-github-pages + - /articles/search-engine-optimization-for-github-pages + - /articles/repository-metadata-on-github-pages + - /articles/atom-rss-feeds-for-github-pages + - /articles/redirects-on-github-pages + - /articles/emoji-on-github-pages + - /articles/mentions-on-github-pages + - /articles/using-jekyll-plugins-with-github-pages + - /articles/adding-jekyll-plugins-to-a-github-pages-site - /articles/about-github-pages-and-jekyll - /github/working-with-github-pages/about-github-pages-and-jekyll product: '{% data reusables.gated-features.pages %}' diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 4b37a72160..c5b53d6108 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -36,15 +36,34 @@ If Jekyll does attempt to build your site and encounters an error, you will rece For more information about troubleshooting build errors, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)." -## Viewing Jekyll build error messages +{% ifversion fpt %} +## Viewing Jekyll build error messages with {% data variables.product.prodname_actions %} + +By default, your {% data variables.product.prodname_pages %} site is built and deployed with a {% data variables.product.prodname_actions %} workflow run unless you've configured your {% data variables.product.prodname_pages %} site to use a different CI tool. To find potential build errors, you can check the workflow run for your {% data variables.product.prodname_pages %} site by reviewing your repository's workflow runs. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." For more information about how to re-run the workflow in case of an error, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)." +{% note %} + +{% data reusables.pages.pages-builds-with-github-actions-public-beta %} + +{% endnote %} +{% endif %} + +## Viewing your repository's build failures on {% data variables.product.product_name %} + +You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository. + +## Viewing Jekyll build error messages locally We recommend testing your site locally, which allows you to see build error messages on the command line, and addressing any build failures before pushing changes to {% data variables.product.product_name %}. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)." +## Viewing Jekyll build error messages in your pull request + When you create a pull request to update your publishing source on {% data variables.product.product_name %}, you can see build error messages on the **Checks** tab of the pull request. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." +## Viewing Jekyll build errors by email + When you push changes to your publishing source on {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} will attempt to build your site. If the build fails, you'll receive an email at your primary email address. You'll also receive emails for build warnings. {% data reusables.pages.build-failure-email-server %} -You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository. +## Viewing Jekyll build error messages in your pull request with a third-party CI service You can configure a third-party service, such as [Travis CI](https://travis-ci.org/), to display error messages after each commit. diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md index 3d59582f58..43c4262281 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md @@ -1,6 +1,6 @@ --- -title: Jekyll を使用して GitHub Pages サイトを作成する -intro: '新規または既存のリポジトリ内に、{% data variables.product.prodname_pages %} Jekyll を使用してサイトを作成できます。' +title: Creating a GitHub Pages site with Jekyll +intro: 'You can use Jekyll to create a {% data variables.product.prodname_pages %} site in a new or existing repository.' product: '{% data reusables.gated-features.pages %}' redirect_from: - /articles/creating-a-github-pages-site-with-jekyll @@ -13,20 +13,20 @@ versions: ghec: '*' topics: - Pages -shortTitle: Jekyllでのサイトの作成 +shortTitle: Create site with Jekyll --- {% data reusables.pages.org-owners-can-restrict-pages-creation %} -## 必要な環境 +## Prerequisites -Jekyll を使用して {% data variables.product.prodname_pages %} サイトを作成する前に、Jekyll と Git をインストールする必要があります。 詳しい情報については、Jekyll ドキュメンテーションの [Installation](https://jekyllrb.com/docs/installation/) および「[Git のセットアップ](/articles/set-up-git)」を参照してください。 +Before you can use Jekyll to create a {% data variables.product.prodname_pages %} site, you must install Jekyll and Git. For more information, see [Installation](https://jekyllrb.com/docs/installation/) in the Jekyll documentation and "[Set up Git](/articles/set-up-git)." {% data reusables.pages.recommend-bundler %} {% data reusables.pages.jekyll-install-troubleshooting %} -## サイト用にリポジトリを作成する +## Creating a repository for your site {% data reusables.pages.new-or-existing-repo %} @@ -35,67 +35,67 @@ Jekyll を使用して {% data variables.product.prodname_pages %} サイトを {% data reusables.pages.create-repo-name %} {% data reusables.repositories.choose-repo-visibility %} -## サイトを作成する +## Creating your site {% data reusables.pages.must-have-repo-first %} {% data reusables.pages.private_pages_are_public_warning %} {% data reusables.command_line.open_the_multi_os_terminal %} -1. リポジトリのローカルコピーがまだない場合、サイトのソースファイルを保存したい場所に移動します。_PARENT-FOLDER_ は、リポジトリを保存したいフォルダの名前に置き換えてください。 +1. If you don't already have a local copy of your repository, navigate to the location where you want to store your site's source files, replacing _PARENT-FOLDER_ with the folder you want to contain the folder for your repository. ```shell $ cd PARENT-FOLDER ``` -1. ローカルの Git リポジトリをまだ初期化していない場合は、初期化します。 _REPOSITORY-NAME_ は、リポジトリの名前に置き換えてください。 +1. If you haven't already, initialize a local Git repository, replacing _REPOSITORY-NAME_ with the name of your repository. ```shell $ git init REPOSITORY-NAME > Initialized empty Git repository in /Users/octocat/my-site/.git/ # Creates a new folder on your computer, initialized as a Git repository ``` - 4. ディレクトリをリポジトリに変更します。 + 4. Change directories to the repository. ```shell $ cd REPOSITORY-NAME # Changes the working directory ``` {% data reusables.pages.decide-publishing-source %} {% data reusables.pages.navigate-publishing-source %} - たとえば、デフォルトブランチの `docs` フォルダからサイトを公開することを選択した場合は、ディレクトリを作成して `docs ` フォルダに変更します。 + For example, if you chose to publish your site from the `docs` folder on the default branch, create and change directories to the `docs` folder. ```shell $ mkdir docs # Creates a new folder called docs $ cd docs ``` - サイトを `gh-pages` ブランチから公開する場合には、`gh-pages` ブランチを作成してチェックアウトします。 + If you chose to publish your site from the `gh-pages` branch, create and checkout the `gh-pages` branch. ```shell $ git checkout --orphan gh-pages # Creates a new branch, with no history or contents, called gh-pages and switches to the gh-pages branch ``` -1. 新しい Jekyll サイトを作成するには、`jekyll new` コマンドを使用します。 +1. To create a new Jekyll site, use the `jekyll new` command: ```shell $ jekyll new --skip-bundle . # Creates a Jekyll site in the current directory ``` -1. Jekyll が作成した Gemfile を開きます。 -1. `gem "jekyll"` で始まる行の先頭に「#」を追加して行をコメントアウトします。 -1. `# gem "github-pages"` で始まる行を編集して `github-pages` を追加します。 行を次のように変更します。 +1. Open the Gemfile that Jekyll created. +1. Add "#" to the beginning of the line that starts with `gem "jekyll"` to comment out this line. +1. Add the `github-pages` gem by editing the line starting with `# gem "github-pages"`. Change this line to: ```shell gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins ``` - _GITHUB-PAGES-VERSION_ をサポートされている最新バージョンの `github-pages` gem に置き換えます。 このバージョンについては、「[依存関係バージョン](https://pages.github.com/versions/)」を参照してください。 + Replace _GITHUB-PAGES-VERSION_ with the latest supported version of the `github-pages` gem. You can find this version here: "[Dependency versions](https://pages.github.com/versions/)." - 正しいバージョンの Jekyll は、`github-pages` gem の依存関係としてインストールされます。 -1. Gemfile を保存して閉じます。 + The correct version Jekyll will be installed as a dependency of the `github-pages` gem. +1. Save and close the Gemfile. 1. From the command line, run `bundle install`. -1. あるいは、`_config.yml`ファイルに必要な編集を加えてください。 これは、リポジトリがサブディレクトリでホストされている場合に相対パスに対して必要です。 詳しい情報については「[サブフォルダを分割して新しいリポジトリにする](/github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository)」を参照してください。 +1. Optionally, make any necessary edits to the `_config.yml` file. This is required for relative paths when the repository is hosted in a subdirectory. For more information, see "[Splitting a subfolder out into a new repository](/github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository)." ```yml - domain: my-site.github.io # HTTPSを強制したいなら、ドメインの先頭でhttpを指定しない。例: example.com - url: https://my-site.github.io # サイトのベースのホスト名とプロトコル。例: http://example.com - baseurl: /REPOSITORY-NAME/ # サイトがサブフォルダで提供されるならフォルダ名を置く + domain: my-site.github.io # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com + url: https://my-site.github.io # the base hostname and protocol for your site, e.g. http://example.com + baseurl: /REPOSITORY-NAME/ # place folder name if the site is served in a subfolder ``` -1. 必要に応じて、サイトをローカルでテストします。 詳しい情報については、「[Jekyll を使用して {% data variables.product.prodname_pages %} サイトをローカルでテストする](/articles/testing-your-github-pages-site-locally-with-jekyll)」を参照してください。 -1. 作業内容を追加してコミットしてください。 +1. Optionally, test your site locally. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)." +1. Add and commit your work. ```shell git add . git commit -m 'Initial GitHub pages site with Jekyll' @@ -108,7 +108,7 @@ $ git remote add origin https://github.com/USER/REPOSITORY.git $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git {% endif %} ``` -1. リポジトリを {% data variables.product.product_name %} にプッシュします。 _BRANCH_ は、作業を行なっているブランチの名前に置き換えてください。 +1. Push the repository to {% data variables.product.product_name %}, replacing _BRANCH_ with the name of the branch you're working on. ```shell $ git push -u origin BRANCH ``` @@ -119,11 +119,12 @@ $ git remote add origin https://HOSTNAME/USER/REPOSITORY Configuration file: /Users/octocat/my-site/_config.yml @@ -48,17 +48,17 @@ Jekyll を使用してサイトをテストする前に、以下の操作が必 > Server address: http://127.0.0.1:4000/ > Server running... press ctrl-c to stop. ``` -3. サイトをプレビューするには、ウェブブラウザで `http://localhost:4000` を開きます。 +3. To preview your site, in your web browser, navigate to `http://localhost:4000`. -## {% data variables.product.prodname_pages %} gem の更新 +## Updating the {% data variables.product.prodname_pages %} gem -Jekyll は、頻繁に更新されているアクティブなオープンソースプロジェクトです。 お使いのコンピュータ上の `github-pages` gem が {% data variables.product.prodname_pages %} サーバー上の `github-pages` gem と比較して古くなっている場合は、ローカルでビルドしたときと {% data variables.product.product_name %} に公開したときで、サイトの見え方が異なることがあります。 こうならないように、お使いのコンピュータ上の `github-pages` gem は常にアップデートしておきましょう。 +Jekyll is an active open source project that is updated frequently. If the `github-pages` gem on your computer is out of date with the `github-pages` gem on the {% data variables.product.prodname_pages %} server, your site may look different when built locally than when published on {% data variables.product.product_name %}. To avoid this, regularly update the `github-pages` gem on your computer. {% data reusables.command_line.open_the_multi_os_terminal %} -2. `github-pages` gem をアップデートします。 - - Bundler をインストールしている場合は、`bundle update github-pages` を実行します。 - - Bundler をインストールしていない場合は、`gem update github-pages` を実行します。 +2. Update the `github-pages` gem. + - If you installed Bundler, run `bundle update github-pages`. + - If you don't have Bundler installed, run `gem update github-pages`. -## 参考リンク +## Further reading -- Jekyll ドキュメンテーションの [{% data variables.product.prodname_pages %}](http://jekyllrb.com/docs/github-pages/) +- [{% data variables.product.prodname_pages %}](http://jekyllrb.com/docs/github-pages/) in the Jekyll documentation diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md index 0bdfd532c7..c9264010b1 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md @@ -1,8 +1,8 @@ --- -title: マージコンフリクトへの対処 -intro: あなたの変更とベースブランチとの間にマージコンフリクトが発生している場合、プルリクエストの変更をマージする前にマージコンフリクトに対処しなければなりません。 +title: Addressing merge conflicts +intro: 'If your changes have merge conflicts with the base branch, you must address the merge conflicts before you can merge your pull request''s changes.' redirect_from: - - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/ + - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts - /articles/addressing-merge-conflicts - /github/collaborating-with-pull-requests/addressing-merge-conflicts versions: @@ -18,4 +18,3 @@ children: - /resolving-a-merge-conflict-using-the-command-line shortTitle: Address merge conflicts --- - diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index d5e2f69442..7354246bea 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -1,9 +1,9 @@ --- -title: コマンド ラインを使用してマージ コンフリクトを解決する -intro: コマンド ラインとテキスト エディターを使用することで、マージ コンフリクトを解決できます。 +title: Resolving a merge conflict using the command line +intro: You can resolve merge conflicts using the command line and a text editor. redirect_from: - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line - - /articles/resolving-a-merge-conflict-from-the-command-line/ + - /articles/resolving-a-merge-conflict-from-the-command-line - /articles/resolving-a-merge-conflict-using-the-command-line - /github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line - /github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line @@ -16,27 +16,26 @@ topics: - Pull requests shortTitle: Resolve merge conflicts in Git --- - -マージコンフリクトは、競合している変更がファイルの同じ行に行われるとき、またはある人があるファイルを編集し別の人が同じファイルを削除すると発生します。 詳細は「[マージコンフリクトについて](/articles/about-merge-conflicts/)」を参照してください。 +Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[About merge conflicts](/articles/about-merge-conflicts/)." {% tip %} -**ヒント:** {% data variables.product.product_name %} でコンフリクト エディターを使用することで、Pull Request の一部であるブランチの間で競合している行変更のマージ コンフリクトを解消できます。 詳細については、「[GitHub でマージコンフリクトを解決する](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)」を参照してください。 +**Tip:** You can use the conflict editor on {% data variables.product.product_name %} to resolve competing line change merge conflicts between branches that are part of a pull request. For more information, see "[Resolving a merge conflict on GitHub](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." {% endtip %} -## 競合している行変更のマージ コンフリクト +## Competing line change merge conflicts -競合している行変更により発生するマージ コンフリクトを解決するには、新しいコミットにどの変更を組み込むかをいくつかの別のブランチから選択する必要があります。 +To resolve a merge conflict caused by competing line changes, you must choose which changes to incorporate from the different branches in a new commit. -たとえば、あなたともう一人が両方とも、同じ Git リポジトリの別のブランチにあるファイル _styleguide.md_ で同じ行を編集した場合、これらのブランチをマージしようとするとマージ コンフリクト エラーが発生します。 これらのブランチをマージする前に、新たなコミットでこのマージ コンフリクトを解決する必要があります。 +For example, if you and another person both edited the file _styleguide.md_ on the same lines in different branches of the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. マージ コンフリクトが発生しているローカルの Git リポジトリに移動します。 +2. Navigate into the local Git repository that has the merge conflict. ```shell cd REPOSITORY-NAME ``` -3. マージ コンフリクトの影響を受けるファイルのリストを生成します。 この例では、ファイル *styleguide.md* にマージコンフリクトが発生しています。 +3. Generate a list of the files affected by the merge conflict. In this example, the file *styleguide.md* has a merge conflict. ```shell $ git status > # On branch branch-b @@ -50,8 +49,8 @@ shortTitle: Resolve merge conflicts in Git > # > no changes added to commit (use "git add" and/or "git commit -a") ``` -4. [Atom](https://atom.io/) などのお気に入りのテキスト エディターを開き、マージ コンフリクトが発生しているファイルに移動します。 -5. ファイル内でマージ コンフリクトの始まりを確認するには、ファイル内のコンフリクト マーカー `<<<<<<<` を検索します。 テキストエディタでファイルを開くと、`<<<<<<< HEAD` 行の後に HEAD ブランチまたはベースブランチからの変更が見えます。 次に、`=======` が見えます。これは、自分の変更と他のブランチの変更を区別するもので、その後に `>>>>>>> BRANCH-NAME` が続きます。 この例では、ある人がベースまたは HEAD ブランチで「open an issue」と書き込み、別の人が compare ブランチまたは `branch-a` に「ask your question in IRC」と書き込みました。 +4. Open your favorite text editor, such as [Atom](https://atom.io/), and navigate to the file that has merge conflicts. +5. To see the beginning of the merge conflict in your file, search the file for the conflict marker `<<<<<<<`. When you open the file in your text editor, you'll see the changes from the HEAD or base branch after the line `<<<<<<< HEAD`. Next, you'll see `=======`, which divides your changes from the changes in the other branch, followed by `>>>>>>> BRANCH-NAME`. In this example, one person wrote "open an issue" in the base or HEAD branch and another person wrote "ask your question in IRC" in the compare branch or `branch-a`. ``` If you have questions, please @@ -61,34 +60,34 @@ shortTitle: Resolve merge conflicts in Git ask your question in IRC. >>>>>>> branch-a ``` -{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %}この例では、両方の変更が最終的なマージに取り込まれます。 +{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} In this example, both changes are incorporated into the final merge: ```shell - 質問がある場合は、Issue を開くか、緊急の場合は IRC チャネルにてお問い合わせください。 + If you have questions, please open an issue or ask in our IRC channel if it's more urgent. ``` -7. 変更を追加またはステージングします。 +7. Add or stage your changes. ```shell $ git add . ``` -8. 変更をコメントを付けてコミットします。 +8. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by incorporating both suggestions." ``` -これでコマンドラインでブランチをマージできます。 また、{% data variables.product.product_name %} で[変更をリモート リポジトリにプッシュする](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)ことや、Pull Request で[変更をマージする](/articles/merging-a-pull-request/)ことができます。 +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## 削除したファイルのマージコンフリクト +## Removed file merge conflicts -ある人があるブランチでファイルを削除し、別の人が同じファイルを編集するなどの、ファイルへの変更が競合していることにより発生するマージコンフリクトを解決するには、削除したファイルを削除するか保持するかを新しいコミットで選択する必要があります。 +To resolve a merge conflict caused by competing changes to a file, where a person deletes a file in one branch and another person edits the same file, you must choose whether to delete or keep the removed file in a new commit. -たとえば、あなたが *README.md* などのファイルを編集した場合、別の人が同じ Git リポジトリ内の別のブランチにある同じファイルを削除したならば、これらのブランチをマージしようとした際にマージコンフリクト エラーが発生します。 これらのブランチをマージする前に、新たなコミットでこのマージ コンフリクトを解決する必要があります。 +For example, if you edited a file, such as *README.md*, and another person removed the same file in another branch in the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. マージ コンフリクトが発生しているローカルの Git リポジトリに移動します。 +2. Navigate into the local Git repository that has the merge conflict. ```shell cd REPOSITORY-NAME ``` -2. マージ コンフリクトの影響を受けるファイルのリストを生成します。 この例では、ファイル *README.md* にマージコンフリクトが発生しています。 +2. Generate a list of the files affected by the merge conflict. In this example, the file *README.md* has a merge conflict. ```shell $ git status > # On branch main @@ -101,32 +100,32 @@ shortTitle: Resolve merge conflicts in Git > # Unmerged paths: > # (use "git add/rm ..." as appropriate to mark resolution) > # - > # deleted by us: README.md + > # deleted by us: README.md > # > # no changes added to commit (use "git add" and/or "git commit -a") ``` -3. [Atom](https://atom.io/) などのお気に入りのテキスト エディターを開き、マージ コンフリクトが発生しているファイルに移動します。 -6. 削除したファイルを保存するかどうかを決めます。 削除したファイルに行った最新の変更をテキスト エディターで確認することをお勧めします。 +3. Open your favorite text editor, such as [Atom](https://atom.io/), and navigate to the file that has merge conflicts. +6. Decide if you want keep the removed file. You may want to view the latest changes made to the removed file in your text editor. - 削除したファイルをリポジトリに追加して戻すには: + To add the removed file back to your repository: ```shell $ git add README.md ``` - このファイルをリポジトリから削除するには: + To remove this file from your repository: ```shell $ git rm README.md > README.md: needs merge > rm 'README.md' ``` -7. 変更をコメントを付けてコミットします。 +7. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by keeping README.md file." > [branch-d 6f89e49] Merge branch 'branch-c' into branch-d ``` -これでコマンドラインでブランチをマージできます。 また、{% data variables.product.product_name %} で[変更をリモート リポジトリにプッシュする](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)ことや、Pull Request で[変更をマージする](/articles/merging-a-pull-request/)ことができます。 +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## 参考リンク +## Further reading -- "[マージコンフリクトについて](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" -- "[Pull Request をローカルでチェック アウトする](/articles/checking-out-pull-requests-locally/)" +- "[About merge conflicts](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" +- "[Checking out pull requests locally](/articles/checking-out-pull-requests-locally/)" diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md index b53cda7a4b..a578538671 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md @@ -1,9 +1,9 @@ --- -title: ステータスチェックについて -intro: ステータスチェックを利用すると、コントリビュート先のリポジトリの条件をコミットが満たしているかどうかを知ることができます。 +title: About status checks +intro: Status checks let you know if your commits meet the conditions set for the repository you're contributing to. redirect_from: - /github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks - - /articles/about-statuses/ + - /articles/about-statuses - /articles/about-status-checks - /github/collaborating-with-issues-and-pull-requests/about-status-checks - /github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks @@ -15,33 +15,32 @@ versions: topics: - Pull requests --- +Status checks are based on external processes, such as continuous integration builds, which run for each push you make to a repository. You can see the *pending*, *passing*, or *failing* state of status checks next to individual commits in your pull request. -ステータスチェックは、リポジトリにプッシュをするたびに実行される継続的インテグレーションのビルドのような、外部のプロセスに基づいています。 プルリクエスト中の個々のコミットの隣に、* pending*、*passing*、 *failing* などの、ステータスチェックのステータスが表示されます。 +![List of commits and statuses](/assets/images/help/pull_requests/commit-list-statuses.png) -![コミットとステータスのリスト](/assets/images/help/pull_requests/commit-list-statuses.png) +Anyone with write permissions to a repository can set the state for any status check in the repository. -書き込み権限があるユーザまたはインテグレーションなら誰でも、リポジトリのステータスチェックを任意のステータスに設定できます。 - -ブランチへの最後のコミットの全体的なステータスは、リポジトリのブランチページあるいはリポジトリのプルリクエストのリストで見ることができます。 +You can see the overall state of the last commit to a branch on your repository's branches page or in your repository's list of pull requests. {% data reusables.pull_requests.required-checks-must-pass-to-merge %} -## {% data variables.product.product_name %}でのステータスチェックの種類 +## Types of status checks on {% data variables.product.product_name %} -{% data variables.product.product_name %} のステータスチェックには 2 種類あります。 +There are two types of status checks on {% data variables.product.product_name %}: -- チェック -- ステータス +- Checks +- Statuses _Checks_ are different from _statuses_ in that they provide line annotations, more detailed messaging, and are only available for use with {% data variables.product.prodname_github_apps %}. -Organization オーナー、およびリポジトリにプッシュアクセスを持つユーザは、{% data variables.product.product_name %} の API でチェックおよびステータスを作成できます。 詳しい情報については、「[チェック](/rest/reference/checks)」および「[ ステータス](/rest/reference/repos#statuses)」を参照してください。 +Organization owners and users with push access to a repository can create checks and statuses with {% data variables.product.product_name %}'s API. For more information, see "[Checks](/rest/reference/checks)" and "[Statuses](/rest/reference/repos#statuses)." -## チェック +## Checks -リポジトリで_チェック_が設定されている場合、プルリクエストには [**Checks**] タブがあり、そこからステータスチェックからの詳細なビルドの出力を表示して、失敗したチェックを再実行できます。 +When _checks_ are set up in a repository, pull requests have a **Checks** tab where you can view detailed build output from status checks and rerun failed checks. -![プルリクエスト中のステータスチェック](/assets/images/help/pull_requests/checks.png) +![Status checks within a pull request](/assets/images/help/pull_requests/checks.png) {% note %} @@ -49,28 +48,28 @@ Organization オーナー、およびリポジトリにプッシュアクセス {% endnote %} -コミットの特定の行でチェックが失敗している場合、その失敗、警告、注意に関する詳細がプルリクエストの [**Files**] タブの関連するコードの横に表示されます。 +When a specific line in a commit causes a check to fail, you will see details about the failure, warning, or notice next to the relevant code in the **Files** tab of the pull request. -![失敗したステータスチェックの詳細](/assets/images/help/pull_requests/checks-detailed.png) +![Details of a status check](/assets/images/help/pull_requests/checks-detailed.png) -[**Conversation**] タブの下のコミットドロップダウンメニューを使って、プルリクエスト中のさまざまなコミットのチェックのサマリー間を行き来できます。 +You can navigate between the checks summaries for various commits in a pull request, using the commit drop-down menu under the **Conversation** tab. -![ドロップダウンメニュー中でのさまざまなコミットのチェックのサマリー](/assets/images/help/pull_requests/checks-summary-for-various-commits.png) +![Check summaries for different commits in a drop-down menu](/assets/images/help/pull_requests/checks-summary-for-various-commits.png) -### 個々のコミットに関するチェックのスキップとリクエスト +### Skipping and requesting checks for individual commits -リポジトリがプッシュに対して自動的にチェックをリクエストするように設定されている場合、プッシュする個々のコミットについてチェックをスキップできます。 リポジトリがプッシュに対して自動的にチェックをリクエストするよう設定されて_いない_場合、プッシュする個々のコミットについてチェックをリクエストできます。 これらの設定についての詳しい情報は、「[チェックスイート](/rest/reference/checks#update-repository-preferences-for-check-suites)」を参照してください。 +When a repository is set to automatically request checks for pushes, you can choose to skip checks for an individual commit you push. When a repository is _not_ set to automatically request checks for pushes, you can request checks for an individual commit you push. For more information on these settings, see "[Check Suites](/rest/reference/checks#update-repository-preferences-for-check-suites)." -コミットに対するチェックをスキップもしくはリクエストするには、以下の追加行のいずれかをコミットメッセージの末尾に追加します: +To skip or request checks for your commit, add one of the following trailer lines to the end of your commit message: -- コミットの_チェックをスキップ_には、コミットメッセージと変更の短く意味のある説明を入力してください。 After your commit description, before the closing quotation, add two empty lines followed by `skip-checks: true`: +- To _skip checks_ for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `skip-checks: true`: ```shell $ git commit -m "Update README > > skip-checks: true" ``` -- コミットのチェックを_リクエスト_するには、コミットメッセージと変更の短く意味のある説明を入力してください。 After your commit description, before the closing quotation, add two empty lines followed by `request-checks: true`: +- To _request_ checks for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `request-checks: true`: ```shell $ git commit -m "Refactor usability tests > diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md index 749049e31a..cdec1046a8 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md @@ -1,9 +1,9 @@ --- -title: プルリクエストのマージについて +title: About pull request merges intro: 'You can [merge pull requests](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request) by retaining all the commits in a feature branch, squashing all commits into a single commit, or by rebasing individual commits from the `head` branch onto the `base` branch.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges - - /articles/about-pull-request-merge-squashing/ + - /articles/about-pull-request-merge-squashing - /articles/about-pull-request-merges - /github/collaborating-with-issues-and-pull-requests/about-pull-request-merges - /github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges @@ -15,47 +15,46 @@ versions: topics: - Pull requests --- - {% data reusables.pull_requests.default_merge_option %} -## プルリクエストのコミットのsquashとマージ +## Squash and merge your pull request commits {% data reusables.pull_requests.squash_and_merge_summary %} -### squash マージのマージメッセージ +### Merge message for a squash merge -squash してマージすると、{% data variables.product.prodname_dotcom %} はコミットメッセージを生成します。メッセージは必要に応じて変更できます。 メッセージのデフォルトは、プルリクエストに複数のコミットが含まれているか、1 つだけ含まれているかによって異なります。 We do not include merge commits when we count the total number of commits. +When you squash and merge, {% data variables.product.prodname_dotcom %} generates a commit message which you can change if you want to. The message default depends on whether the pull request contains multiple commits or just one. We do not include merge commits when we count the total number of commits. -| コミット数 | 概要 | 説明 | -| ------- | --------------------------------------- | ------------------------------------ | -| 単一のコミット | 単一のコミットのコミットメッセージのタイトルと、その後に続くプルリクエスト番号 | 単一のコミットのコミットメッセージの本文テキスト | -| 複数のコミット | プルリクエストのタイトルと、その後に続くプルリクエスト番号 | squash されたすべてのコミットのコミットメッセージの日付順のリスト | +Number of commits | Summary | Description | +----------------- | ------- | ----------- | +One commit | The title of the commit message for the single commit, followed by the pull request number | The body text of the commit message for the single commit +More than one commit | The pull request title, followed by the pull request number | A list of the commit messages for all of the squashed commits, in date order -### 長時間にわたるブランチを squash してマージする +### Squashing and merging a long-running branch -プルリクエストがマージされた後、プルリクエストの [head ブランチ](/github/getting-started-with-github/github-glossary#head-branch)で作業を継続する場合は、プルリクエストを squash してマージしないことをお勧めします。 +If you plan to continue work on the [head branch](/github/getting-started-with-github/github-glossary#head-branch) of a pull request after the pull request is merged, we recommend you don't squash and merge the pull request. -プルリクエストを作成すると、{% data variables.product.prodname_dotcom %} は、head ブランチと[ベースブランチ](/github/getting-started-with-github/github-glossary#base-branch)の両方にある最新のコミット、つまり共通の先祖のコミットを識別します。 プルリクエストを squash してマージすると、{% data variables.product.prodname_dotcom %} は、共通の先祖のコミット以降に head ブランチで行ったすべての変更を含むコミットをベースブランチに作成します。 +When you create a pull request, {% data variables.product.prodname_dotcom %} identifies the most recent commit that is on both the head branch and the [base branch](/github/getting-started-with-github/github-glossary#base-branch): the common ancestor commit. When you squash and merge the pull request, {% data variables.product.prodname_dotcom %} creates a commit on the base branch that contains all of the changes you made on the head branch since the common ancestor commit. -このコミットはベースブランチのみで行われ、head ブランチでは行われないため、2 つのブランチの共通の先祖は変更されません。 head ブランチでの作業を続行し、2 つのブランチ間に新しいプルリクエストを作成すると、プルリクエストには、共通の先祖以降のすべてのコミットが含まれます。これには、前のプルリクエストで squash してマージしたコミットも含まれます。 コンフリクトがない場合は、これらのコミットを安全にマージできます。 ただし、このワークフローでは高確率でマージコンフリクトが発生します。 長時間にわたる head ブランチのプルリクエストを squash してマージし続ける場合は、同じコンフリクトを繰り返し解決する必要があります。 +Because this commit is only on the base branch and not the head branch, the common ancestor of the two branches remains unchanged. If you continue to work on the head branch, then create a new pull request between the two branches, the pull request will include all of the commits since the common ancestor, including commits that you squashed and merged in the previous pull request. If there are no conflicts, you can safely merge these commits. However, this workflow makes merge conflicts more likely. If you continue to squash and merge pull requests for a long-running head branch, you will have to resolve the same conflicts repeatedly. -## プルリクエストコミットのリベースとマージ +## Rebase and merge your pull request commits {% data reusables.pull_requests.rebase_and_merge_summary %} -以下の場合、{% data variables.product.product_location %}上で自動的にリベースおよびマージすることはできません: -- プルリクエストにマージコンフリクトがある。 -- ベースブランチからヘッドブランチへのコミットのリベースでコンフリクトが生じる。 -- たとえば、マージコンフリクトなしにリベースできるものの、マージとは異なる結果が生成されるような場合、コミットのリベースは「安全ではない」と考えられます。 +You aren't able to automatically rebase and merge on {% data variables.product.product_location %} when: +- The pull request has merge conflicts. +- Rebasing the commits from the base branch into the head branch runs into conflicts. +- Rebasing the commits is considered "unsafe," such as when a rebase is possible without merge conflicts but would produce a different result than a merge would. -それでもコミットをリベースしたいにもかかわらず、{% data variables.product.product_location %} 上で自動的にリベースとマージが行えない場合、以下のようにしなければなりません: -- トピックブランチ (あるいは head ブランチ) をベースブランチにローカルでコマンドラインからリベースする -- [コマンドライン上でマージコンフリクトを解決する](/articles/resolving-a-merge-conflict-using-the-command-line/) -- リベースされたコミットをプルリクエストのトピックブランチ (あるいはリモートの head ブランチ) にフォースプッシュする。 +If you still want to rebase the commits but can't rebase and merge automatically on {% data variables.product.product_location %} you must: +- Rebase the topic branch (or head branch) onto the base branch locally on the command line +- [Resolve any merge conflicts on the command line](/articles/resolving-a-merge-conflict-using-the-command-line/). +- Force-push the rebased commits to the pull request's topic branch (or remote head branch). -リポジトリに書き込み権限を持つ人は、続いて{% data variables.product.product_location %}上のリベース及びマージボタンを使って[変更をマージ](/articles/merging-a-pull-request/)できます。 +Anyone with write permissions in the repository, can then [merge the changes](/articles/merging-a-pull-request/) using the rebase and merge button on {% data variables.product.product_location %}. -## 参考リンク +## Further reading -- [プルリクエストについて](/articles/about-pull-requests/) -- [マージコンフリクトへの対処](/github/collaborating-with-pull-requests/addressing-merge-conflicts) +- "[About pull requests](/articles/about-pull-requests/)" +- "[Addressing merge conflicts](/github/collaborating-with-pull-requests/addressing-merge-conflicts)" diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md index a4cf89e2ec..cf9dabb2ea 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md @@ -1,8 +1,8 @@ --- -title: プルリクエストから変更を取り込む -intro: '{% data variables.product.product_name %} での作業に対する変更は、プルリクエストを通じて提案できます。 プルリクエストを作成、管理、マージする方法を学びましょう。' +title: Incorporating changes from a pull request +intro: 'You can propose changes to your work on {% data variables.product.product_name %} through pull requests. Learn how to create, manage, and merge pull requests.' redirect_from: - - /github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request/ + - /github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request - /articles/incorporating-changes-from-a-pull-request - /github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request versions: @@ -21,4 +21,3 @@ children: - /reverting-a-pull-request shortTitle: Incorporate changes --- - diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md index b14dec6166..60c225594f 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md @@ -3,7 +3,7 @@ title: About branches intro: 'Use a branch to isolate development work without affecting other branches in the repository. Each repository has one default branch, and can have multiple other branches. You can merge a branch into another branch using a pull request.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches - - /articles/working-with-protected-branches/ + - /articles/working-with-protected-branches - /articles/about-branches - /github/collaborating-with-issues-and-pull-requests/about-branches - /github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index 04002cc4a8..a488f3afd5 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -3,7 +3,7 @@ title: About pull requests intro: 'Pull requests let you tell others about changes you''ve pushed to a branch in a repository on {% data variables.product.product_name %}. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests - - /articles/using-pull-requests/ + - /articles/using-pull-requests - /articles/about-pull-requests - /github/collaborating-with-issues-and-pull-requests/about-pull-requests - /github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md index 612a70eac6..aeff18cc0b 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md @@ -1,9 +1,9 @@ --- -title: リポジトリ内でブランチを作成および削除する -intro: '{% data variables.product.product_name %}上で直接、ブランチの作成や削除ができます。' +title: Creating and deleting branches within your repository +intro: 'You can create or delete branches directly on {% data variables.product.product_name %}.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository - - /articles/deleting-branches-in-a-pull-request/ + - /articles/deleting-branches-in-a-pull-request - /articles/creating-and-deleting-branches-within-your-repository - /github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository versions: @@ -15,36 +15,39 @@ topics: - Pull requests shortTitle: Create & delete branches --- - -## ブランチの作成 +## Creating a branch {% data reusables.repositories.navigate-to-repo %} -1. 必要に応じて、リポジトリのデフォルトブランチ以外のブランチから新しいブランチを作成する場合は、[{% octicon "git-branch" aria-label="The branch icon" %} **NUMBER branches**] をクリックし、別のブランチを選択します。 ![概要ページのブランチリンク](/assets/images/help/branches/branches-link.png) -1. ブランチセレクタメニューをクリックします。 ![ブランチセレクタメニュー](/assets/images/help/branch/branch-selection-dropdown.png) -1. 新しいブランチに、一意の名前を入力して、[**Create branch**] を選択します。 ![ブランチ作成のテキストボックス](/assets/images/help/branch/branch-creation-text-box.png) +1. Optionally, if you want to create your new branch from a branch other than the default branch for the repository, click {% octicon "git-branch" aria-label="The branch icon" %} **NUMBER branches** then choose another branch: + ![Branches link on overview page](/assets/images/help/branches/branches-link.png) +1. Click the branch selector menu. + ![branch selector menu](/assets/images/help/branch/branch-selection-dropdown.png) +1. Type a unique name for your new branch, then select **Create branch**. + ![branch creation text box](/assets/images/help/branch/branch-creation-text-box.png) -## ブランチの削除 +## Deleting a branch {% data reusables.pull_requests.automatically-delete-branches %} {% note %} -**注釈:** 削除するブランチがリポジトリのデフォルトブランチである場合は、ブランチを削除する前に新しいデフォルトブランチを選択する必要があります。 詳しい情報については「[デフォルトブランチの変更](/github/administering-a-repository/changing-the-default-branch)」を参照してください。 +**Note:** If the branch you want to delete is the repository's default branch, you must choose a new default branch before deleting the branch. For more information, see "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)." {% endnote %} -削除するブランチがオープンなプルリクエストに関連付けられている場合は、ブランチを削除する前にプルリクエストをマージまたはクローズする必要があります。 詳しい情報については、「[プルリクエストをマージする](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)」または「[プルリクエストをクローズする](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)」を参照してください。 +If the branch you want to delete is associated with an open pull request, you must merge or close the pull request before deleting the branch. For more information, see "[Merging a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" or "[Closing a pull request](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-branches %} -1. 削除するブランチまでスクロールし、{% octicon "trash" aria-label="The trash icon to delete the branch" %} をクリックします。 ![ブランチを削除する](/assets/images/help/branches/branches-delete.png) +1. Scroll to the branch that you want to delete, then click {% octicon "trash" aria-label="The trash icon to delete the branch" %}. + ![delete the branch](/assets/images/help/branches/branches-delete.png) {% data reusables.pull_requests.retargeted-on-branch-deletion %} -詳細は「[ブランチについて](/github/collaborating-with-issues-and-pull-requests/about-branches#working-with-branches)」を参照してください。 +For more information, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#working-with-branches)." -## 参考リンク +## Further reading - "[About branches](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" -- "[リポジトリ内のブランチを表示する](/github/administering-a-repository/viewing-branches-in-your-repository)" -- "[プルリクエスト中のブランチの削除と復元](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)" +- "[Viewing branches in your repository](/github/administering-a-repository/viewing-branches-in-your-repository)" +- "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)" diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md index e033f3b61a..6a5e87fe5c 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md @@ -1,8 +1,8 @@ --- -title: プルリクエストで、作業に対する変更を提案する -intro: トピックブランチまたはフォークに変更を加えた後で、それらをプロジェクトにマージする前に、プルリクエストをオープンしてコラボレーターまたはリポジトリ管理者に変更のレビューを依頼することができます。 +title: Proposing changes to your work with pull requests +intro: 'After you add changes to a topic branch or fork, you can open a pull request to ask your collaborators or the repository administrator to review your changes before merging them into the project.' redirect_from: - - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/ + - /github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests - /articles/proposing-changes-to-your-work-with-pull-requests - /github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests versions: @@ -26,4 +26,3 @@ children: - /committing-changes-to-a-pull-request-branch-created-from-a-fork shortTitle: Propose changes --- - diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md index b20593f6de..81e0efb039 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md @@ -1,14 +1,14 @@ --- -title: プルリクエストへコメントする +title: Commenting on a pull request redirect_from: - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request - - /articles/adding-commit-comments/ - - /articles/commenting-on-the-diff-of-a-pull-request/ - - /articles/commenting-on-differences-between-files/ + - /articles/adding-commit-comments + - /articles/commenting-on-the-diff-of-a-pull-request + - /articles/commenting-on-differences-between-files - /articles/commenting-on-a-pull-request - /github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request - /github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request -intro: リポジトリのプルリクエストのオープン後、コラボレーターや Team メンバーは、特定の 2 つのブランチ間におけるファイルの比較について、またプロジェクト全体についてコメントできます。 +intro: 'After you open a pull request in a repository, collaborators or team members can comment on the comparison of files between the two specified branches, or leave general comments on the project as a whole.' versions: fpt: '*' ghes: '*' @@ -18,49 +18,49 @@ topics: - Pull requests shortTitle: Comment on a PR --- +## About pull request comments -## プルリクエストのコメントについて +You can comment on a pull request's **Conversation** tab to leave general comments, questions, or props. You can also suggest changes that the author of the pull request can apply directly from your comment. -プルリクエストの [**Conversation**] タブに、一般的なコメント、質問、提案などを書き込むことができます。 プルリクエストの作者がコメントから直接適用できる変更を提案することもできます。 +![Pull Request conversation](/assets/images/help/pull_requests/conversation.png) -![プルリクエストの会話](/assets/images/help/pull_requests/conversation.png) +You can also comment on specific sections of a file on a pull request's **Files changed** tab in the form of individual line comments or as part of a [pull request review](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews). Adding line comments is a great way to discuss questions about implementation or provide feedback to the author. -プルリクエストの [**Files changed**] タブにあるファイルの、特定のセクションに、行コメントまたは [Pull Request レビュー](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)の一部としてコメントすることも可能です。 行コメントを追加することは、インプリメンテーションについての問題を話し合ったり、作者にフィードバックを行ったりする上でよい方法です。 - -Pull Request レビューへの行コメント追加に関する 詳しい情報については、「[プルリクエストで提案された変更をレビューする](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)」を参照してください。 +For more information on adding line comments to a pull request review, see ["Reviewing proposed changes in a pull request."](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request) {% note %} -**注釈:** プルリクエストにメールで返信した場合、そのコメントは [**Conversation**] タブに追加され、Pull Request レビューには含まれません。 +**Note:** If you reply to a pull request via email, your comment will be added on the **Conversation** tab and will not be part of a pull request review. {% endnote %} -既存の行コメントに返信するには、[**Conversation**] タブまたは [**Files changed**] タブに移動して、既存のコメントの下に行コメントを追加します。 +To reply to an existing line comment, you'll need to navigate to the comment on either the **Conversation** tab or **Files changed** tab and add an additional line comment below it. {% tip %} -**参考:** -- プルリクエストのコメントては、@メンション、絵文字、参照など、{% data variables.product.product_name %}の通常のコメントにおいてサポートされている[フォーマット](/categories/writing-on-github)がサポートされています。 +**Tips:** +- Pull request comments support the same [formatting](/categories/writing-on-github) as regular comments on {% data variables.product.product_name %}, such as @mentions, emoji, and references. - You can add reactions to comments in pull requests in the **Files changed** tab. {% endtip %} -## プルリクエストに行コメントを追加する +## Adding line comments to a pull request {% data reusables.repositories.sidebar-pr %} -2. プルリクエストのリストで、行コメントをしたいプルリクエストをクリックします。 +2. In the list of pull requests, click the pull request where you'd like to leave line comments. {% data reusables.repositories.changed-files %} {% data reusables.repositories.start-line-comment %} {% data reusables.repositories.type-line-comment %} {% data reusables.repositories.suggest-changes %} -5. 完了したら、[**Add single comment**] をクリックします。 ![インラインコメントウインドウ](/assets/images/help/commits/inline-comment.png) +5. When you're done, click **Add single comment**. + ![Inline comment window](/assets/images/help/commits/inline-comment.png) -プルリクエストまたはリポジトリを Watch している全員が、コメントの通知を受信します。 +Anyone watching the pull request or repository will receive a notification of your comment. {% data reusables.pull_requests.resolving-conversations %} -## 参考リンク +## Further reading -- [GitHubでの執筆](/github/writing-on-github) -{% ifversion fpt or ghec %}- 「[乱用やスパムをレポートする](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)」 +- "[Writing on GitHub](/github/writing-on-github)" +{% ifversion fpt or ghec %}- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" {% endif %} diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md index 5e6d884af4..bd7a9b087f 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md @@ -1,9 +1,9 @@ --- -title: プルリクエスト内のファイルをフィルタリングする -intro: 巨大なプルリクエスト内の変更を素早く確認できるように、変更されたファイルをフィルタリングできます。 +title: Filtering files in a pull request +intro: 'To help you quickly review changes in a large pull request, you can filter changed files.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request - - /articles/filtering-files-in-a-pull-request-by-file-type/ + - /articles/filtering-files-in-a-pull-request-by-file-type - /articles/filtering-files-in-a-pull-request - /github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request - /github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request @@ -16,22 +16,23 @@ topics: - Pull requests shortTitle: Filter files --- - -プルリクエスト内のファイルは、`.html` や `.js` などのファイル拡張子の種類、拡張子の欠如、コードの所有権、ドットファイルでフィルタリングできます。 +You can filter files in a pull request by file extension type, such as `.html` or `.js`, lack of an extension, code ownership, or dotfiles. {% tip %} -**ヒント:** ファイルのフィルタドロップダウンメニューから、プルリクエストの diff 内の削除されたファイル、または既に表示したファイルを一時的に非表示にして、プルリクエストの diff 表示を簡素化できます。 +**Tip:** To simplify your pull request diff view, you can also temporarily hide deleted files or files you have already viewed in the pull request diff from the file filter drop-down menu. {% endtip %} {% data reusables.repositories.sidebar-pr %} -2. プルリクエストのリストで、フィルタしたいプルリクエストをクリックします。 +2. In the list of pull requests, click the pull request you'd like to filter. {% data reusables.repositories.changed-files %} -4. [File filter] ドロップダウンメニュードロップダウンメニュー使って、目的のフィルタを選択、選択解除、またはクリックします。 ![プルリクエスト diff の上のファイルのフィルタオプション](/assets/images/help/pull_requests/file-filter-option.png) -5. オプションで、フィルタの選択をクリアするには、 [**Files changed**] タブの下で [**Clear**] をクリックします。 ![ファイルのフィルタの選択のクリア](/assets/images/help/pull_requests/clear-file-filter.png) +4. Use the File filter drop-down menu, and select, unselect, or click the desired filters. + ![File filter option above pull request diff](/assets/images/help/pull_requests/file-filter-option.png) +5. Optionally, to clear the filter selection, under the **Files changed** tab, click **Clear**. + ![Clear file filter selection](/assets/images/help/pull_requests/clear-file-filter.png) -## 参考リンク +## Further reading -- 「[プルリクエスト内のブランチの比較について](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)」 -- 「[プルリクエストで変更されたメソッドや機能を見つける](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request)」 +- "[About comparing branches in a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)" +- "[Finding changed methods and functions in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request)" diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md index 4fc9c3e23b..94e8467a8d 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md @@ -1,11 +1,11 @@ --- -title: Pull Request での変更をレビューする +title: Reviewing changes in pull requests redirect_from: - - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests/ - - /articles/reviewing-and-discussing-changes-in-pull-requests/ + - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests + - /articles/reviewing-and-discussing-changes-in-pull-requests - /articles/reviewing-changes-in-pull-requests - /github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests -intro: Pull Request が公開された後に、提案された一連の変更をレビューしたり議論したりできます。 +intro: 'After a pull request has been opened, you can review and discuss the set of proposed changes.' versions: fpt: '*' ghes: '*' @@ -25,6 +25,5 @@ children: - /approving-a-pull-request-with-required-reviews - /dismissing-a-pull-request-review - /checking-out-pull-requests-locally -shortTitle: 変更をレビュー +shortTitle: Review changes --- - diff --git a/translations/ja-JP/content/rest/guides/best-practices-for-integrators.md b/translations/ja-JP/content/rest/guides/best-practices-for-integrators.md index 7bf4f320d5..7ad5e448ca 100644 --- a/translations/ja-JP/content/rest/guides/best-practices-for-integrators.md +++ b/translations/ja-JP/content/rest/guides/best-practices-for-integrators.md @@ -1,8 +1,8 @@ --- -title: インテグレーターのためのベストプラクティス +title: Best practices for integrators intro: 'Build an app that reliably interacts with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API and provides the best experience for your users.' redirect_from: - - /guides/best-practices-for-integrators/ + - /guides/best-practices-for-integrators - /v3/guides/best-practices-for-integrators versions: fpt: '*' @@ -11,63 +11,84 @@ versions: ghec: '*' topics: - API -shortTitle: インテグレーターのベストプラクティス +shortTitle: Integrator best practices --- -GitHubプラットフォームとの統合に興味はありますか。 [同じことを思っている仲間がいますよ](https://github.com/integrations)。 このガイドは、ユーザに最高のエクスペリエンスを提供し、かつAPIと確実にやり取りするアプリを構築するために役立ちます。 +Interested in integrating with the GitHub platform? [You're in good company](https://github.com/integrations). This guide will help you build an app that provides the best experience for your users *and* ensure that it's reliably interacting with the API. -## GitHubから配信されるペイロードの機密を確保する +## Secure payloads delivered from GitHub -[GitHubから送信されたペイロード][event-types]の機密を確保することは非常に重要です。 ペイロードでパスワードなどの個人情報が送信されることはないものの、いかなる情報であれ漏洩することは好ましくありません。 コミッターのメールアドレスやプライベートリポジトリの名前などは、機密性が求められる場合があります。 +It's very important that you secure [the payloads sent from GitHub][event-types]. Although no personal information (like passwords) is ever transmitted in a payload, leaking *any* information is not good. Some information that might be sensitive include committer email address or the names of private repositories. -いくつかのステップを踏むことで、GitHubから配信されるペイロードを安全に受信できます。 +There are several steps you can take to secure receipt of payloads delivered by GitHub: -1. 受信サーバーは必ずHTTPS接続にしてください。 デフォルトでは、GitHubはペイロードを配信する際にSSL証明書を検証します。{% ifversion fpt or ghec %} -1. [フック配信時に使用するIPアドレス](/github/authenticating-to-github/about-githubs-ip-addresses)をサーバーの許可リストに追加できます。 正しいIPアドレスを常に確認していることを確かめるため、[`/meta`エンドポイントを使用して](/rest/reference/meta#meta)GitHubが使用するアドレスを見つけることができます。{% endif %} -1. ペイロードがGitHubから配信されていることを確実に保証するため、[シークレットトークン](/webhooks/securing/)を提供します。 シークレットトークンを強制することにより、サーバーが受信するあらゆるデータが確実にGitHubから来ていることを保証できます。 サービスの*ユーザごと*に異なるシークレットトークンを提供するのが理想的です。 そうすれば、1つのトークンが侵害されても、他のユーザは影響を受けません。 +1. Ensure that your receiving server is on an HTTPS connection. By default, GitHub will verify SSL certificates when delivering payloads.{% ifversion fpt or ghec %} +1. You can add [the IP address we use when delivering hooks](/github/authenticating-to-github/about-githubs-ip-addresses) to your server's allow list. To ensure that you're always checking the right IP address, you can [use the `/meta` endpoint](/rest/reference/meta#meta) to find the address we use.{% endif %} +1. Provide [a secret token](/webhooks/securing/) to ensure payloads are definitely coming from GitHub. By enforcing a secret token, you're ensuring that any data received by your server is absolutely coming from GitHub. Ideally, you should provide a different secret token *per user* of your service. That way, if one token is compromised, no other user would be affected. -## 同期作業より非同期作業を優先する +## Favor asynchronous work over synchronous -GitHubは、webhookペイロードを受信後{% ifversion fpt or ghec %}10{% else %}30{% endif %}秒以内にインテグレーションが応答することを求めています。 サービスの応答時間がそれ以上になると、GitHubは接続を中止し、ペイロードは失われます。 +GitHub expects that integrations respond within {% ifversion fpt or ghec %}10{% else %}30{% endif %} seconds of receiving the webhook payload. If your service takes longer than that to complete, then GitHub terminates the connection and the payload is lost. -サービスの完了時間を予測することは不可能なので、「実際の作業」のすべてはバックグラウンドジョブで実行すべきです。 バックグラウンドジョブのキューや処理を扱えるライブラリには、[Resque](https://github.com/resque/resque/) (Ruby用)、[RQ](http://python-rq.org/) (Python用)、[RabbitMQ](http://www.rabbitmq.com/)などがあります。 +Since it's impossible to predict how fast your service will complete, you should do all of "the real work" in a background job. [Resque](https://github.com/resque/resque/) (for Ruby), [RQ](http://python-rq.org/) (for Python), or [RabbitMQ](http://www.rabbitmq.com/) (for Java) are examples of libraries that can handle queuing and processing of background jobs. -バックグラウンドジョブが実行中でも、GitHubはサーバが{% ifversion fpt or ghec %}10{% else %}30{% endif %}秒以内で応答することを求めていることに注意してください。 サーバは何らかの応答を送信することにより、ペイロードの受信を確認する必要があります。 サービスがペイロードについての確認を可能な限り速やかに行うことは非常に重要です。そうすることにより、サーバがリクエストを継続するかどうか正確に報告できます。 +Note that even with a background job running, GitHub still expects your server to respond within {% ifversion fpt or ghec %}ten{% else %}thirty{% endif %} seconds. Your server needs to acknowledge that it received the payload by sending some sort of response. It's critical that your service performs any validations on a payload as soon as possible, so that you can accurately report whether your server will continue with the request or not. -## GitHubへの応答時に適切なHTTPステータスコードを使用する +## Use appropriate HTTP status codes when responding to GitHub -各webhookには、デプロイメントが成功したかどうかを列挙する独自の「最近のデリバリ」セクションがあります。 +Every webhook has its own "Recent Deliveries" section, which lists whether a deployment was successful or not. -![[Recent Deliveries] ビュー](/assets/images/webhooks_recent_deliveries.png) +![Recent Deliveries view](/assets/images/webhooks_recent_deliveries.png) -ユーザへの通知には、適切なHTTPステータスコードを使用するべきです。 (デフォルトでないブランチから配信されたペイロードなど) 処理できないペイロードの受信を知らせるため、`201`や`202`といったコードを使用できます。 `500`のエラーコードは、致命的な障害に用いましょう。 +You should make use of proper HTTP status codes in order to inform users. You can use codes like `201` or `202` to acknowledge receipt of payload that won't be processed (for example, a payload delivered by a branch that's not the default). Reserve the `500` error code for catastrophic failures. -## ユーザにできるだけ多くの情報を提供する +## Provide as much information as possible to the user -ユーザはGitHubに返信したサーバーの応答を調べることができます。 メッセージは明確で参考になるものとしてください。 +Users can dig into the server responses you send back to GitHub. Ensure that your messages are clear and informative. -![ペイロードレスポンスの表示](/assets/images/payload_response_tab.png) +![Viewing a payload response](/assets/images/payload_response_tab.png) -## APIが送信するあらゆるAPIに従う +## Follow any redirects that the API sends you -GitHubは、リダイレクトのステータスコードを提供することにより、リソースがいつ移動したかを明示します。 このリダイレクトに従ってください。 すべてのリダイレクト応答は、`Location`ヘッダに、移動する新しいURIを設定します。 リダイレクトを受け取ったら、削除する可能性がある非推奨のパスをリクエストしている場合、新しいURIにしたがってコードを更新するようお勧めします。 +GitHub is explicit in telling you when a resource has moved by providing a redirect status code. You should follow these redirections. Every redirect response sets the `Location` header with the new URI to go to. If you receive a redirect, it's best to update your code to follow the new URI, in case you're requesting a deprecated path that we might remove. -アプリケーションをリダイレクトに従うよう設計する際に気をつけるべき[HTTPステータスコードのリスト](/rest#http-redirects)をご用意しています。 +We've provided [a list of HTTP status codes](/rest#http-redirects) to watch out for when designing your app to follow redirects. -## 手動でURLをパースしない +## Don't manually parse URLs -APIレスポンスには、URLの形でデータが含まれていることがよくあります。 たとえば、リポジトリをリクエストするときは、リポジトリをクローンするために使用できるURLの付いた`clone_url`というキーを送信します。 +Often, API responses contain data in the form of URLs. For example, when requesting a repository, we'll send a key called `clone_url` with a URL you can use to clone the repository. -アプリケーションの安定性を保つため、このデータをパースしようとしたり、先のURLの形式を予想して作成しようとしたりしないでください。 URLを変更した場合、アプリケーションが壊れるおそれがあります。 +For the stability of your app, you shouldn't try to parse this data or try to guess and construct the format of future URLs. Your app is liable to break if we decide to change the URL. -たとえば、ページネーションされた結果を扱う際は、末尾に`?page=`を付けてURLを構築したいと思うことがあります。 この誘惑に負けてはなりません。 [ページネーションに関するガイド](/guides/traversing-with-pagination)には、ページネーションされた結果を安全に扱うための信頼できるヒントがいくつか掲載されています。 +For example, when working with paginated results, it's often tempting to construct URLs that append `?page=` to the end. Avoid that temptation. [Our guide on pagination](/guides/traversing-with-pagination) offers some safe tips on dependably following paginated results. -## イベントの処理前にイベントのタイプとアクションを確認する +## Check the event type and action before processing the event -[webhookのイベントタイプ][event-types]は複数あり、各イベントは複数のアクションを持つことができます。 GitHubの機能セットが増えるにつれて、新しいイベントタイプを追加したり、既存のイベントタイプに新しいアクションを追加したりすることがあります。 Webhookの処理を行う前に、イベントのタイプとアクションをアプリケーションが明示的に確認するようにしてください。 `X-GitHub-Event`リクエストヘッダは、受信したイベントの種類を知り、それを適切に処理するために利用できます。 同様に、ペイロードにはトップレベルの`action`キーがあり、関連オブジェクトに対して実行されたアクションを知るために利用できます。 +There are multiple [webhook event types][event-types], and each event can have multiple actions. As GitHub's feature set grows, we will occasionally add new event types or add new actions to existing event types. Ensure that your application explicitly checks the type and action of an event before doing any webhook processing. The `X-GitHub-Event` request header can be used to know which event has been received so that processing can be handled appropriately. Similarly, the payload has a top-level `action` key that can be used to know which action was taken on the relevant object. -たとえば、GitHubのwebhookを [Send me **everything**] に設定している場合、新しいイベントのタイプやアクションが追加されると、アプリケーションはそれらの受信を開始します。 ですから、**あらゆる類のcatch-all else構文は使用をお勧めしません**。 たとえば、次のコード例をご覧ください。 +For example, if you have configured a GitHub webhook to "Send me **everything**", your application will begin receiving new event types and actions as they are added. It is therefore **not recommended to use any sort of catch-all else clause**. Take the following code example: + +```ruby +# Not recommended: a catch-all else clause +def receive + event_type = request.headers["X-GitHub-Event"] + payload = request.body + + case event_type + when "repository" + process_repository(payload) + when "issues" + process_issues(payload) + else + process_pull_requests + end +end +``` + +In this code example, the `process_repository` and `process_issues` methods will be correctly called if a `repository` or `issues` event was received. However, any other event type would result in `process_pull_requests` being called. As new event types are added, this would result in incorrect behavior and new event types would be processed in the same way that a `pull_request` event would be processed. + +Instead, we suggest explicitly checking event types and acting accordingly. In the following code example, we explicitly check for a `pull_request` event and the `else` clause simply logs that we've received a new event type: ```ruby # Recommended: explicitly check each event type @@ -88,32 +109,9 @@ def receive end ``` -このコード例では、`repository`または`issues`イベントを受信すると、`process_repository`および`process_issues`メソッドが正しく呼び出されます。 しかし、他のイベントタイプでは、`process_pull_requests`が呼び出されることになります。 新しいイベントタイプが追加されると、誤った動作を引き起こすことになり、新たなイベントタイプは`pull_request`イベントと同じ方法で処理されることになるでしょう。 +Because each event can also have multiple actions, it's recommended that actions are checked similarly. For example, the [`IssuesEvent`](/webhooks/event-payloads/#issues) has several possible actions. These include `opened` when the issue is created, `closed` when the issue is closed, and `assigned` when the issue is assigned to someone. -代わりに、イベントのタイプを明示的に確認し、それに応じて処理するようお勧めします。 次のコード例では、`pull_request`イベントを明示的に確認し、`else`節は新しいイベントタイプを受信したことを単に記録しています。 - -```ruby -# Recommended: explicitly check each event type -def receive - event_type = request.headers["X-GitHub-Event"] - payload = JSON.parse(request.body) - - case event_type - when "repository" - process_repository(payload) - when "issues" - process_issue(payload) - when "pull_request" - process_pull_requests(payload) - else - puts "Oooh, something new from GitHub: #{event_type}" - end -end -``` - -各イベントも複数のアクションを持つことができるため、アクションも同様に確認することをお勧めします。 たとえば、[`IssuesEvent`](/webhooks/event-payloads/#issues)ではいくつかのアクションが可能です。 例としては、Issueが作成されたときの`opened`、Issueがクローズしたときの`closed`、Issueが誰かに割り当てられたときの`assigned`が挙げられます。 - -イベントタイプを追加するのと同じように、既存のイベントに新しいアクションを追加できます。 ですから、イベントのアクションを確認する場合も**>あらゆる類のcatch-all else構文は使用をお勧めしません**。 代わりに、イベントタイプの例と同様、イベントのアクションも明示的に確認するようお勧めします。 この例は、上記のイベントタイプで示したものと非常に似通ったものです。 +As with adding event types, we may add new actions to existing events. It is therefore again **not recommended to use any sort of catch-all else clause** when checking an event's action. Instead, we suggest explicitly checking event actions as we did with the event type. An example of this looks very similar to what we suggested for event types above: ```ruby # Recommended: explicitly check each action @@ -131,40 +129,47 @@ def process_issue(payload) end ``` -この例では、始めに`closed`アクションを確認してから、`process_closed`メソッドを呼びます。 未確認のアクションは、今後の参考のために記録されます。 +In this example the `closed` action is checked first before calling the `process_closed` method. Any unidentified actions are logged for future reference. {% ifversion fpt or ghec %} -## レート制限の扱い +## Dealing with rate limits -GitHub APIの[レート制限](/rest/overview/resources-in-the-rest-api#rate-limiting)は、APIを高速に保ち、すべての人が利用できるために設けられています。 +The GitHub API [rate limit](/rest/overview/resources-in-the-rest-api#rate-limiting) ensures that the API is fast and available for everyone. -レート制限に達した場合、リクエストを中止し、許可された後で再度お試しください。 リクエストを中止しない場合は、アプリケーションを禁止する場合があります。 +If you hit a rate limit, it's expected that you back off from making requests and try again later when you're permitted to do so. Failure to do so may result in the banning of your app. -[レート制限ステータスの確認](/rest/reference/rate-limit)はいつでも可能です。 レート制限を確認しても、その通信量はレート制限に影響しません。 +You can always [check your rate limit status](/rest/reference/rate-limit) at any time. Checking your rate limit incurs no cost against your rate limit. ## Dealing with secondary rate limits -[Secondary rate limits](/rest/overview/resources-in-the-rest-api#secondary-rate-limits) are another way we ensure the API's availability. この制限に到達することを避けるため、アプリケーションは以下のガイドラインに従うようにしてください。 +[Secondary rate limits](/rest/overview/resources-in-the-rest-api#secondary-rate-limits) are another way we ensure the API's availability. +To avoid hitting this limit, you should ensure your application follows the guidelines below. -* 認証済みのリクエストを行うか、アプリケーションのクライアントIDとシークレットを使用してください。 Unauthenticated requests are subject to more aggressive secondary rate limiting. -* 単一のユーザまたはクライアントIDに順番にリクエストを行ってください。 単一のユーザまたはクライアントIDのリクエストは同時に行わないでください。 -* 単一のユーザまたはクライアントIDで多数の`POST`、`PATCH`、`PUT`、`DELETE`リクエストを行う場合には、リクエストごとに少なくとも1秒の間隔をとってください。 -* 制限がかかっている間は、速さを遅くするため`Retry-After`レスポンスヘッダを使用します。 `Retry-After`ヘッダの値は常に整数とします。この値は、再度リクエストを行う前に待機すべき秒数を示します。 たとえば、`Retry-After: 30`は、次のリクエストを送信するまで30秒待機する必要があることを意味します。 -* コメント、プルリクエストなど、通知をトリガーするようなコンテンツを作成するリクエストは、さらなる制限が課される場合があり、レスポンスに`Retry-After`ヘッダが含まれません。 さらなる制限を避けるため、こうしたコンテンツを合理的なペースで作成してください。 +* Make authenticated requests, or use your application's client ID and secret. Unauthenticated + requests are subject to more aggressive secondary rate limiting. +* Make requests for a single user or client ID serially. Do not make requests for a single user + or client ID concurrently. +* If you're making a large number of `POST`, `PATCH`, `PUT`, or `DELETE` requests for a single user + or client ID, wait at least one second between each request. +* When you have been limited, use the `Retry-After` response header to slow down. The value of the + `Retry-After` header will always be an integer, representing the number of seconds you should wait + before making requests again. For example, `Retry-After: 30` means you should wait 30 seconds + before sending more requests. +* Requests that create content which triggers notifications, such as issues, comments and pull requests, + may be further limited and will not include a `Retry-After` header in the response. Please create this + content at a reasonable pace to avoid further limiting. -当社は、可用性確保のため必要に応じてこれらのガイドラインを変更する権利を留保します。 +We reserve the right to change these guidelines as needed to ensure availability. {% endif %} -## APIエラーの扱い +## Dealing with API errors -あなたのコードが決してバグを発生させなかったとしても、APIにアクセスしようとするとき立て続けにエラーが発生することがるかもしれません。 +Although your code would never introduce a bug, you may find that you've encountered successive errors when trying to access the API. -繰り返し表示される`4xx`や `5xx`のステータスコードを無視せずに、APIと正しくやり取りしていることを確認してください。 たとえば、エンドポイントが文字列を要求しているのに数値を渡している場合、`5xx`検証エラーが発生し、呼び出しは成功しません。 同様に、許可されていないエンドポイントまたはは存在しないエンドポイントにアクセスしようとすると、`4xx`エラーが発生します。 +Rather than ignore repeated `4xx` and `5xx` status codes, you should ensure that you're correctly interacting with the API. For example, if an endpoint requests a string and you're passing it a numeric value, you're going to receive a `5xx` validation error, and your call won't succeed. Similarly, attempting to access an unauthorized or nonexistent endpoint will result in a `4xx` error. -繰り返し発生する検証エラーを意図的に無視すると、不正利用によりアプリケーションが停止されることがあります。 - -[event-types]: /webhooks/event-payloads +Intentionally ignoring repeated validation errors may result in the suspension of your app for abuse. [event-types]: /webhooks/event-payloads diff --git a/translations/ja-JP/content/rest/guides/building-a-ci-server.md b/translations/ja-JP/content/rest/guides/building-a-ci-server.md index f4a46e58c0..dbcec20196 100644 --- a/translations/ja-JP/content/rest/guides/building-a-ci-server.md +++ b/translations/ja-JP/content/rest/guides/building-a-ci-server.md @@ -1,8 +1,8 @@ --- -title: CIサーバーの構築 -intro: Status APIで独自のCIシステムを構築しましょう。 +title: Building a CI server +intro: Build your own CI system using the Status API. redirect_from: - - /guides/building-a-ci-server/ + - /guides/building-a-ci-server - /v3/guides/building-a-ci-server versions: fpt: '*' @@ -15,22 +15,31 @@ topics: -[Status API][status API]は、コミットをテストのサービスと結びつけて、各プッシュがテストされ、{% data variables.product.product_name %}のプルリクエストとするようにする役割を果たします。 +The [Status API][status API] is responsible for tying together commits with +a testing service, so that every push you make can be tested and represented +in a {% data variables.product.product_name %} pull request. -このAPIでは、ステータスAPIを使って、利用できる設定を示します。 このシナリオでは、以下を行います。 +This guide will use that API to demonstrate a setup that you can use. +In our scenario, we will: -* プルリクエストが開かれたときにCIスイートを実行します (CIステータスを保留中に設定します)。 -* CIが終了したら、それに応じてプルリクエストのステータスを設定します。 +* Run our CI suite when a Pull Request is opened (we'll set the CI status to pending). +* When the CI is finished, we'll set the Pull Request's status accordingly. -このCIシステムとホストサーバーは、想像上のものです。 Travisでも、Jenkinsでも、何でも構いません。 このガイドのポイントは、通信を管理するサーバーを設定し、構成することにあります。 +Our CI system and host server will be figments of our imagination. They could be +Travis, Jenkins, or something else entirely. The crux of this guide will be setting up +and configuring the server managing the communication. -まだngrokをダウンロードしていない場合は[ダウンロード][ngrok]し、その[使いかた][using ngrok]を学びましょう。 これはローカル接続を公開するために非常に役立つツールだと思います。 +If you haven't already, be sure to [download ngrok][ngrok], and learn how +to [use it][using ngrok]. We find it to be a very useful tool for exposing local +connections. -注釈: このプロジェクトの完全なソースコードは、[platform-samplesリポジトリ][platform samples]からダウンロードできます。 +Note: you can download the complete source code for this project +[from the platform-samples repo][platform samples]. -## サーバーを書く +## Writing your server -ローカル接続が機能していることを証明するための、簡単なSinatraアプリケーションを書きます。 まずは以下のソースから始めましょう。 +We'll write a quick Sinatra app to prove that our local connections are working. +Let's start with this: ``` ruby require 'sinatra' @@ -42,20 +51,29 @@ post '/event_handler' do end ``` -(シナトラの仕組みに詳しくない方は、[Sinatraのガイド][Sinatra]を読むことをお勧めします。) +(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide][Sinatra].) -このサーバーを起動してください。 デフォルトでは、Sinatraはポート`4567`で起動するため、このポートもリッスンを開始するようngrokを設定するとよいでしょう。 +Start this server up. By default, Sinatra starts on port `4567`, so you'll want +to configure ngrok to start listening for that, too. -このサーバーが機能するには、webhookでリポジトリを設定する必要があります。 プルリクエストが作成やマージされるたびに、webhookが起動するよう設定すべきです。 なんでも好きにして構わないようなリポジトリを作成しましょう。 [@octocat's Spoon/Knifeリポジトリ](https://github.com/octocat/Spoon-Knife)などはどうでしょうか。 その後、リポジトリ内に新しいwebhookを作成し、ngrokが提供したURLを指定し、コンテンツタイプとして`application/x-www-form-urlencoded`を選択します。 +In order for this server to work, we'll need to set a repository up with a webhook. +The webhook should be configured to fire whenever a Pull Request is created, or merged. +Go ahead and create a repository you're comfortable playing around in. Might we +suggest [@octocat's Spoon/Knife repository](https://github.com/octocat/Spoon-Knife)? +After that, you'll create a new webhook in your repository, feeding it the URL +that ngrok gave you, and choosing `application/x-www-form-urlencoded` as the +content type: -![新しいngrok URL](/assets/images/webhook_sample_url.png) +![A new ngrok URL](/assets/images/webhook_sample_url.png) -**Update webhook（webhookの更新）**をクリックしてください。 本文に`Well, it worked!`というレスポンスが表示されるはずです。 これでうまくいきました。 [**Let me select individual events**]をクリックし、以下を選択します。 +Click **Update webhook**. You should see a body response of `Well, it worked!`. +Great! Click on **Let me select individual events**, and select the following: -* 状況 -* プルリクエスト +* Status +* Pull Request -これらは、関係するアクションが発生するごとに{% data variables.product.product_name %}がこのサーバーに送信するイベントです。 では、ここでプルリクエストのシナリオ*だけ*を処理するようサーバーを更新しましょう。 +These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action +occurs. Let's update our server to *just* handle the Pull Request scenario right now: ``` ruby post '/event_handler' do @@ -76,15 +94,26 @@ helpers do end ``` -さて、ここで起こっていることを説明しましょう。 {% data variables.product.product_name %}が送信するすべてのイベントには、`X-GitHub-Event` HTTPヘッダが添付されています。 ここではPRイベントのみに注目しましょう。 そこから、情報のペイロードを取得し、タイトルのフィールドを返します。 理想的なシナリオにおいては、サーバはプルリクエストが開かれたときだけではなく、更新されるごとに関与します。 そうすると、すべての新しいプッシュがCIテストに合格するようになります。 しかしこのデモでは、開かれたときについてのみ気にすることにしましょう。 +What's going on? Every event that {% data variables.product.product_name %} sends out attached a `X-GitHub-Event` +HTTP header. We'll only care about the PR events for now. From there, we'll +take the payload of information, and return the title field. In an ideal scenario, +our server would be concerned with every time a pull request is updated, not just +when it's opened. That would make sure that every new push passes the CI tests. +But for this demo, we'll just worry about when it's opened. -この概念実証を試すため、テストリポジトリのブランチで何か変更を行い、プルリクエストを開きます。 そうすると、サーバーはそれに応じてレスポンスを返すはずです。 +To test out this proof-of-concept, make some changes in a branch in your test +repository, and open a pull request. Your server should respond accordingly! -## ステータスを扱う +## Working with statuses -サーバーの環境を整えたところで、最初の要件、すなわちCIステータスの設定 (および更新) を行う準備が整いました。 サーバーを更新するごとに、[**Redeliver**]をクリックして同じペイロードを送信できます。 変更を行うたびに新しいプルリクエストを作成する必要はありません。 +With our server in place, we're ready to start our first requirement, which is +setting (and updating) CI statuses. Note that at any time you update your server, +you can click **Redeliver** to send the same payload. There's no need to make a +new pull request every time you make a change! -Since we're interacting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll use [Octokit.rb][octokit.rb] to manage our interactions. そのクライアントは、以下のように構成します。 +Since we're interacting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll use [Octokit.rb][octokit.rb] +to manage our interactions. We'll configure that client with +[a personal access token][access token]: ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -96,7 +125,8 @@ before do end ``` -後は、CIで処理していることを明確にするため、{% data variables.product.product_name %}のプルリクエストを更新するだけでよいのです。 +After that, we'll just need to update the pull request on {% data variables.product.product_name %} to make clear +that we're processing on the CI: ``` ruby def process_pull_request(pull_request) @@ -105,13 +135,16 @@ def process_pull_request(pull_request) end ``` -ここでは3つの基本的なことを行っています。 +We're doing three very basic things here: -* リポジトリのフルネームを検索する -* プルリクエストの最後のSHAを検索する -* ステータスを「保留中」に設定する +* we're looking up the full name of the repository +* we're looking up the last SHA of the pull request +* we're setting the status to "pending" -これで完了です。 これで、テストスイートを実行するために必要なあらゆる処理を行うことができます。 コードをJenkinsに渡すことも、API経由で[Travis][travis api]のような別のウェブサービスを呼び出すことも可能です。 その後は、ステータスをもう一度更新するようにしてください。 次の例では、ステータスを単に`"success"`と設定します。 +That's it! From here, you can run whatever process you need to in order to execute +your test suite. Maybe you're going to pass off your code to Jenkins, or call +on another web service via its API, like [Travis][travis api]. After that, you'd +be sure to update the status once more. In our example, we'll just set it to `"success"`: ``` ruby def process_pull_request(pull_request) @@ -120,24 +153,33 @@ def process_pull_request(pull_request) @client.create_status(pull_request['base']['repo']['full_name'], pull_request['head']['sha'], 'success') puts "Pull request processed!" end -``` +``` -## おわりに +## Conclusion -GitHubでは長年、CIを管理するため[Janky][janky]の特定のバージョンを使用してきました。 その基本的なフローは、上記で構築してきたサーバーと本質的にまったく同じです。 GitHubでは、以下を実行しています。 +At GitHub, we've used a version of [Janky][janky] to manage our CI for years. +The basic flow is essentially the exact same as the server we've built above. +At GitHub, we: -* プルリクエストが作成または更新されたときにJenkinsに送信する (Janky経由) -* CIのステータスについてレスポンスを待つ -* コードが緑色なら、プルリクエストにマージする +* Fire to Jenkins when a pull request is created or updated (via Janky) +* Wait for a response on the state of the CI +* If the code is green, we merge the pull request -これら全ての通信は、チャットルームに集約されます。 この例を使用するために、独自のCI設定を構築する必要はありません。 いつでも[GitHubインテグレーション][integrations]に頼ることができます。 +All of this communication is funneled back to our chat rooms. You don't need to +build your own CI setup to use this example. +You can always rely on [GitHub integrations][integrations]. +[deploy API]: /rest/reference/repos#deployments [status API]: /rest/reference/repos#statuses [ngrok]: https://ngrok.com/ [using ngrok]: /webhooks/configuring/#using-ngrok [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/building-a-ci-server [Sinatra]: http://www.sinatrarb.com/ +[webhook]: /webhooks/ [octokit.rb]: https://github.com/octokit/octokit.rb +[access token]: /articles/creating-an-access-token-for-command-line-use [travis api]: https://api.travis-ci.org/docs/ [janky]: https://github.com/github/janky +[heaven]: https://github.com/atmos/heaven +[hubot]: https://github.com/github/hubot [integrations]: https://github.com/integrations diff --git a/translations/ja-JP/content/rest/guides/delivering-deployments.md b/translations/ja-JP/content/rest/guides/delivering-deployments.md index 1b9f4d99c2..13ad16c3da 100644 --- a/translations/ja-JP/content/rest/guides/delivering-deployments.md +++ b/translations/ja-JP/content/rest/guides/delivering-deployments.md @@ -1,9 +1,9 @@ --- -title: デプロイメントを配信する -intro: Deployment REST APIを使用すると、サーバーおよびサードパーティアプリケーションとやり取りするカスタムツールを構築できます。 +title: Delivering deployments +intro: 'Using the Deployments REST API, you can build custom tooling that interacts with your server and a third-party app.' redirect_from: - - /guides/delivering-deployments/ - - /guides/automating-deployments-to-integrators/ + - /guides/delivering-deployments + - /guides/automating-deployments-to-integrators - /v3/guides/delivering-deployments versions: fpt: '*' @@ -16,23 +16,33 @@ topics: -[Deployment API][deploy API]は、{% data variables.product.product_name %}にホストされたプロジェクトが、あなたのサーバーで起動できるようにします。 [Status API][status API]と組み合わせれば、コードがデフォルトブランチに到着してからすぐにデプロイメントを調整できるようになります。 +The [Deployments API][deploy API] provides your projects hosted on {% data variables.product.product_name %} with +the capability to launch them on a server that you own. Combined with +[the Status API][status API], you'll be able to coordinate your deployments +the moment your code lands on the default branch. -このAPIでは、ステータスAPIを使って、利用できる設定を示します。 このシナリオでは、以下を行います。 +This guide will use that API to demonstrate a setup that you can use. +In our scenario, we will: -* ププルリクエストをマージします。 -* CIが終了したら、それに応じてプルリクエストのステータスを設定します。 -* プルリクエストがマージされたら、サーバーでデプロイメントを実行します。 +* Merge a pull request +* When the CI is finished, we'll set the pull request's status accordingly. +* When the pull request is merged, we'll run our deployment to our server. -このCIシステムとホストサーバーは、想像上のものです。 Herokuでも、Amazonでも、何でも構いません。 このガイドのポイントは、通信を管理するサーバーを設定し、構成することにあります。 +Our CI system and host server will be figments of our imagination. They could be +Heroku, Amazon, or something else entirely. The crux of this guide will be setting up +and configuring the server managing the communication. -まだngrokをダウンロードしていない場合は[ダウンロード][ngrok]し、その[使いかた][using ngrok]を学びましょう。 これはローカル接続を公開するために非常に役立つツールだと思います。 +If you haven't already, be sure to [download ngrok][ngrok], and learn how +to [use it][using ngrok]. We find it to be a very useful tool for exposing local +connections. -注釈: このプロジェクトの完全なソースコードは、[platform-samplesリポジトリ][platform samples]からダウンロードできます。 +Note: you can download the complete source code for this project +[from the platform-samples repo][platform samples]. -## サーバーを書く +## Writing your server -ローカル接続が機能していることを証明するための、簡単なSinatraアプリケーションを書きます。 まずは以下のソースから始めましょう。 +We'll write a quick Sinatra app to prove that our local connections are working. +Let's start with this: ``` ruby require 'sinatra' @@ -44,21 +54,31 @@ post '/event_handler' do end ``` -(シナトラの仕組みに詳しくない方は、[Sinatraのガイド][Sinatra]を読むことをお勧めします。) +(If you're unfamiliar with how Sinatra works, we recommend [reading the Sinatra guide][Sinatra].) -このサーバーを起動してください。 デフォルトでは、Sinatraはポート`4567`で起動するため、このポートもリッスンを開始するようngrokを設定するとよいでしょう。 +Start this server up. By default, Sinatra starts on port `4567`, so you'll want +to configure ngrok to start listening for that, too. -このサーバーが機能するには、webhookでリポジトリを設定する必要があります。 プルリクエストが作成やマージされるたびに、webhookが起動するよう設定すべきです。 なんでも好きにして構わないようなリポジトリを作成しましょう。 [@octocat's Spoon/Knifeリポジトリ](https://github.com/octocat/Spoon-Knife)などはどうでしょうか。 その後、リポジトリ内に新しいwebhookを作成し、ngrokが提供したURLを指定し、コンテンツタイプとして`application/x-www-form-urlencoded`を選択します。 +In order for this server to work, we'll need to set a repository up with a webhook. +The webhook should be configured to fire whenever a pull request is created, or merged. +Go ahead and create a repository you're comfortable playing around in. Might we +suggest [@octocat's Spoon/Knife repository](https://github.com/octocat/Spoon-Knife)? +After that, you'll create a new webhook in your repository, feeding it the URL +that ngrok gave you, and choosing `application/x-www-form-urlencoded` as the +content type: -![新しいngrok URL](/assets/images/webhook_sample_url.png) +![A new ngrok URL](/assets/images/webhook_sample_url.png) -**Update webhook（webhookの更新）**をクリックしてください。 本文に`Well, it worked!`というレスポンスが表示されるはずです。 これでうまくいきました。 [**Let me select individual events**]をクリックし、以下を選択します。 +Click **Update webhook**. You should see a body response of `Well, it worked!`. +Great! Click on **Let me select individual events.**, and select the following: -* デプロイメント -* デプロイメントステータス -* プルリクエスト +* Deployment +* Deployment status +* Pull Request -これらは、関係するアクションが発生するごとに{% data variables.product.product_name %}がこのサーバーに送信するイベントです。 ここではプルリクエストがマージされたときの処理*だけ*を処理するようサーバーを設定します。 +These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action +occurs. We'll configure our server to *just* handle when pull requests are merged +right now: ``` ruby post '/event_handler' do @@ -73,15 +93,20 @@ post '/event_handler' do end ``` -さて、ここで起こっていることを説明しましょう。 {% data variables.product.product_name %}が送信するすべてのイベントには、`X-GitHub-Event` HTTPヘッダが添付されています。 ここではPRイベントのみに注目しましょう。 プルリクエストがマージされると (ステータスが`closed`となり、`merged`が`true`になると)、デプロイメントを開始します。 +What's going on? Every event that {% data variables.product.product_name %} sends out attached a `X-GitHub-Event` +HTTP header. We'll only care about the PR events for now. When a pull request is +merged (its state is `closed`, and `merged` is `true`), we'll kick off a deployment. -この概念実証を試すため、テストリポジトリのブランチで何か変更を行い、プルリクエストを開いてマージします。 そうすると、サーバーはそれに応じてレスポンスを返すはずです。 +To test out this proof-of-concept, make some changes in a branch in your test +repository, open a pull request, and merge it. Your server should respond accordingly! -## デプロイメントを扱う +## Working with deployments -サーバーの準備が整い、コードがレビューされ、プルリクエストがマージされたので、プロジェクトをデプロイしたいと思います。 +With our server in place, the code being reviewed, and our pull request +merged, we want our project to be deployed. -まず、イベントリスナーを修正し、マージされたときにプルリクエストを処理して、デプロイメントの待機を開始することから始めましょう。 +We'll start by modifying our event listener to process pull requests when they're +merged, and start paying attention to deployments: ``` ruby when "pull_request" @@ -95,7 +120,8 @@ when "deployment_status" end ``` -プルリクエストからの情報に基づき、`start_deployment`メソッドを書き込むことから始めます。 +Based on the information from the pull request, we'll start by filling out the +`start_deployment` method: ``` ruby def start_deployment(pull_request) @@ -105,13 +131,19 @@ def start_deployment(pull_request) end ``` -デプロイメントには、`payload`および`description`の形式で、一部のメタデータを添付できます。 これらの値はオプションですが、ログの記録や情報の表示に役立ちます。 +Deployments can have some metadata attached to them, in the form of a `payload` +and a `description`. Although these values are optional, it's helpful to use +for logging and representing information. -新しいデプロイメントが作成されると、まったく別のイベントがトリガーされます。 ですから、`deployment`のために、イベントハンドラーの`switch`に新たなcaseを用意します。 この情報を使用して、デプロイメントがトリガーされたときに通知を受け取ることができます。 +When a new deployment is created, a completely separate event is triggered. That's +why we have a new `switch` case in the event handler for `deployment`. You can +use this information to be notified when a deployment has been triggered. -デプロイメントにはかなり時間がかかる場合があるため、デプロイメントがいつ作成されたか、デプロイメントのステータスなどのさまざまなイベントをリッスンしたいと思います。 +Deployments can take a rather long time, so we'll want to listen for various events, +such as when the deployment was created, and what state it's in. -何かの作業をするデプロイメントをシミュレートし、その影響を出力として通知しましょう。 まず、`process_deployment`メソッドを完成させます。 +Let's simulate a deployment that does some work, and notice the effect it has on +the output. First, let's complete our `process_deployment` method: ``` ruby def process_deployment @@ -125,7 +157,7 @@ def process_deployment end ``` -最後に、ステータス情報の保存をコンソールの出力としてシミュレートします。 +Finally, we'll simulate storing the status information as console output: ``` ruby def update_deployment_status @@ -133,20 +165,27 @@ def update_deployment_status end ``` -ここの処理を細かく説明しましょう。 新しいデプロイメントが`start_deployment`により作成され、それが`deployment`イベントをトリガーします。 そこから`process_deployment`を呼び出して、実行中の作業をシミュレートします。 この処理の間に`create_deployment_status`も呼び出し、ステータスを`pending`に切り替えることで受信側に状態を通知します。 +Let's break down what's going on. A new deployment is created by `start_deployment`, +which triggers the `deployment` event. From there, we call `process_deployment` +to simulate work that's going on. During that processing, we also make a call to +`create_deployment_status`, which lets a receiver know what's going on, as we +switch the status to `pending`. -デプロイメントが完了後、ステータスを`success`に設定します。 +After the deployment is finished, we set the status to `success`. -## おわりに +## Conclusion -GitHubでは長年、デプロイメントを管理するため[Heaven][heaven]の特定のバージョンを使用してきました。 A common flow is essentially the same as the server we've built above: +At GitHub, we've used a version of [Heaven][heaven] to manage +our deployments for years. A common flow is essentially the same as the +server we've built above: * Wait for a response on the state of the CI checks (success or failure) * If the required checks succeed, merge the pull request * Heaven takes the merged code, and deploys it to staging and production servers -* その間にHeavenは、当社のチャットルームに居座っている[Hubot][hubot]を通じて全員にビルドについて通知する +* In the meantime, Heaven also notifies everyone about the build, via [Hubot][hubot] sitting in our chat rooms -これで完了です。 この例を使用するために、独自のデプロイメントを構築する必要はありません。 いつでも[GitHubインテグレーション][integrations]に頼ることができます。 +That's it! You don't need to build your own deployment setup to use this example. +You can always rely on [GitHub integrations][integrations]. [deploy API]: /rest/reference/repos#deployments [status API]: /guides/building-a-ci-server @@ -154,6 +193,11 @@ GitHubでは長年、デプロイメントを管理するため[Heaven][heaven] [using ngrok]: /webhooks/configuring/#using-ngrok [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/delivering-deployments [Sinatra]: http://www.sinatrarb.com/ +[webhook]: /webhooks/ +[octokit.rb]: https://github.com/octokit/octokit.rb +[access token]: /articles/creating-an-access-token-for-command-line-use +[travis api]: https://api.travis-ci.org/docs/ +[janky]: https://github.com/github/janky [heaven]: https://github.com/atmos/heaven [hubot]: https://github.com/github/hubot [integrations]: https://github.com/integrations diff --git a/translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md b/translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md index 74f1211882..11f6410042 100644 --- a/translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md +++ b/translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md @@ -2,7 +2,7 @@ title: Discovering resources for a user intro: Learn how to find the repositories and organizations that your app can access for a user in a reliable way for your authenticated requests to the REST API. redirect_from: - - /guides/discovering-resources-for-a-user/ + - /guides/discovering-resources-for-a-user - /v3/guides/discovering-resources-for-a-user versions: fpt: '*' diff --git a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md index 86d5220126..4e6053352c 100644 --- a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md @@ -2,7 +2,7 @@ title: Getting started with the REST API intro: 'Learn the foundations for using the REST API, starting with authentication and some endpoint examples.' redirect_from: - - /guides/getting-started/ + - /guides/getting-started - /v3/guides/getting-started versions: fpt: '*' diff --git a/translations/ja-JP/content/rest/guides/rendering-data-as-graphs.md b/translations/ja-JP/content/rest/guides/rendering-data-as-graphs.md index 170b2c0344..a46becae06 100644 --- a/translations/ja-JP/content/rest/guides/rendering-data-as-graphs.md +++ b/translations/ja-JP/content/rest/guides/rendering-data-as-graphs.md @@ -1,8 +1,8 @@ --- -title: データをグラフとしてレンダリングする -intro: D3.jsライブラリとRuby Octokitを使用して、リポジトリからプログラミング言語を視覚化する方法を学びましょう。 +title: Rendering data as graphs +intro: Learn how to visualize the programming languages from your repository using the D3.js library and Ruby Octokit. redirect_from: - - /guides/rendering-data-as-graphs/ + - /guides/rendering-data-as-graphs - /v3/guides/rendering-data-as-graphs versions: fpt: '*' @@ -15,15 +15,21 @@ topics: -このガイドでは、APIを使用して、所有するリポジトリと、それを構成するプログラミング言語についての情報を取得します。 次に、[D3.js][D3.js]ライブラリを使用して、その情報をいくつかの方法で視覚化します。 To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using the excellent Ruby library, [Octokit][Octokit]. +In this guide, we're going to use the API to fetch information about repositories +that we own, and the programming languages that make them up. Then, we'll +visualize that information in a couple of different ways using the [D3.js][D3.js] library. To +interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using the excellent Ruby library, [Octokit][Octokit]. -まだ[「認証の基本」][basics-of-authentication]ガイドを読んでいない場合は、それを読んでからこの例に取りかかってください。 このプロジェクトの完全なソースコードは、[platform-samples][platform samples]リポジトリにあります。 +If you haven't already, you should read the ["Basics of Authentication"][basics-of-authentication] +guide before starting this example. You can find the complete source code for this project in the [platform-samples][platform samples] repository. -それでは早速始めましょう！ +Let's jump right in! -## OAuthアプリケーションの設定 +## Setting up an OAuth application -まず、{% data variables.product.product_name %}で[新しいアプリケーションを登録][new oauth application]します。 コールバックURLは`http://localhost:4567/`と設定してください。 [以前][basics-of-authentication]行ったように、[sinatra-auth-github][sinatra auth github]を使用してRackミドルウェアを実装することにより、APIの認証を処理します。 +First, [register a new application][new oauth application] on {% data variables.product.product_name %}. Set the main and callback +URLs to `http://localhost:4567/`. As [before][basics-of-authentication], we're going to handle authentication for the API by +implementing a Rack middleware using [sinatra-auth-github][sinatra auth github]: ``` ruby require 'sinatra/auth/github' @@ -62,7 +68,7 @@ module Example end ``` -前の例と同様に、_config.ru_ファイルを設定します。 +Set up a similar _config.ru_ file as in the previous example: ``` ruby ENV['RACK_ENV'] ||= 'development' @@ -74,11 +80,15 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'server')) run Example::MyGraphApp ``` -## リポジトリ情報のフェッチ +## Fetching repository information -This time, in order to talk to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we're going to use the [Octokit Ruby library][Octokit]. これは、多くのREST呼び出しを直接行うよりもはるかに簡単です。 さらに、OctokitはGitHubberによって開発され、積極的にメンテナンスされているので、確実に動作します。 +This time, in order to talk to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we're going to use the [Octokit +Ruby library][Octokit]. This is much easier than directly making a bunch of +REST calls. Plus, Octokit was developed by a GitHubber, and is actively maintained, +so you know it'll work. -Octokit経由のAPIによる認証は簡単です。 ログインとトークンを`Octokit::Client`コンストラクタに渡すだけです。 +Authentication with the API via Octokit is easy. Just pass your login +and token to the `Octokit::Client` constructor: ``` ruby if !authenticated? @@ -88,13 +98,17 @@ else end ``` -リポジトリに関するデータを使って面白いことをしてみましょう。 使用されているさまざまなプログラミング言語を表示し、どれが一番多く使われているかを数えます。 そのためには、まずAPIからリポジトリのリストを取得する必要があります。 Octokitでは、次のようにします。 +Let's do something interesting with the data about our repositories. We're going +to see the different programming languages they use, and count which ones are used +most often. To do that, we'll first need a list of our repositories from the API. +With Octokit, that looks like this: ``` ruby repos = client.repositories ``` -次に、各レポジトリで処理を繰り返し、{% data variables.product.product_name %}に関連付けられた言語を数えます。 +Next, we'll iterate over each repository, and count the language that {% data variables.product.product_name %} +associates with it: ``` ruby language_obj = {} @@ -112,19 +126,25 @@ end languages.to_s ``` -サーバーを再起動すると、ウェブページには以下のように表示されているはずです。 +When you restart your server, your web page should display something +that looks like this: ``` ruby {"JavaScript"=>13, "PHP"=>1, "Perl"=>1, "CoffeeScript"=>2, "Python"=>1, "Java"=>3, "Ruby"=>3, "Go"=>1, "C++"=>1} ``` -ここまではうまくいきましたが、ちょっと取っつきにくいですね。 これらの言語数がどのような分布をしているかを把握するには、視覚化がとても役立つでしょう。 数えたものをD3にフィードし、使用する言語の人気を表す棒グラフを取得しましょう。 +So far, so good, but not very human-friendly. A visualization +would be great in helping us understand how these language counts are distributed. Let's feed +our counts into D3 to get a neat bar graph representing the popularity of the languages we use. -## 言語数の視覚化 +## Visualizing language counts -D3.js (単にD3と表記することもある) は、多様なチャート、グラフ、インタラクティブな視覚化を作成するための包括的なライブラリです。 D3の詳細はこのガイドが扱う範囲を超えていますが、いい入門記事としては、[「D3 for Mortals」][D3 mortals]をご覧ください。 +D3.js, or just D3, is a comprehensive library for creating many kinds of charts, graphs, and interactive visualizations. +Using D3 in detail is beyond the scope of this guide, but for a good introductory article, +check out ["D3 for Mortals"][D3 mortals]. -D3はJavaScriptのライブラリで、データを配列として扱うことを好みます。 ですから、ブラウザのJavaScriptで使用するため、RubyのハッシュをJSON配列に変換してみましょう。 +D3 is a JavaScript library, and likes working with data as arrays. So, let's convert our Ruby hash into +a JSON array for use by JavaScript in the browser. ``` ruby languages = [] @@ -135,9 +155,13 @@ end erb :lang_freq, :locals => { :languages => languages.to_json} ``` -ここでは単純にオブジェクトの各キー/値ペアを次々と処理して、新しい配列に入れ込んでいます。 これをもっと前に行わなかったのは、`language_obj`オブジェクトを作成しながら次々と処理していきたくはなかったからです。 +We're simply iterating over each key-value pair in our object and pushing them into +a new array. The reason we didn't do this earlier is because we didn't want to iterate +over our `language_obj` object while we were creating it. -さて、棒グラフのレンダリングをサポートするため、_lang_freq.erb_には何らかのJavaScriptが必要となります。 さしあたっては、ここで提供しているコードを使うことにしましょう。D3のしくみについて詳しく学びたければ、上記でリンクした資料を参照してください。 +Now, _lang_freq.erb_ is going to need some JavaScript to support rendering a bar graph. +For now, you can just use the code provided here, and refer to the resources linked above +if you want to learn more about how D3 works: ``` html @@ -218,15 +242,26 @@ erb :lang_freq, :locals => { :languages => languages.to_json} ``` -いかがですか。 このコードが何をしているか詳しく知る必要はありません。 ここで注目してほしいのは、てっぺんの行の`var data = <%= languages %>;`の部分です。これは、以前に作成した`languages`の行列を、操作のためERBに渡すことを示しています。 +Phew! Again, don't worry about what most of this code is doing. The relevant part +here is a line way at the top--`var data = <%= languages %>;`--which indicates +that we're passing our previously created `languages` array into ERB for manipulation. -「D3 for Mortals」のガイドが示すように、これは必ずしもD3の最善の利用法ではありません。 ただ、Octokitと一緒にライブラリを使って、とっても素晴らしいものを作る方法を説明するには役立ちます。 +As the "D3 for Mortals" guide suggests, this isn't necessarily the best use of +D3. But it does serve to illustrate how you can use the library, along with Octokit, +to make some really amazing things. -## さまざまなAPI呼び出しの組み合わせ +## Combining different API calls -さて、ここで本当のことを言いましょう。リポジトリの`language`属性が識別するのは、「主な」言語として定義されたものだけです。 つまり、複数の言語が混ざったリポジトリでは、コードのバイト数が最も多い言語が主言語とみなされます。 +Now it's time for a confession: the `language` attribute within repositories +only identifies the "primary" language defined. That means that if you have +a repository that combines several languages, the one with the most bytes of code +is considered to be the primary language. -いくつかのAPI呼び出しを組み合わせて、コード全体でどの言語のバイト数が最も多いかを_厳密に_表してみましょう。 コーディングに使われている言語のサイズを視覚化する方法としては、単純な数よりも[ツリーマップ][D3 treemap]を使った方が見栄えがいいでしょう。 次のようなオブジェクトの配列を構築する必要があります。 +Let's combine a few API calls to get a _true_ representation of which language +has the greatest number of bytes written across all our code. A [treemap][D3 treemap] +should be a great way to visualize the sizes of our coding languages used, rather +than simply the count. We'll need to construct an array of objects that looks +something like this: ``` json [ { "name": "language1", "size": 100}, @@ -235,7 +270,8 @@ erb :lang_freq, :locals => { :languages => languages.to_json} ] ``` -すでに上記でリポジトリのリストを取得しているので、それぞれを調べて、[言語をリスト化するAPIメソッド][language API]を呼び出しましょう。 +Since we already have a list of repositories above, let's inspect each one, and +call [the language listing API method][language API]: ``` ruby repos.each do |repo| @@ -244,7 +280,7 @@ repos.each do |repo| end ``` -そこから、見つかった各言語を言語のリストに次々に追加していきます。 +From there, we'll cumulatively add each language found to a list of languages: ``` ruby repo_langs.each do |lang, count| @@ -256,7 +292,7 @@ repo_langs.each do |lang, count| end ``` -それから、コンテンツをD3が理解できる構造にフォーマットします。 +After that, we'll format the contents into a structure that D3 understands: ``` ruby language_obj.each do |lang, count| @@ -267,15 +303,16 @@ end language_bytes = [ :name => "language_bytes", :elements => language_byte_count] ``` -(D3ツリーマップの魔力をもっと詳しく知りたければ、[この簡単なチュートリアル][language API]を確認しましょう。) +(For more information on D3 tree map magic, check out [this simple tutorial][language API].) -仕上げに、このJSON情報を同じERBテンプレートに渡します。 +To wrap up, we pass this JSON information over to the same ERB template: ``` ruby erb :lang_freq, :locals => { :languages => languages.to_json, :language_byte_count => language_bytes.to_json} ``` -前と同じように、テンプレートに直接放り込めるJavaScriptをご用意しました。 +Like before, here's a bunch of JavaScript that you can drop +directly into your template: ``` html
@@ -325,18 +362,19 @@ erb :lang_freq, :locals => { :languages => languages.to_json, :language_byte_cou ``` -これで一丁あがり! リポジトリの言語が書かれた美しい長方形です。大きさは言語の割合に比例していて、一目でわかりやすくなっています。 すべての情報を正しく表示するためには、上記`drawTreemap`の最初の2つの引数で、ツーマップの縦と横を調整する必要があるかもしれません。 +Et voila! Beautiful rectangles containing your repo languages, with relative +proportions that are easy to see at a glance. You might need to +tweak the height and width of your treemap, passed as the first two +arguments to `drawTreemap` above, to get all the information to show up properly. [D3.js]: http://d3js.org/ [basics-of-authentication]: /rest/guides/basics-of-authentication -[basics-of-authentication]: /rest/guides/basics-of-authentication [sinatra auth github]: https://github.com/atmos/sinatra_auth_github [Octokit]: https://github.com/octokit/octokit.rb -[Octokit]: https://github.com/octokit/octokit.rb [D3 mortals]: http://www.recursion.org/d3-for-mere-mortals/ -[D3 treemap]: https://www.d3-graph-gallery.com/treemap.html -[language API]: /rest/reference/repos#list-repository-languages +[D3 treemap]: https://www.d3-graph-gallery.com/treemap.html [language API]: /rest/reference/repos#list-repository-languages +[simple tree map]: http://2kittymafiasoftware.blogspot.com/2011/09/simple-treemap-visualization-with-d3.html [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/rendering-data-as-graphs [new oauth application]: https://github.com/settings/applications/new diff --git a/translations/ja-JP/content/rest/guides/traversing-with-pagination.md b/translations/ja-JP/content/rest/guides/traversing-with-pagination.md index 36400d1399..4b13c46e3d 100644 --- a/translations/ja-JP/content/rest/guides/traversing-with-pagination.md +++ b/translations/ja-JP/content/rest/guides/traversing-with-pagination.md @@ -2,7 +2,7 @@ title: Traversing with pagination intro: Explore how to use pagination to manage your responses with some examples using the Search API. redirect_from: - - /guides/traversing-with-pagination/ + - /guides/traversing-with-pagination - /v3/guides/traversing-with-pagination versions: fpt: '*' diff --git a/translations/ja-JP/content/rest/guides/working-with-comments.md b/translations/ja-JP/content/rest/guides/working-with-comments.md index 371054556f..3b5736faea 100644 --- a/translations/ja-JP/content/rest/guides/working-with-comments.md +++ b/translations/ja-JP/content/rest/guides/working-with-comments.md @@ -2,7 +2,7 @@ title: Working with comments intro: 'Using the REST API, you can access and manage comments in your pull requests, issues, or commits.' redirect_from: - - /guides/working-with-comments/ + - /guides/working-with-comments - /v3/guides/working-with-comments versions: fpt: '*' diff --git a/translations/ja-JP/content/rest/overview/libraries.md b/translations/ja-JP/content/rest/overview/libraries.md index 5f0993daf7..0128487f72 100644 --- a/translations/ja-JP/content/rest/overview/libraries.md +++ b/translations/ja-JP/content/rest/overview/libraries.md @@ -1,8 +1,8 @@ --- -title: ライブラリ +title: Libraries intro: 'You can use the official Octokit library and other third-party libraries to extend and simplify how you use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API.' redirect_from: - - /libraries/ + - /libraries - /v3/libraries versions: fpt: '*' @@ -15,8 +15,8 @@ topics:
The Gundamcat -

Octokit にはいくつかの種類があります

-

公式の Octokit ライブラリを使用するか、利用可能なサードパーティライブラリのいずれかを選択します。

+

Octokit comes in many flavors

+

Use the official Octokit library, or choose between any of the available third party libraries.


Ruby → octokit.rb

.NET → octokit.net

@@ -24,130 +24,130 @@ topics:
-# サードパーティライブラリ +# Third-party libraries ### Clojure -| ライブラリ名 | リポジトリ | -| ------------- | ------------------------------------------------------- | -| **Tentacles** | [Raynes/tentacles](https://github.com/Raynes/tentacles) | +| Library name | Repository | +|---|---| +|**Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles)| ### Dart -| ライブラリ名 | リポジトリ | -| --------------- | ----------------------------------------------------------------------- | -| **github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart) | +| Library name | Repository | +|---|---| +|**github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart)| ### Emacs Lisp -| ライブラリ名 | リポジトリ | -| --------- | --------------------------------------------- | -| **gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el) | +| Library name | Repository | +|---|---| +|**gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el)| ### Erlang -| ライブラリ名 | リポジトリ | -| ------------ | ------------------------------------------------------- | -| **octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl) | +| Library name | Repository | +|---|---| +|**octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl)| ### Go -| ライブラリ名 | リポジトリ | -| ------------- | ------------------------------------------------------- | -| **go-github** | [google/go-github](https://github.com/google/go-github) | +| Library name | Repository | +|---|---| +|**go-github**| [google/go-github](https://github.com/google/go-github)| ### Haskell -| ライブラリ名 | リポジトリ | -| ------------------ | --------------------------------------------- | -| **haskell-github** | [fpco/Github](https://github.com/fpco/GitHub) | +| Library name | Repository | +|---|---| +|**haskell-github** | [fpco/Github](https://github.com/fpco/GitHub)| ### Java -| ライブラリ名 | リポジトリ | 詳細情報 | -| ----------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------ | -| **GitHub API for Java** | [org.kohsuke.github (github-apiより)](http://github-api.kohsuke.org/) | GitHub APIのオブジェクト指向の表現を定義。 | -| **JCabi GitHub API** | [github.jcabi.com (個人Webサイト)](http://github.jcabi.com) | Java7 JSON API (JSR-353)に基づき、ランタイムのGitHubスタブでテストをシンプルにし、API全体をカバー。 | +| Library name | Repository | More information | +|---|---|---| +|**GitHub API for Java**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)|defines an object oriented representation of the GitHub API.| +|**JCabi GitHub API**|[github.jcabi.com (Personal Website)](http://github.jcabi.com)|is based on Java7 JSON API (JSR-353), simplifies tests with a runtime GitHub stub, and covers the entire API.| ### JavaScript -| ライブラリ名 | リポジトリ | -| ---------------------------------------------------------------- | ----------------------------------------------------------------------- | -| **NodeJS GitHub library** | [pksunkara/octonode](https://github.com/pksunkara/octonode) | -| **gh3 client-side API v3 wrapper** | [k33g/gh3](https://github.com/k33g/gh3) | -| **Github.js wrapper around the GitHub API** | [michael/github](https://github.com/michael/github) | -| **Promise-Based CoffeeScript library for the Browser or NodeJS** | [philschatz/github-client](https://github.com/philschatz/github-client) | +| Library name | Repository | +|---|---| +|**NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode)| +|**gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3)| +|**Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github)| +|**Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client)| ### Julia -| ライブラリ名 | リポジトリ | -| ------------- | ----------------------------------------------------------- | -| **GitHub.jl** | [JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl) | +| Library name | Repository | +|---|---| +|**GitHub.jl**|[JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl)| ### OCaml -| ライブラリ名 | リポジトリ | -| ---------------- | ------------------------------------------------------------- | -| **ocaml-github** | [mirage/ocaml-github](https://github.com/mirage/ocaml-github) | +| Library name | Repository | +|---|---| +|**ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github)| ### Perl -| ライブラリ名 | リポジトリ | ライブラリのmetacpan Webサイト | -| --------------- | --------------------------------------------------------------------- | ------------------------------------------------------- | -| **Pithub** | [plu/Pithub](https://github.com/plu/Pithub) | [Pithub CPAN](http://metacpan.org/module/Pithub) | -| **Net::GitHub** | [fayland/perl-net-github](https://github.com/fayland/perl-net-github) | [Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub) | +| Library name | Repository | metacpan Website for the Library | +|---|---|---| +|**Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub)| +|**Net::GitHub**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:GitHub CPAN](https://metacpan.org/pod/Net::GitHub)| ### PHP -| ライブラリ名 | リポジトリ | -| ----------------------------- | --------------------------------------------------------------------------------- | -| **PHP GitHub API** | [KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) | -| **GitHub Joomla! Package** | [joomla-framework/github-api](https://github.com/joomla-framework/github-api) | -| **GitHub bridge for Laravel** | [GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) | +| Library name | Repository | +|---|---| +|**PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api)| +|**GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api)| +|**GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub)| ### PowerShell -| ライブラリ名 | リポジトリ | -| ----------------------- | --------------------------------------------------------------------------------- | -| **PowerShellForGitHub** | [microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub) | +| Library name | Repository | +|---|---| +|**PowerShellForGitHub**|[microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub)| ### Python -| ライブラリ名 | リポジトリ | -| ---------------- | --------------------------------------------------------------------- | -| **gidgethub** | [brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) | -| **ghapi** | [fastai/ghapi](https://github.com/fastai/ghapi) | -| **PyGithub** | [PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) | -| **libsaas** | [duckboard/libsaas](https://github.com/ducksboard/libsaas) | -| **github3.py** | [sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) | -| **sanction** | [demianbrecht/sanction](https://github.com/demianbrecht/sanction) | -| **agithub** | [jpaugh/agithub](https://github.com/jpaugh/agithub) | -| **octohub** | [turnkeylinux/octohub](https://github.com/turnkeylinux/octohub) | -| **github-flask** | [github-flask (公式Webサイト)](http://github-flask.readthedocs.org) | -| **torngithub** | [jkeylu/torngithub](https://github.com/jkeylu/torngithub) | +| Library name | Repository | +|---|---| +|**gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub)| +|**ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi)| +|**PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub)| +|**libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas)| +|**github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py)| +|**sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction)| +|**agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub)| +|**octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub)| +|**github-flask**|[github-flask (Official Website)](http://github-flask.readthedocs.org)| +|**torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub)| ### Ruby -| ライブラリ名 | リポジトリ | -| ------------------ | ------------------------------------------------------------- | -| **GitHub API Gem** | [peter-murach/github](https://github.com/peter-murach/github) | -| **Ghee** | [rauhryan/ghee](https://github.com/rauhryan/ghee) | +| Library name | Repository | +|---|---| +|**GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github)| +|**Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee)| ### Rust -| ライブラリ名 | リポジトリ | -| ------------ | ------------------------------------------------------------- | -| **Octocrab** | [XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) | +| Library name | Repository | +|---|---| +|**Octocrab**|[XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab)| ### Scala -| ライブラリ名 | リポジトリ | -| ------------ | ------------------------------------------------------- | -| **Hubcat** | [softprops/hubcat](https://github.com/softprops/hubcat) | -| **Github4s** | [47deg/github4s](https://github.com/47deg/github4s) | +| Library name | Repository | +|---|---| +|**Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat)| +|**Github4s**|[47deg/github4s](https://github.com/47deg/github4s)| ### Shell -| ライブラリ名 | リポジトリ | -| --------- | ----------------------------------------------------- | -| **ok.sh** | [whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) | +| Library name | Repository | +|---|---| +|**ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh)| diff --git a/translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md b/translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md index 076a79a6c0..49c8175768 100644 --- a/translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md +++ b/translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md @@ -1,8 +1,8 @@ --- -title: REST API のリソース +title: Resources in the REST API intro: 'Learn how to navigate the resources provided by the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API.' redirect_from: - - /rest/initialize-the-repo/ + - /rest/initialize-the-repo versions: fpt: '*' ghes: '*' @@ -13,11 +13,12 @@ topics: --- -公式の {% data variables.product.product_name %} REST API を構成するリソースについて説明しています。 ご不明な点やご要望がございましたら、{% data variables.contact.contact_support %} までご連絡ください。 +This describes the resources that make up the official {% data variables.product.product_name %} REST API. If you have any problems or requests, please contact {% data variables.contact.contact_support %}. -## 最新バージョン +## Current version -デフォルトでは、`{% data variables.product.api_url_code %}` へのすべてのリクエストが REST API の **v3** [バージョン](/developers/overview/about-githubs-apis)を受け取ります。 [`Accept` ヘッダを介してこのバージョンを明示的にリクエストする](/rest/overview/media-types#request-specific-version)ことをお勧めします。 +By default, all requests to `{% data variables.product.api_url_code %}` receive the **v3** [version](/developers/overview/about-githubs-apis) of the REST API. +We encourage you to [explicitly request this version via the `Accept` header](/rest/overview/media-types#request-specific-version). Accept: application/vnd.github.v3+json @@ -27,10 +28,10 @@ For information about GitHub's GraphQL API, see the [v4 documentation]({% ifvers {% endif %} -## スキーマ +## Schema -{% ifversion fpt or ghec %}All API access is over HTTPS, and{% else %}The API is{% endif %} accessed from `{% data variables.product.api_url_code %}`. すべてのデータは -JSON として送受信されます。 +{% ifversion fpt or ghec %}All API access is over HTTPS, and{% else %}The API is{% endif %} accessed from `{% data variables.product.api_url_code %}`. All data is +sent and received as JSON. ```shell $ curl -I {% data variables.product.api_url_pre %}/users/octocat/orgs @@ -51,43 +52,55 @@ $ curl -I {% data variables.product.api_url_pre %}/users/octocat/orgs > X-Content-Type-Options: nosniff ``` -空白のフィールドは、省略されるのではなく `null` として含まれます。 +Blank fields are included as `null` instead of being omitted. All timestamps return in UTC time, ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ -タイムスタンプのタイムゾーンの詳細については、[このセクション](#timezones)を参照してください。 +For more information about timezones in timestamps, see [this section](#timezones). -### 要約表現 +### Summary representations -リソースのリストをフェッチすると、レスポンスにはそのリソースの属性の_サブセット_が含まれます。 これは、リソースの「要約」表現です。 （一部の属性では、API が提供する計算コストが高くなります。 パフォーマンス上の理由から、要約表現はそれらの属性を除外します。 これらの属性を取得するには、「詳細な」表現をフェッチします。） +When you fetch a list of resources, the response includes a _subset_ of the +attributes for that resource. This is the "summary" representation of the +resource. (Some attributes are computationally expensive for the API to provide. +For performance reasons, the summary representation excludes those attributes. +To obtain those attributes, fetch the "detailed" representation.) -**例**: リポジトリのリストを取得すると、各リポジトリの要約表現が表示されます。 ここでは、[octokit](https://github.com/octokit) Organization が所有するリポジトリのリストを取得します。 +**Example**: When you get a list of repositories, you get the summary +representation of each repository. Here, we fetch the list of repositories owned +by the [octokit](https://github.com/octokit) organization: GET /orgs/octokit/repos -### 詳細な表現 +### Detailed representations -個々のリソースをフェッチすると、通常、レスポンスにはそのリソースの_すべて_の属性が含まれます。 これは、リソースの「詳細」表現です。 （承認によって、表現に含まれる詳細の内容に影響する場合があることにご注意ください。） +When you fetch an individual resource, the response typically includes _all_ +attributes for that resource. This is the "detailed" representation of the +resource. (Note that authorization sometimes influences the amount of detail +included in the representation.) -**例**: 個別のリポジトリを取得すると、リポジトリの詳細な表現が表示されます。 ここでは、[octokit/octokit.rb](https://github.com/octokit/octokit.rb) リポジトリをフェッチします。 +**Example**: When you get an individual repository, you get the detailed +representation of the repository. Here, we fetch the +[octokit/octokit.rb](https://github.com/octokit/octokit.rb) repository: GET /repos/octokit/octokit.rb -ドキュメントには、各 API メソッドのレスポンス例が記載されています。 レスポンス例は、そのメソッドによって返されるすべての属性を示しています。 +The documentation provides an example response for each API method. The example +response illustrates all attributes that are returned by that method. -## 認証 +## Authentication -{% ifversion ghae %} {% data variables.product.product_name %} REST API への認証には、[Webアプリケーションフロー](/developers/apps/authorizing-oauth-apps#web-application-flow)で OAuth2 トークンを作成することをお勧めします。 {% else %}{% data variables.product.product_name %} REST API を使用して認証する方法は 2 つあります。{% endif %} 認証を必要とするリクエストは、場所によって `403 Forbidden` ではなく `404 Not Found` を返します。 これは、許可されていないユーザにプライベートリポジトリが誤って漏洩するのを防ぐためです。 +{% ifversion ghae %} We recommend authenticating to the {% data variables.product.product_name %} REST API by creating an OAuth2 token through the [web application flow](/developers/apps/authorizing-oauth-apps#web-application-flow). {% else %} There are two ways to authenticate through {% data variables.product.product_name %} REST API.{% endif %} Requests that require authentication will return `404 Not Found`, instead of `403 Forbidden`, in some places. This is to prevent the accidental leakage of private repositories to unauthorized users. -### Basic 認証 +### Basic authentication ```shell $ curl -u "username" {% data variables.product.api_url_pre %} ``` -### OAuth2 トークン（ヘッダに送信） +### OAuth2 token (sent in a header) ```shell $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %} @@ -95,14 +108,14 @@ $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product. {% note %} -注: GitHub では、Authorization ヘッダを使用して OAuth トークンを送信することをお勧めしています。 +Note: GitHub recommends sending OAuth tokens using the Authorization header. {% endnote %} -[OAuth2 の詳細](/apps/building-oauth-apps/)をお読みください。 OAuth2 トークンは、本番アプリケーションの [Web アプリケーションフロー](/developers/apps/authorizing-oauth-apps#web-application-flow)で取得できることに注意してください。 +Read [more about OAuth2](/apps/building-oauth-apps/). Note that OAuth2 tokens can be acquired using the [web application flow](/developers/apps/authorizing-oauth-apps#web-application-flow) for production applications. {% ifversion fpt or ghes or ghec %} -### OAuth2 キー/シークレット +### OAuth2 key/secret {% data reusables.apps.deprecating_auth_with_query_parameters %} @@ -110,22 +123,22 @@ $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product. curl -u my_client_id:my_client_secret '{% data variables.product.api_url_pre %}/user/repos' ``` -`client_id` と `client_secret` を使用してもユーザとして認証_されず_、OAuth アプリケーションを識別してレート制限を増やすだけです。 アクセス許可はユーザにのみ付与され、アプリケーションには付与されません。また、認証されていないユーザに表示されるデータのみが返されます。 このため、サーバー間のシナリオでのみ OAuth2 キー/シークレットを使用する必要があります。 OAuth アプリケーションのクライアントシークレットをユーザーに漏らさないようにしてください。 +Using your `client_id` and `client_secret` does _not_ authenticate as a user, it will only identify your OAuth application to increase your rate limit. Permissions are only granted to users, not applications, and you will only get back data that an unauthenticated user would see. For this reason, you should only use the OAuth2 key/secret in server-to-server scenarios. Don't leak your OAuth application's client secret to your users. {% ifversion ghes %} -プライベートモードでは、OAuth2 キーとシークレットを使用して認証することはできません。認証しようとすると `401 Unauthorized` が返されます。 For more information, see "[Enabling private mode](/admin/configuration/configuring-your-enterprise/enabling-private-mode)". +You will be unable to authenticate using your OAuth2 key and secret while in private mode, and trying to authenticate will return `401 Unauthorized`. For more information, see "[Enabling private mode](/admin/configuration/configuring-your-enterprise/enabling-private-mode)". {% endif %} {% endif %} {% ifversion fpt or ghec %} -[認証されていないレート制限の詳細](#increasing-the-unauthenticated-rate-limit-for-oauth-applications)をお読みください。 +Read [more about unauthenticated rate limiting](#increasing-the-unauthenticated-rate-limit-for-oauth-applications). {% endif %} -### ログイン失敗の制限 +### Failed login limit -無効な認証情報で認証すると、`401 Unauthorized` が返されます。 +Authenticating with invalid credentials will return `401 Unauthorized`: ```shell $ curl -I {% data variables.product.api_url_pre %} -u foo:bar @@ -137,7 +150,9 @@ $ curl -I {% data variables.product.api_url_pre %} -u foo:bar > } ``` -API は、無効な認証情報を含むリクエストを短期間に複数回検出すると、`403 Forbidden` で、そのユーザに対するすべての認証試行（有効な認証情報を含む）を一時的に拒否します。 +After detecting several requests with invalid credentials within a short period, +the API will temporarily reject all authentication attempts for that user +(including ones with valid credentials) with `403 Forbidden`: ```shell $ curl -i {% data variables.product.api_url_pre %} -u {% ifversion fpt or ghae or ghec %} @@ -149,58 +164,66 @@ $ curl -i {% data variables.product.api_url_pre %} -u {% ifversion fpt or ghae o > } ``` -## パラメータ +## Parameters -多くの API メソッドはオプションのパラメータを選択しています。 `GET` リクエストでは、パスのセグメントとして指定されていないパラメータは、HTTP クエリ文字列型パラメータとして渡すことができます。 +Many API methods take optional parameters. For `GET` requests, any parameters not +specified as a segment in the path can be passed as an HTTP query string +parameter: ```shell $ curl -i "{% data variables.product.api_url_pre %}/repos/vmg/redcarpet/issues?state=closed" ``` -この例では、パスの `:owner` と `:repo` パラメータに「vmg」と「redcarpet」の値が指定され、クエリ文字列型で `:state` が渡されます。 +In this example, the 'vmg' and 'redcarpet' values are provided for the `:owner` +and `:repo` parameters in the path while `:state` is passed in the query +string. -`POST`、`PATCH`、`PUT`、および `DELETE` リクエストでは、URL に含まれていないパラメータは、Content-Type が「application/json」の JSON としてエンコードする必要があります。 +For `POST`, `PATCH`, `PUT`, and `DELETE` requests, parameters not included in the URL should be encoded as JSON +with a Content-Type of 'application/json': ```shell $ curl -i -u username -d '{"scopes":["repo_deployment"]}' {% data variables.product.api_url_pre %}/authorizations ``` -## ルートエンドポイント +## Root endpoint -ルートエンドポイントに `GET` リクエストを発行して、REST API がサポートするすべてのエンドポイントカテゴリを取得できます。 +You can issue a `GET` request to the root endpoint to get all the endpoint categories that the REST API supports: ```shell $ curl {% ifversion fpt or ghae or ghec %} -u username:token {% endif %}{% ifversion ghes %}-u username:password {% endif %}{% data variables.product.api_url_pre %} ``` -## GraphQL グローバルノード ID +## GraphQL global node IDs See the guide on "[Using Global Node IDs]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids)" for detailed information about how to find `node_id`s via the REST API and use them in GraphQL operations. -## クライアントエラー +## Client errors -リクエストの本文を受信する API 呼び出しのクライアントエラーには、次の 3 つのタイプがあります。 +There are three possible types of client errors on API calls that +receive request bodies: + +1. Sending invalid JSON will result in a `400 Bad Request` response. -1. 無効なJSONを送信すると、`400 Bad Request` レスポンスが返されます。 - HTTP/2 400 Content-Length: 35 - + {"message":"Problems parsing JSON"} -2. 間違ったタイプの JSON 値を送信すると、`400 Bad Request` レスポンスが返されます。 - +2. Sending the wrong type of JSON values will result in a `400 Bad + Request` response. + HTTP/2 400 Content-Length: 40 - + {"message":"Body should be a JSON object"} -3. 無効なフィールドを送信すると、`422 Unprocessable Entity` レスポンスが返されます。 - +3. Sending invalid fields will result in a `422 Unprocessable Entity` + response. + HTTP/2 422 Content-Length: 149 - + { "message": "Validation Failed", "errors": [ @@ -212,121 +235,144 @@ See the guide on "[Using Global Node IDs]({% ifversion ghec%}/free-pro-team@late ] } -すべてのエラーオブジェクトにはリソースとフィールドのプロパティがあるため、クライアントは問題の内容を認識することができます。 また、フィールドの問題点を知らせるエラーコードもあります。 発生する可能性のある検証エラーコードは次のとおりです。 +All error objects have resource and field properties so that your client +can tell what the problem is. There's also an error code to let you +know what is wrong with the field. These are the possible validation error +codes: -| エラーコード名 | 説明 | -| ---------------- | ------------------------------------------------------------------ | -| `missing` | リソースが存在しません。 | -| `missing_field` | リソースの必須フィールドが設定されていません。 | -| `invalid` | フィールドのフォーマットが無効です。 詳細については、ドキュメントを参照してください。 | -| `already_exists` | 別のリソースに、このフィールドと同じ値があります。 これは、一意のキー（ラベル名など）が必要なリソースで発生する可能性があります。 | -| `unprocessable` | 入力が無効です。 | +Error code name | Description +-----------|-----------| +`missing` | A resource does not exist. +`missing_field` | A required field on a resource has not been set. +`invalid` | The formatting of a field is invalid. Review the documentation for more specific information. +`already_exists` | Another resource has the same value as this field. This can happen in resources that must have some unique key (such as label names). +`unprocessable` | The inputs provided were invalid. -リソースはカスタム検証エラー（`code` が `custom`）を送信する場合もあります。 カスタムエラーには常にエラーを説明する `message` フィールドがあり、ほとんどのエラーには、エラーの解決に役立つ可能性があるコンテンツを指す `documentation_url` フィールドも含まれます。 +Resources may also send custom validation errors (where `code` is `custom`). Custom errors will always have a `message` field describing the error, and most errors will also include a `documentation_url` field pointing to some content that might help you resolve the error. -## HTTP リダイレクト +## HTTP redirects -API v3 は、必要に応じて HTTP リダイレクトを使用します。 クライアントは、リクエストがリダイレクトされる可能性があることを想定する必要があります。 HTTP リダイレクトの受信はエラー*ではなく*、クライアントはそのリダイレクトに従う必要があります。 リダイレクトのレスポンスには、クライアントがリクエストを繰り返す必要があるリソースの URI を含む `Location` ヘッダフィールドがあります。 +API v3 uses HTTP redirection where appropriate. Clients should assume that any +request may result in a redirection. Receiving an HTTP redirection is *not* an +error and clients should follow that redirect. Redirect responses will have a +`Location` header field which contains the URI of the resource to which the +client should repeat the requests. -| ステータスコード | 説明 | -| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `301` | Permanent redirection（恒久的なリダイレクト）。 リクエストに使用した URI は、`Location`ヘッダフィールドで指定されたものに置き換えられています。 このリソースに対する今後のすべてのリクエストは、新しい URI に送信する必要があります。 | -| `302`、`307` | Temporary redirection（一時的なリダイレクト）。 リクエストは、`Location` ヘッダフィールドで指定された URI に逐語的に繰り返される必要がありますが、クライアントは今後のリクエストで元の URI を引き続き使用する必要があります。 | +Status Code | Description +-----------|-----------| +`301` | Permanent redirection. The URI you used to make the request has been superseded by the one specified in the `Location` header field. This and all future requests to this resource should be directed to the new URI. +`302`, `307` | Temporary redirection. The request should be repeated verbatim to the URI specified in the `Location` header field but clients should continue to use the original URI for future requests. -その他のリダイレクトステータスコードは、HTTP 1.1 仕様に従って使用できます。 +Other redirection status codes may be used in accordance with the HTTP 1.1 spec. -## HTTP メソッド +## HTTP verbs -API v3 は、可能な限り各アクションに適切な HTTPメソッドを使用しようとします。 +Where possible, API v3 strives to use appropriate HTTP verbs for each +action. -| メソッド | 説明 | -| -------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `HEAD` | HTTP ヘッダ情報のみを取得するために、任意のリソースに対して発行できます。 | -| `GET` | リソースを取得するために使用します。 | -| `POST` | リソースを作成するために使用します。 | -| `PATCH` | 部分的な JSON データでリソースを更新するために使用します。 たとえば、Issue リソースには `title` と `body` の属性があります。 `PATCH`リクエストは、リソースを更新するための1つ以上の属性を受け付けることがあります。 | -| `PUT` | リソースまたはコレクションを置き換えるために使用します。 `body` 属性のない `PUT` リクエストでは、必ず `Content-Length` ヘッダをゼロに設定してください。 | -| `DELETE` | リソースを削除するために使用します。 | +Verb | Description +-----|----------- +`HEAD` | Can be issued against any resource to get just the HTTP header info. +`GET` | Used for retrieving resources. +`POST` | Used for creating resources. +`PATCH` | Used for updating resources with partial JSON data. For instance, an Issue resource has `title` and `body` attributes. A `PATCH` request may accept one or more of the attributes to update the resource. +`PUT` | Used for replacing resources or collections. For `PUT` requests with no `body` attribute, be sure to set the `Content-Length` header to zero. +`DELETE` |Used for deleting resources. -## ハイパーメディア +## Hypermedia -すべてのリソースには、他のリソースにリンクしている 1 つ以上の `*_url` プロパティがある場合があります。 これらは、適切な API クライアントが自分で URL を構築する必要がないように、明示的な URL を提供することを目的としています。 API クライアントには、これらを使用することを強くお勧めしています。 そうすることで、開発者が今後の API のアップグレードを容易に行うことができます。 All URLs are expected to be proper [RFC 6570][rfc] URI templates. +All resources may have one or more `*_url` properties linking to other +resources. These are meant to provide explicit URLs so that proper API clients +don't need to construct URLs on their own. It is highly recommended that API +clients use these. Doing so will make future upgrades of the API easier for +developers. All URLs are expected to be proper [RFC 6570][rfc] URI templates. -次に、[uri_template][uri] などを使用して、これらのテンプレートを展開できます。 +You can then expand these templates using something like the [uri_template][uri] +gem: >> tmpl = URITemplate.new('/notifications{?since,all,participating}') >> tmpl.expand => "/notifications" - + >> tmpl.expand :all => 1 => "/notifications?all=1" - + >> tmpl.expand :all => 1, :participating => 1 => "/notifications?all=1&participating=1" -## ページネーション +[rfc]: https://datatracker.ietf.org/doc/html/rfc6570 +[uri]: https://github.com/hannesg/uri_template -複数のアイテムを返すリクエストは、デフォルトで 30 件ごとにページ分けされます。 `page` パラメータを使用すると、さらにページを指定できます。 一部のリソースでは、`per_page` パラメータを使用してカスタムページサイズを最大 100 に設定することもできます。 技術的な理由により、すべてのエンドポイントが `per_page` パラメータを尊重するわけではないことに注意してください。例については、[イベント](/rest/reference/activity#events)を参照してください。 +## Pagination + +Requests that return multiple items will be paginated to 30 items by +default. You can specify further pages with the `page` parameter. For some +resources, you can also set a custom page size up to 100 with the `per_page` parameter. +Note that for technical reasons not all endpoints respect the `per_page` parameter, +see [events](/rest/reference/activity#events) for example. ```shell $ curl '{% data variables.product.api_url_pre %}/user/repos?page=2&per_page=100' ``` -ページ番号は 1 から始まり、`page` パラメータを省略すると最初のページが返されることに注意してください。 +Note that page numbering is 1-based and that omitting the `page` +parameter will return the first page. -カーソルベースのページネーションを使用するエンドポイントもあります。 カーソルとは、結果セットで場所を示す文字列です。 カーソルベースのページネーションでは、結果セットで「ページ」という概念がなくなるため、特定のページに移動することはできません。 かわりに、`before` または `after` パラメータを使用して結果の中を移動できます。 +Some endpoints use cursor-based pagination. A cursor is a string that points to a location in the result set. +With cursor-based pagination, there is no fixed concept of "pages" in the result set, so you can't navigate to a specific page. +Instead, you can traverse the results by using the `before` or `after` parameters. -ページネーションの詳細については、[ページネーションでトラバースする][pagination-guide]のガイドをご覧ください。 +For more information on pagination, check out our guide on [Traversing with Pagination][pagination-guide]. -### リンクヘッダ +### Link header {% note %} -**注釈:** 独自の URL を作成するのではなく、Link ヘッダ値を使用して呼び出しを形成することが重要です。 +**Note:** It's important to form calls with Link header values instead of constructing your own URLs. {% endnote %} -The [Link header](https://datatracker.ietf.org/doc/html/rfc5988) includes pagination information. 例: +The [Link header](https://datatracker.ietf.org/doc/html/rfc5988) includes pagination information. For example: Link: <{% data variables.product.api_url_code %}/user/repos?page=3&per_page=100>; rel="next", <{% data variables.product.api_url_code %}/user/repos?page=50&per_page=100>; rel="last" -_この例は、読みやすいように改行されています。_ +_The example includes a line break for readability._ -エンドポイントでカーソルベースのページネーションを使用する場合: +Or, if the endpoint uses cursor-based pagination: Link: <{% data variables.product.api_url_code %}/orgs/ORG/audit-log?after=MTYwMTkxOTU5NjQxM3xZbGI4VE5EZ1dvZTlla09uWjhoZFpR&before=>; rel="next", This `Link` response header contains one or more [Hypermedia](/rest#hypermedia) link relations, some of which may require expansion as [URI templates](https://datatracker.ietf.org/doc/html/rfc6570). -使用可能な `rel` の値は以下のとおりです。 +The possible `rel` values are: -| 名前 | 説明 | -| ------- | ----------------- | -| `次` | 結果のすぐ次のページのリンク関係。 | -| `last` | 結果の最後のページのリンク関係。 | -| `first` | 結果の最初のページのリンク関係。 | -| `prev` | 結果の直前のページのリンク関係。 | +Name | Description +-----------|-----------| +`next` |The link relation for the immediate next page of results. +`last` |The link relation for the last page of results. +`first` |The link relation for the first page of results. +`prev` |The link relation for the immediate previous page of results. -## レート制限 +## Rate limiting -Basic 認証または OAuth を使用する API リクエストの場合、1 時間あたり最大 5,000 件のリクエストを作成できます。 認証されたリクエストは、[Basic 認証](#basic-authentication)または [OAuth トークン](#oauth2-token-sent-in-a-header)のどちらが使用されたかに関係なく、認証されたユーザに関連付けられます。 つまり、ユーザが認証したすべての OAuth アプリケーションは、同じユーザが所有する異なるトークンで認証する場合、1 時間あたり 5,000 リクエストという同じ割り当てを共有します。 +For API requests using Basic Authentication or OAuth, you can make up to 5,000 requests per hour. Authenticated requests are associated with the authenticated user, regardless of whether [Basic Authentication](#basic-authentication) or [an OAuth token](#oauth2-token-sent-in-a-header) was used. This means that all OAuth applications authorized by a user share the same quota of 5,000 requests per hour when they authenticate with different tokens owned by the same user. {% ifversion fpt or ghec %} -{% data variables.product.prodname_ghe_cloud %} アカウントに属するユーザの場合、同じ {% data variables.product.prodname_ghe_cloud %} アカウントが所有するリソースに OAuth トークンを使用して行うリクエストについては、1 時間当たりのリクエスト制限が 15,000 件まで増加します。 +For users that belong to a {% data variables.product.prodname_ghe_cloud %} account, requests made using an OAuth token to resources owned by the same {% data variables.product.prodname_ghe_cloud %} account have an increased limit of 15,000 requests per hour. {% endif %} -ビルトインの`GITHUB_TOKEN`をGitHub Actionsで使う場合、レート制限はリポジトリごとに1時間あたり1,000リクエストです。 GitHub Enterprise Cloudアカウントに属するOrganizationでは、この制限はリポジトリごとに1時間あたり15,000リクエストです。 +When using the built-in `GITHUB_TOKEN` in GitHub Actions, the rate limit is 1,000 requests per hour per repository. For organizations that belong to a GitHub Enterprise Cloud account, this limit is 15,000 requests per hour per repository. -認証されていないリクエストでは、レート制限により 1 時間あたり最大 60 リクエストまで可能です。 認証されていないリクエストは、リクエストを行っているユーザではなく、発信元の IP アドレスに関連付けられます。 +For unauthenticated requests, the rate limit allows for up to 60 requests per hour. Unauthenticated requests are associated with the originating IP address, and not the user making requests. {% data reusables.enterprise.rate_limit %} -[Search API にはカスタムのレート制限ルール](/rest/reference/search#rate-limit)があることに注意してください。 +Note that [the Search API has custom rate limit rules](/rest/reference/search#rate-limit). -API リクエストの返された HTTP ヘッダは、現在のレート制限ステータスを示しています。 +The returned HTTP headers of any API request show your current rate limit status: ```shell $ curl -I {% data variables.product.api_url_pre %}/users/octocat @@ -337,20 +383,20 @@ $ curl -I {% data variables.product.api_url_pre %}/users/octocat > X-RateLimit-Reset: 1372700873 ``` -| ヘッダ名 | 説明 | -| ----------------------- | ----------------------------------------------------------------------------- | -| `X-RateLimit-Limit` | 1 時間あたりのリクエスト数の上限。 | -| `X-RateLimit-Remaining` | 現在のレート制限ウィンドウに残っているリクエストの数。 | -| `X-RateLimit-Reset` | 現在のレート制限ウィンドウが [UTC エポック秒](http://en.wikipedia.org/wiki/Unix_time)でリセットされる時刻。 | +Header Name | Description +-----------|-----------| +`X-RateLimit-Limit` | The maximum number of requests you're permitted to make per hour. +`X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. +`X-RateLimit-Reset` | The time at which the current rate limit window resets in [UTC epoch seconds](http://en.wikipedia.org/wiki/Unix_time). -時刻に別の形式を使用する必要がある場合は、最新のプログラミング言語で作業を完了できます。 たとえば、Web ブラウザでコンソールを開くと、リセット時刻を JavaScript の Date オブジェクトとして簡単に取得できます。 +If you need the time in a different format, any modern programming language can get the job done. For example, if you open up the console on your web browser, you can easily get the reset time as a JavaScript Date object. ``` javascript new Date(1372700873 * 1000) // => Mon Jul 01 2013 13:47:53 GMT-0400 (EDT) ``` -レート制限を超えると、次のようなエラーレスポンスが返されます。 +If you exceed the rate limit, an error response returns: ```shell > HTTP/2 403 @@ -365,11 +411,11 @@ new Date(1372700873 * 1000) > } ``` -API ヒットを発生させることなく、[レート制限ステータスを確認](/rest/reference/rate-limit)できます。 +You can [check your rate limit status](/rest/reference/rate-limit) without incurring an API hit. -### OAuth アプリケーションの認証されていないレート制限を増やす +### Increasing the unauthenticated rate limit for OAuth applications -OAuth アプリケーションが認証されていない呼び出しをより高いレート制限で行う必要がある場合は、エンドポイントルートの前にアプリのクライアント ID とシークレットを渡すことができます。 +If your OAuth application needs to make unauthenticated calls with a higher rate limit, you can pass your app's client ID and secret before the endpoint route. ```shell $ curl -u my_client_id:my_client_secret {% data variables.product.api_url_pre %}/user/repos @@ -382,21 +428,21 @@ $ curl -u my_client_id:my_client_secret {% data variables.product.api_url_pre %} {% note %} -**注釈:** クライアントシークレットを他のユーザと共有したり、クライアント側のブラウザコードに含めたりしないでください。 こちらに示す方法は、サーバー間の呼び出しにのみ使用してください。 +**Note:** Never share your client secret with anyone or include it in client-side browser code. Use the method shown here only for server-to-server calls. {% endnote %} -### レート制限内に収める +### Staying within the rate limit -Basic 認証または OAuth を使用してレート制限を超えた場合、API レスポンスをキャッシュし、[条件付きリクエスト](#conditional-requests)を使用することで問題を解決できます。 +If you exceed your rate limit using Basic Authentication or OAuth, you can likely fix the issue by caching API responses and using [conditional requests](#conditional-requests). ### Secondary rate limits -{% data variables.product.product_name %} で高品質のサービスを提供するにあたって、API を使用するときに、いくつかのアクションに追加のレート制限が適用される場合があります。 For example, using the API to rapidly create content, poll aggressively instead of using webhooks, make multiple concurrent requests, or repeatedly request data that is computationally expensive may result in secondary rate limiting. +In order to provide quality service on {% data variables.product.product_name %}, additional rate limits may apply to some actions when using the API. For example, using the API to rapidly create content, poll aggressively instead of using webhooks, make multiple concurrent requests, or repeatedly request data that is computationally expensive may result in secondary rate limiting. -Secondary rate limits are not intended to interfere with legitimate use of the API. 通常のレート制限が、ユーザにとって唯一の制限であるべきです。 優良な API ユーザにふさわしい振る舞いをしているかどうかを確認するには、[ベストプラクティスのガイドライン](/guides/best-practices-for-integrators/)をご覧ください。 +Secondary rate limits are not intended to interfere with legitimate use of the API. Your normal rate limits should be the only limit you target. To ensure you're acting as a good API citizen, check out our [Best Practices guidelines](/guides/best-practices-for-integrators/). -アプリケーションがこのレート制限をトリガーすると、次のような有益なレスポンスを受け取ります。 +If your application triggers this rate limit, you'll receive an informative response: ```shell > HTTP/2 403 @@ -411,17 +457,19 @@ Secondary rate limits are not intended to interfere with legitimate use of the A {% ifversion fpt or ghec %} -## User agent の必要性 +## User agent required -すべての API リクエストには、有効な `User-Agent` ヘッダを含める必要があります。 `User-Agent` ヘッダのないリクエストは拒否されます。 `User-Agent` ヘッダの値には、{% data variables.product.product_name %} のユーザ名またはアプリケーション名を使用してください。 そうすることで、問題がある場合にご連絡することができます。 +All API requests MUST include a valid `User-Agent` header. Requests with no `User-Agent` +header will be rejected. We request that you use your {% data variables.product.product_name %} username, or the name of your +application, for the `User-Agent` header value. This allows us to contact you if there are problems. -次に例を示します。 +Here's an example: ```shell User-Agent: Awesome-Octocat-App ``` -cURL はデフォルトで有効な `User-Agent` ヘッダを送信します。 cURL（または代替クライアント）を介して無効な `User-Agent` ヘッダを提供すると、`403 Forbidden` レスポンスが返されます。 +cURL sends a valid `User-Agent` header by default. If you provide an invalid `User-Agent` header via cURL (or via an alternative client), you will receive a `403 Forbidden` response: ```shell $ curl -IH 'User-Agent: ' {% data variables.product.api_url_pre %}/meta @@ -436,15 +484,20 @@ $ curl -IH 'User-Agent: ' {% data variables.product.api_url_pre %}/meta {% endif %} -## 条件付きリクエスト +## Conditional requests -ほとんどのレスポンスでは `ETag` ヘッダが返されます。 多くのレスポンスでは `Last-Modified` ヘッダも返されます。 これらのヘッダーの値を使用して、それぞれ `If-None-Match` ヘッダと `If-Modified-Since` ヘッダを使い、それらのリソースに対して後続のリクエストを行うことができます。 リソースが変更されていない場合、サーバーは `304 Not Modified` を返します。 +Most responses return an `ETag` header. Many responses also return a `Last-Modified` header. You can use the values +of these headers to make subsequent requests to those resources using the +`If-None-Match` and `If-Modified-Since` headers, respectively. If the resource +has not changed, the server will return a `304 Not Modified`. {% ifversion fpt or ghec %} {% tip %} -**注釈**: 条件付きリクエストを作成して 304 レスポンスを受信しても、[レート制限](#rate-limiting)にはカウントされないため、可能な限り使用することをお勧めします。 +**Note**: Making a conditional request and receiving a 304 response does not +count against your [Rate Limit](#rate-limiting), so we encourage you to use it +whenever possible. {% endtip %} @@ -481,11 +534,16 @@ $ curl -I {% data variables.product.api_url_pre %}/user -H "If-Modified-Since: T > X-RateLimit-Reset: 1372700873 ``` -## オリジン間リソース共有 +## Cross origin resource sharing -API は、任意のオリジンからの AJAX リクエストに対して、オリジン間リソース共有（CORS）をサポートします。 [CORS W3C Recommendation](http://www.w3.org/TR/cors/)、または HTML 5 セキュリティガイドの[こちらの概要](https://code.google.com/archive/p/html5security/wikis/CrossOriginRequestSecurity.wiki)をご確認ください。 +The API supports Cross Origin Resource Sharing (CORS) for AJAX requests from +any origin. +You can read the [CORS W3C Recommendation](http://www.w3.org/TR/cors/), or +[this intro](https://code.google.com/archive/p/html5security/wikis/CrossOriginRequestSecurity.wiki) from the +HTML 5 Security Guide. -`http://example.com` にアクセスするブラウザから送信されたサンプルリクエストは次のとおりです。 +Here's a sample request sent from a browser hitting +`http://example.com`: ```shell $ curl -I {% data variables.product.api_url_pre %} -H "Origin: http://example.com" @@ -494,7 +552,7 @@ Access-Control-Allow-Origin: * Access-Control-Expose-Headers: ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval ``` -CORS プリフライトリクエストは次のようになります。 +This is what the CORS preflight request looks like: ```shell $ curl -I {% data variables.product.api_url_pre %} -H "Origin: http://example.com" -X OPTIONS @@ -506,9 +564,13 @@ Access-Control-Expose-Headers: ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-Ra Access-Control-Max-Age: 86400 ``` -## JSON-P コールバック +## JSON-P callbacks -`?callback` パラメータを任意の GET 呼び出しに送信して、結果を JSON 関数でラップできます。 これは通常、ブラウザがクロスドメインの問題を回避することにより、{% data variables.product.product_name %} のコンテンツを Web ページに埋め込む場合に使用されます。 レスポンスには、通常の API と同じデータ出力と、関連する HTTP ヘッダ情報が含まれます。 +You can send a `?callback` parameter to any GET call to have the results +wrapped in a JSON function. This is typically used when browsers want +to embed {% data variables.product.product_name %} content in web pages by getting around cross domain +issues. The response includes the same data output as the regular API, +plus the relevant HTTP Header information. ```shell $ curl {% data variables.product.api_url_pre %}?callback=foo @@ -529,7 +591,7 @@ $ curl {% data variables.product.api_url_pre %}?callback=foo > }) ``` -JavaScript ハンドラを記述して、コールバックを処理できます。 以下は、試すことができる最も簡易な例です。 +You can write a JavaScript handler to process the callback. Here's a minimal example you can try out: @@ -540,26 +602,28 @@ JavaScript ハンドラを記述して、コールバックを処理できます console.log(meta); console.log(data); } - + var script = document.createElement('script'); script.src = '{% data variables.product.api_url_code %}?callback=foo'; - + document.getElementsByTagName('head')[0].appendChild(script); - +

Open up your browser's console.

-すべてのヘッダは HTTP ヘッダと同じ文字列型の値ですが、例外の 1つとして「Link」があります。 Link ヘッダは事前に解析され、`[url, options]` タプルの配列として渡されます。 +All of the headers are the same String value as the HTTP Headers with one +notable exception: Link. Link headers are pre-parsed for you and come +through as an array of `[url, options]` tuples. -リンクは次のようになります。 +A link that looks like this: Link: ; rel="next", ; rel="foo"; bar="baz" -... コールバック出力では次のようになります。 +... will look like this in the Callback output: ```json { @@ -581,42 +645,39 @@ JavaScript ハンドラを記述して、コールバックを処理できます } ``` -## タイムゾーン +## Timezones -新しいコミットの作成など、新しいデータを作成する一部のリクエストでは、タイムスタンプを指定または生成するときにタイムゾーン情報を提供できます。 We apply the following rules, in order of priority, to determine timezone information for such API calls. +Some requests that create new data, such as creating a new commit, allow you to provide time zone information when specifying or generating timestamps. We apply the following rules, in order of priority, to determine timezone information for such API calls. -* [ISO 8601 タイムスタンプにタイムゾーン情報を明示的に提供する](#explicitly-providing-an-iso-8601-timestamp-with-timezone-information) -* [`Time-Zone` ヘッダを使用する](#using-the-time-zone-header) -* [ユーザが最後に認識されたタイムゾーンを使用する](#using-the-last-known-timezone-for-the-user) -* [他のタイムゾーン情報を含まない UTC をデフォルトにする](#defaulting-to-utc-without-other-timezone-information) +* [Explicitly providing an ISO 8601 timestamp with timezone information](#explicitly-providing-an-iso-8601-timestamp-with-timezone-information) +* [Using the `Time-Zone` header](#using-the-time-zone-header) +* [Using the last known timezone for the user](#using-the-last-known-timezone-for-the-user) +* [Defaulting to UTC without other timezone information](#defaulting-to-utc-without-other-timezone-information) Note that these rules apply only to data passed to the API, not to data returned by the API. As mentioned in "[Schema](#schema)," timestamps returned by the API are in UTC time, ISO 8601 format. -### ISO 8601 タイムスタンプにタイムゾーン情報を明示的に提供する +### Explicitly providing an ISO 8601 timestamp with timezone information -タイムスタンプを指定できる API 呼び出しの場合、その正確なタイムスタンプを使用します。 これは[コミット API](/rest/reference/git#commits) の例です。 +For API calls that allow for a timestamp to be specified, we use that exact timestamp. An example of this is the [Commits API](/rest/reference/git#commits). -これらのタイムスタンプは、`2014-02-27T15:05:06+01:00` のようになります。 これらのタイムスタンプを指定する方法については、[こちらの例](/rest/reference/git#example-input)も参照してください。 +These timestamps look something like `2014-02-27T15:05:06+01:00`. Also see [this example](/rest/reference/git#example-input) for how these timestamps can be specified. -### `Time-Zone` ヘッダを使用する +### Using the `Time-Zone` header -[Olson データベースの名前のリスト](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)に従ってタイムゾーンを定義する `Time-Zone` ヘッダを提供することができます。 +It is possible to supply a `Time-Zone` header which defines a timezone according to the [list of names from the Olson database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). ```shell $ curl -H "Time-Zone: Europe/Amsterdam" -X POST {% data variables.product.api_url_pre %}/repos/github/linguist/contents/new_file.md ``` -つまり、このヘッダが定義するタイムゾーンで API 呼び出しが行われた時のタイムスタンプが生成されます。 たとえば、[コンテンツ API](/rest/reference/repos#contents) は追加または変更ごとに git コミットを生成し、タイムスタンプとして現在の時刻を使用します。 このヘッダは、現在のタイムスタンプの生成に使用されたタイムゾーンを決定します。 +This means that we generate a timestamp for the moment your API call is made in the timezone this header defines. For example, the [Contents API](/rest/reference/repos#contents) generates a git commit for each addition or change and uses the current time as the timestamp. This header will determine the timezone used for generating that current timestamp. -### ユーザが最後に認識されたタイムゾーンを使用する +### Using the last known timezone for the user -`Time-Zone` ヘッダが指定されておらず、API への認証された呼び出しを行う場合、認証されたユーザが最後に認識されたタイムゾーンが使用されます。 最後に認識されたタイムゾーンは、{% data variables.product.product_name %} Web サイトを閲覧するたびに更新されます。 +If no `Time-Zone` header is specified and you make an authenticated call to the API, we use the last known timezone for the authenticated user. The last known timezone is updated whenever you browse the {% data variables.product.product_name %} website. -### 他のタイムゾーン情報を含まない UTC をデフォルトにする +### Defaulting to UTC without other timezone information -上記の手順で情報が得られない場合は、UTC をタイムゾーンとして使用して git コミットを作成します。 - -[rfc]: https://datatracker.ietf.org/doc/html/rfc6570 -[uri]: https://github.com/hannesg/uri_template +If the steps above don't result in any information, we use UTC as the timezone to create the git commit. [pagination-guide]: /guides/traversing-with-pagination diff --git a/translations/ja-JP/content/rest/reference/enterprise-admin.md b/translations/ja-JP/content/rest/reference/enterprise-admin.md index fbe657c8eb..d903396303 100644 --- a/translations/ja-JP/content/rest/reference/enterprise-admin.md +++ b/translations/ja-JP/content/rest/reference/enterprise-admin.md @@ -186,7 +186,7 @@ $ curl -L 'https://hostname:admin_port/setup/api?api_key=y You can also use standard HTTP authentication to send this token. For example: ```shell -$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api' +$ curl -L -u "api_key:your-amazing-password" 'https://hostname:admin_port/setup/api' ``` {% for operation in currentRestOperations %} diff --git a/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index f6f7e88e11..74e1a19074 100644 --- a/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -2,11 +2,11 @@ title: About searching on GitHub intro: 'Our integrated search covers the many repositories, users, and lines of code on {% data variables.product.product_name %}.' redirect_from: - - /articles/using-the-command-bar/ - - /articles/github-search-basics/ - - /articles/search-basics/ - - /articles/searching-github/ - - /articles/advanced-search/ + - /articles/using-the-command-bar + - /articles/github-search-basics + - /articles/search-basics + - /articles/searching-github + - /articles/advanced-search - /articles/about-searching-on-github - /github/searching-for-information-on-github/about-searching-on-github - /github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github diff --git a/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md b/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md index cf410536e1..2e98bbd3ee 100644 --- a/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md +++ b/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md @@ -3,9 +3,9 @@ title: Enabling GitHub.com repository search from your private enterprise enviro shortTitle: Search GitHub.com from enterprise intro: 'You can connect your personal accounts on {% data variables.product.prodname_dotcom_the_website %} and your private {% data variables.product.prodname_enterprise %} environment to search for content in certain {% data variables.product.prodname_dotcom_the_website %} repositories{% ifversion fpt or ghec %} from your private environment{% else %} from {% data variables.product.product_name %}{% endif %}.' redirect_from: - - /articles/enabling-private-githubcom-repository-search-in-your-github-enterprise-account/ - - /articles/enabling-private-github-com-repository-search-in-your-github-enterprise-server-account/ - - /articles/enabling-private-githubcom-repository-search-in-your-github-enterprise-server-account/ + - /articles/enabling-private-githubcom-repository-search-in-your-github-enterprise-account + - /articles/enabling-private-github-com-repository-search-in-your-github-enterprise-server-account + - /articles/enabling-private-githubcom-repository-search-in-your-github-enterprise-server-account - /articles/enabling-githubcom-repository-search-in-github-enterprise-server - /github/searching-for-information-on-github/enabling-githubcom-repository-search-in-github-enterprise-server - /github/searching-for-information-on-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-in-github-enterprise-server diff --git a/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md b/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md index a1e7fc2127..82108d649c 100644 --- a/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md +++ b/translations/ja-JP/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md @@ -1,8 +1,8 @@ --- -title: 検索構文を理解する -intro: '{% data variables.product.product_name %} の検索では、特定の数字や単語にマッチするクエリを作成できます。' +title: Understanding the search syntax +intro: 'When searching {% data variables.product.product_name %}, you can construct queries that match specific numbers and words.' redirect_from: - - /articles/search-syntax/ + - /articles/search-syntax - /articles/understanding-the-search-syntax - /github/searching-for-information-on-github/understanding-the-search-syntax - /github/searching-for-information-on-github/getting-started-with-searching-on-github/understanding-the-search-syntax @@ -15,86 +15,85 @@ topics: - GitHub search shortTitle: Understand search syntax --- +## Query for values greater or less than another value -## ある値より大きいまたは小さい値のクエリ +You can use `>`, `>=`, `<`, and `<=` to search for values that are greater than, greater than or equal to, less than, and less than or equal to another value. -`>`、`>=`、`<`、`<=` などを使って、他の値に対する値の大なり、大なりイコール、小なり、または、小なりイコールでの検索を行えます。 +Query | Example +------------- | ------------- +>n | **[cats stars:>1000](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3E1000&type=Repositories)** matches repositories with the word "cats" that have more than 1000 stars. +>=n | **[cats topics:>=5](https://github.com/search?utf8=%E2%9C%93&q=cats+topics%3A%3E%3D5&type=Repositories)** matches repositories with the word "cats" that have 5 or more topics. +<n | **[cats size:<10000](https://github.com/search?utf8=%E2%9C%93&q=cats+size%3A%3C10000&type=Code)** matches code with the word "cats" in files that are smaller than 10 KB. +<=n | **[cats stars:<=50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3C%3D50&type=Repositories)** matches repositories with the word "cats" that have 50 or fewer stars. -| クエリ | サンプル | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| >n | **[cats stars:>1000](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3E1000&type=Repositories)** は、1000 を超える Star のある、「cats」という単語があるリポジトリにマッチします。 | -| >=n | **[cats topics:>=5](https://github.com/search?utf8=%E2%9C%93&q=cats+topics%3A%3E%3D5&type=Repositories)** は、トピックが 5 つ以上ある、「cats」という単語のあるリポジトリにマッチします。 | -| <n | **[cats size:<10000](https://github.com/search?utf8=%E2%9C%93&q=cats+size%3A%3C10000&type=Code)** は、10 KB より小さいファイルで、「cats」という単語があるコードにマッチします。 | -| <=n | **[cats stars:<=50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%3C%3D50&type=Repositories)** は、50 以下の Star があり、「cats」という単語のあるリポジトリにマッチします。 | +You can also use [range queries](#query-for-values-between-a-range) to search for values that are greater than or equal to, or less than or equal to, another value. -他の値に対する値の大なり、大なりイコール、小なり、または、小なりイコールでの検索は、[range queries](#query-for-values-between-a-range) を使って実行することもできます。 +Query | Example +------------- | ------------- +n..* | **[cats stars:10..*](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..*&type=Repositories)** is equivalent to `stars:>=10` and matches repositories with the word "cats" that have 10 or more stars. +*..n | **[cats stars:*..10](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%22*..10%22&type=Repositories)** is equivalent to `stars:<=10` and matches repositories with the word "cats" that have 10 or fewer stars. -| クエリ | サンプル | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| n..* | **[cats stars:10..*](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..*&type=Repositories)** は、`stars:>=10` と同様に、10 以上の Star のある、「cats」という単語のあるリポジトリにマッチします。 | -| *..n | **[cats stars:*..10](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A%22*..10%22&type=Repositories) は、**`stars:<=10` と同様に、Star が 10 以下で、「cats」という単語のあるリポジトリにマッチします。 | +## Query for values between a range -## 一定範囲にある値のクエリ +You can use the range syntax n..n to search for values within a range, where the first number _n_ is the lowest value and the second is the highest value. -n..n という範囲構文を使って、範囲内の値を検索できます。最初の番号 _n_ が最小値で、二番目が最大値です。 +Query | Example +------------- | ------------- +n..n | **[cats stars:10..50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..50&type=Repositories)** matches repositories with the word "cats" that have between 10 and 50 stars. -| クエリ | サンプル | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| n..n | **[cats stars:10..50](https://github.com/search?utf8=%E2%9C%93&q=cats+stars%3A10..50&type=Repositories)** は、Star が 10 から 50 までの間の数の、「cats」という単語のあるリポジトリにマッチします。 | +## Query for dates -## 日付のクエリ +You can search for dates that are earlier or later than another date, or that fall within a range of dates, by using `>`, `>=`, `<`, `<=`, and [range queries](#query-for-values-between-a-range). {% data reusables.time_date.date_format %} -`>` 、`>=` 、`<` 、`<=` や [range queries](#query-for-values-between-a-range) を使って、他の日より前または後の日付や、一定の範囲内の日付を検索できます。 {% data reusables.time_date.date_format %} - -| クエリ | サンプル | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| >YYYY-MM-DD | **[cats created:>2016-04-29](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E2016-04-29&type=Issues)** は、2016 年 4 月 29 日より後に作成された、「cats」という単語のある Issue にマッチします。 | -| >=YYYY-MM-DD | **[cats created:>=2017-04-01](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E%3D2017-04-01&type=Issues)** は、2017 年 4 月 1 日以降に作成された、「cats」という単語を含む Issue にマッチします。 | -| <YYYY-MM-DD | **[cats pushed:<2012-07-05](https://github.com/search?q=cats+pushed%3A%3C2012-07-05&type=Code&utf8=%E2%9C%93)** は、2012 年 7 月 5 日より前にプッシュされた、リポジトリに「cats」という単語のあるコードにマッチします。 | -| <=YYYY-MM-DD | **[cats created:<=2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3C%3D2012-07-04&type=Issues)** は、2012 年 7 月 4 日以前に作成された、「cats」という単語のある Issue にマッチします。 | -| YYYY-MM-DD..YYYY-MM-DD | **[cats pushed:2016-04-30..2016-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories)** は、2016 年 4 月末から 2017 年 7 月 4 日の間にプッシュされた、「cats」という単語のあるリポジトリにマッチします。 | -| YYYY-MM-DD..* | **[cats created:2012-04-30..*](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2012-04-30..*&type=Issues)** は、「cats」という単語を含む、2012 年 4 月 30 日より後に作成された Issue にマッチします。 | -| *..YYYY-MM-DD | **[cats created:*..2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** は、「cats」という単語のある、2012 年 7 月 4 日より前に作成された Issue にマッチします。 | +Query | Example +------------- | ------------- +>YYYY-MM-DD | **[cats created:>2016-04-29](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E2016-04-29&type=Issues)** matches issues with the word "cats" that were created after April 29, 2016. +>=YYYY-MM-DD | **[cats created:>=2017-04-01](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3E%3D2017-04-01&type=Issues)** matches issues with the word "cats" that were created on or after April 1, 2017. +<YYYY-MM-DD | **[cats pushed:<2012-07-05](https://github.com/search?q=cats+pushed%3A%3C2012-07-05&type=Code&utf8=%E2%9C%93)** matches code with the word "cats" in repositories that were pushed to before July 5, 2012. +<=YYYY-MM-DD | **[cats created:<=2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3C%3D2012-07-04&type=Issues)** matches issues with the word "cats" that were created on or before July 4, 2012. +YYYY-MM-DD..YYYY-MM-DD | **[cats pushed:2016-04-30..2016-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories)** matches repositories with the word "cats" that were pushed to between the end of April and July of 2016. +YYYY-MM-DD..* | **[cats created:2012-04-30..*](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2012-04-30..*&type=Issues)** matches issues created after April 30th, 2012 containing the word "cats." +*..YYYY-MM-DD | **[cats created:*..2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** matches issues created before July 4th, 2012 containing the word "cats." {% data reusables.time_date.time_format %} -| クエリ | サンプル | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| YYYY-MM-DDTHH:MM:SS+00:00 | **[cats created:2017-01-01T01:00:00+07:00..2017-03-01T15:30:15+07:00](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2017-01-01T01%3A00%3A00%2B07%3A00..2017-03-01T15%3A30%3A15%2B07%3A00&type=Issues)** 2017 年 1 月 1 日午前 1 時（世界協定時`+7時間`）と 2017 年 3 月 1 日午後 3 時（世界協定時 `+7時間`）の間に作成された Issue にマッチします。 （世界協定時`+7時間`）と 2017 年 3 月 1 日午後 3 時 （世界協定時 `+7時間`）の間に作成された Issue にマッチします。 | -| YYYY-MM-DDTHH:MM:SSZ | **[cats created:2016-03-21T14:11:00Z..2016-04-07T20:45:00Z](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2016-03-21T14%3A11%3A00Z..2016-04-07T20%3A45%3A00Z&type=Issues)** は、2016 年 3 月 21 日午後 2 時 11 分と 2016 年 4 月 7 日 8 時 45 分の間に作成された Issue にマッチします。 | +Query | Example +------------- | ------------- +YYYY-MM-DDTHH:MM:SS+00:00 | **[cats created:2017-01-01T01:00:00+07:00..2017-03-01T15:30:15+07:00](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2017-01-01T01%3A00%3A00%2B07%3A00..2017-03-01T15%3A30%3A15%2B07%3A00&type=Issues)** matches issues created between January 1, 2017 at 1 a.m. with a UTC offset of `07:00` and March 1, 2017 at 3 p.m. with a UTC offset of `07:00`. +YYYY-MM-DDTHH:MM:SSZ | **[cats created:2016-03-21T14:11:00Z..2016-04-07T20:45:00Z](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2016-03-21T14%3A11%3A00Z..2016-04-07T20%3A45%3A00Z&type=Issues)** matches issues created between March 21, 2016 at 2:11pm and April 7, 2106 at 8:45pm. -## 一定の検索結果の除外 +## Exclude certain results -`NOT` 構文を使うことで、一定の単語を含む検索結果を除外できます。 `NOT` 演算子は、文字列型キーワードに限って使うことができます。 数や日付では機能しません。 +You can exclude results containing a certain word, using the `NOT` syntax. The `NOT` operator can only be used for string keywords. It does not work for numerals or dates. -| クエリ | サンプル | -| ----- | ----------------------------------------------------------------------------------------------------------------------------------- | -| `NOT` | **[hello NOT world](https://github.com/search?q=hello+NOT+world&type=Repositories)** は、「world」という単語がなく、「hello」という単語のあるリポジトリにマッチします。 | +Query | Example +------------- | ------------- +`NOT` | **[hello NOT world](https://github.com/search?q=hello+NOT+world&type=Repositories)** matches repositories that have the word "hello" but not the word "world." -検索結果を絞り込む他の方法としては、一定のサブセットを除外することです。 `-` のプリフィックスを修飾子に付けることで、その修飾子にマッチする全ての結果を除外できます。 +Another way you can narrow down search results is to exclude certain subsets. You can prefix any search qualifier with a `-` to exclude all results that are matched by that qualifier. -| クエリ | サンプル | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| -QUALIFIER | **[mentions:defunkt -org:github](https://github.com/search?utf8=%E2%9C%93&q=mentions%3Adefunkt+-org%3Agithub&type=Issues)** matches issues mentioning @defunkt that are not in repositories in the GitHub organization. | +Query | Example +------------- | ------------- +-QUALIFIER | **[mentions:defunkt -org:github](https://github.com/search?utf8=%E2%9C%93&q=mentions%3Adefunkt+-org%3Agithub&type=Issues)** matches issues mentioning @defunkt that are not in repositories in the GitHub organization. -## 空白のあるクエリに引用符を使う +## Use quotation marks for queries with whitespace -検索クエリに空白がある場合は引用府で囲む必要があります。 例: +If your search query contains whitespace, you will need to surround it with quotation marks. For example: -* [cats NOT "hello world"](https://github.com/search?utf8=✓&q=cats+NOT+"hello+world"&type=Repositories) は、「hello world」という単語がなく、「cats」という単語のあるリポジトリにマッチします。 -* [build label:"bug fix"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) は、「bug fix」というラベルがある、「build」という単語のある Issue にマッチします。 +* [cats NOT "hello world"](https://github.com/search?utf8=✓&q=cats+NOT+"hello+world"&type=Repositories) matches repositories with the word "cats" but not the words "hello world." +* [build label:"bug fix"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) matches issues with the word "build" that have the label "bug fix." -スペースなど、いくつかの英数字以外の記号は、引用符で囲ったコード検索クエリから省かれるので、結果が予想外のものになる場合があります。 +Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected. {% ifversion fpt or ghes or ghae or ghec %} -## ユーザ名によるクエリ +## Queries with usernames -検索クエリに、`user`、`actor`、`assignee`などユーザ名を必要とする修飾子が含まれる場合は、任意の {% data variables.product.product_name %} ユーザ名を使用して特定の個人を指定するか、`@me`を使用して現在のユーザを指定することができます。 +If your search query contains a qualifier that requires a username, such as `user`, `actor`, or `assignee`, you can use any {% data variables.product.product_name %} username, to specify a specific person, or `@me`, to specify the current user. -| クエリ | サンプル | -| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `QUALIFIER:USERNAME` | [`author:nat`](https://github.com/search?q=author%3Anat&type=Commits) は、@nat が書いたコミットにマッチします。 | -| `QUALIFIER:@me` | [`is:issue assignee:@me`](https://github.com/search?q=is%3Aissue+assignee%3A%40me&type=Issues) は、結果を表示している個人に割り当てられた Issue に一致します。 | +Query | Example +------------- | ------------- +`QUALIFIER:USERNAME` | [`author:nat`](https://github.com/search?q=author%3Anat&type=Commits) matches commits authored by @nat +`QUALIFIER:@me` | [`is:issue assignee:@me`](https://github.com/search?q=is%3Aissue+assignee%3A%40me&type=Issues) matches issues assigned to the person viewing the results -`@me` は必ず修飾子とともに使用し、`@me main.workflow` のように検索用語としては使用できません。 +You can only use `@me` with a qualifier and not as search term, such as `@me main.workflow`. {% endif %} diff --git a/translations/ja-JP/content/search-github/index.md b/translations/ja-JP/content/search-github/index.md index b6e3aab782..c2eeff5e6d 100644 --- a/translations/ja-JP/content/search-github/index.md +++ b/translations/ja-JP/content/search-github/index.md @@ -1,9 +1,9 @@ --- -title: GitHub で情報を検索する +title: Searching for information on GitHub intro: Use different types of searches to find the information you want. redirect_from: - - /categories/78/articles/ - - /categories/search/ + - /categories/78/articles + - /categories/search - /categories/searching-for-information-on-github - /github/searching-for-information-on-github versions: diff --git a/translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md b/translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md index d0f25c2d0c..f12649f07a 100644 --- a/translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md +++ b/translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md @@ -2,7 +2,7 @@ title: Searching for repositories intro: 'You can search for repositories on {% data variables.product.product_name %} and narrow the results using these repository search qualifiers in any combination.' redirect_from: - - /articles/searching-repositories/ + - /articles/searching-repositories - /articles/searching-for-repositories - /github/searching-for-information-on-github/searching-for-repositories - /github/searching-for-information-on-github/searching-on-github/searching-for-repositories diff --git a/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 87b2785ed3..d41e60cedd 100644 --- a/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -2,7 +2,7 @@ title: Searching issues and pull requests intro: 'You can search for issues and pull requests on {% data variables.product.product_name %} and narrow the results using these search qualifiers in any combination.' redirect_from: - - /articles/searching-issues/ + - /articles/searching-issues - /articles/searching-issues-and-pull-requests - /github/searching-for-information-on-github/searching-issues-and-pull-requests - /github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests diff --git a/translations/ja-JP/data/features/actions-starter-template-ui.yml b/translations/ja-JP/data/features/actions-starter-template-ui.yml new file mode 100644 index 0000000000..7e1ebe5384 --- /dev/null +++ b/translations/ja-JP/data/features/actions-starter-template-ui.yml @@ -0,0 +1,6 @@ +--- +#Reference: #5169. +#Documentation for the Actions starter template UI updates +versions: + fpt: '*' + ghec: '*' diff --git a/translations/ja-JP/data/glossaries/README.md b/translations/ja-JP/data/glossaries/README.md index e5ef655d63..324db4ca24 100644 --- a/translations/ja-JP/data/glossaries/README.md +++ b/translations/ja-JP/data/glossaries/README.md @@ -3,5 +3,6 @@ [ Crowdinの用語集](https://support.crowdin.com/glossary/)は以下のファイルから構成されます。 * `external.yml`には顧客向けの用語集のエントリが含まれます。 + * Strings within `external.yml` support Liquid conditionals. See [contributing/liquid-helpers.md](/contributing/liquid-helpers.md). * `internal.yml`には、翻訳者だけが使うエントリが含まれます。 これらの用語はCrowdinのUIに表示され、翻訳者に対して翻訳しているものに関する追加の文脈と、その後に対するローカライズされた文字列の提案を提供します。 * `candidates.yml`には、内部的あるいは外部的な用語集に含まれるべきではあるものの、まだ定義されていない用語が含まれます。 diff --git a/translations/ja-JP/data/learning-tracks/README.md b/translations/ja-JP/data/learning-tracks/README.md index 849f4615d0..dfe6e8c544 100644 --- a/translations/ja-JP/data/learning-tracks/README.md +++ b/translations/ja-JP/data/learning-tracks/README.md @@ -33,7 +33,10 @@ ガイドのためのYAMLファイルのバージョン付けでLiquid条件文を使う必要は**ありません**。 現在のバージョンに適用される学習トラックのガイドだけが自動的にレンダリングされます。 現在のバージョンに属するガイドを持つトラックがない場合、その学習トラックのセクションはまったくレンダリングされません。 -製品の学習トラックのYAMLデータ中における明示的なバージョン付けもサポートされています。 例: +製品の学習トラックのYAMLデータ中における明示的なバージョン付けもサポートされています。 フォーマットと使用可能な値は[ frontmatter versionsプロパティ](/content#versions)と同じです。 + +例: + ``` learning_track_name: title: 'Learning track title' @@ -45,6 +48,7 @@ learning_track_name: - /path/to/guide1 - /path/to/guide2 ``` + ` versions`プロパティが含まれていなければ、そのトラックはすべてのバージョンで利用できるものと見なされます。 ## スキーマの適用 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-0/22.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-0/22.yml index 814b0724d3..073406d0ad 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-0/22.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-0/22.yml @@ -3,6 +3,7 @@ date: '2021-12-13' sections: security_fixes: - '**CRITICAL:** A remote code execution vulnerability in the Log4j library, identified as [CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228), affected all versions of {% data variables.product.prodname_ghe_server %} prior to 3.3.1. The Log4j library is used in an open source service running on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability was fixed in {% data variables.product.prodname_ghe_server %} versions 3.0.22, 3.1.14, 3.2.6, and 3.3.1. For more information, please see [this post](https://github.blog/2021-12-13-githubs-response-to-log4j-vulnerability-cve-2021-44228/) on the GitHub Blog.' + - '**December 17, 2021 update**: The fixes in place for this release also mitigate [CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046), which was published after this release. No additional upgrade for {% data variables.product.prodname_ghe_server %} is required to mitigate both CVE-2021-44228 and CVE-2021-45046.' known_issues: - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。 - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-1/14.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-1/14.yml index b5929d5f56..ffe4e66705 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-1/14.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-1/14.yml @@ -2,6 +2,7 @@ date: '2021-12-13' sections: security_fixes: - '**CRITICAL:** A remote code execution vulnerability in the Log4j library, identified as [CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228), affected all versions of {% data variables.product.prodname_ghe_server %} prior to 3.3.1. The Log4j library is used in an open source service running on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability was fixed in {% data variables.product.prodname_ghe_server %} versions 3.0.22, 3.1.14, 3.2.6, and 3.3.1. For more information, please see [this post](https://github.blog/2021-12-13-githubs-response-to-log4j-vulnerability-cve-2021-44228/) on the GitHub Blog.' + - '**December 17, 2021 update**: The fixes in place for this release also mitigate [CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046), which was published after this release. No additional upgrade for {% data variables.product.prodname_ghe_server %} is required to mitigate both CVE-2021-44228 and CVE-2021-45046.' known_issues: - The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues. - On a freshly set up {% data variables.product.prodname_ghe_server %} without any users, an attacker could create the first admin user. diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-2/6.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-2/6.yml index 03a2c3bd61..4e8d210d8c 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-2/6.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-2/6.yml @@ -3,6 +3,7 @@ date: '2021-12-13' sections: security_fixes: - '**CRITICAL:** A remote code execution vulnerability in the Log4j library, identified as [CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228), affected all versions of {% data variables.product.prodname_ghe_server %} prior to 3.3.1. The Log4j library is used in an open source service running on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability was fixed in {% data variables.product.prodname_ghe_server %} versions 3.0.22, 3.1.14, 3.2.6, and 3.3.1. For more information, please see [this post](https://github.blog/2021-12-13-githubs-response-to-log4j-vulnerability-cve-2021-44228/) on the GitHub Blog.' + - '**December 17, 2021 update**: The fixes in place for this release also mitigate [CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046), which was published after this release. No additional upgrade for {% data variables.product.prodname_ghe_server %} is required to mitigate both CVE-2021-44228 and CVE-2021-45046.' known_issues: - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。 - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-3/1.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-3/1.yml index 673a4c25bc..e7d0382371 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-3/1.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-3/1.yml @@ -3,6 +3,7 @@ date: '2021-12-13' sections: security_fixes: - '**CRITICAL:** A remote code execution vulnerability in the Log4j library, identified as [CVE-2021-44228](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228), affected all versions of {% data variables.product.prodname_ghe_server %} prior to 3.3.1. The Log4j library is used in an open source service running on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability was fixed in {% data variables.product.prodname_ghe_server %} versions 3.0.22, 3.1.14, 3.2.6, and 3.3.1. For more information, please see [this post](https://github.blog/2021-12-13-githubs-response-to-log4j-vulnerability-cve-2021-44228/) on the GitHub Blog.' + - '**December 17, 2021 update**: The fixes in place for this release also mitigate [CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046), which was published after this release. No additional upgrade for {% data variables.product.prodname_ghe_server %} is required to mitigate both CVE-2021-44228 and CVE-2021-45046.' known_issues: - After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command. - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. diff --git a/translations/ja-JP/data/reusables/actions/create-azure-app-plan.md b/translations/ja-JP/data/reusables/actions/create-azure-app-plan.md new file mode 100644 index 0000000000..76e7ee747c --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/create-azure-app-plan.md @@ -0,0 +1,17 @@ +1. Azure App Serviceプランの作成 + + たとえば、Azure CLIを使って新しいApp Serviceのプランを作成できます。 + + ```bash{:copy} + az appservice plan create \ + --resource-group MY_RESOURCE_GROUP \ + --name MY_APP_SERVICE_PLAN \ + --is-linux + ``` + + 上のコマンドで、`MY_RESOURCE_GROUP`はすでに存在するAzure Resource Groupに、`MY_APP_SERVICE_PLAN`はApp Serviceプランの新しい名前に置き換えてください。 + + [Azure CLI](https://docs.microsoft.com/cli/azure/)の使いからに関する詳しい情報については、Azureのドキュメンテーションを参照してください。 + + * For authentication, see "[Sign in with Azure CLI](https://docs.microsoft.com/cli/azure/authenticate-azure-cli)." + * 新しいリソースグループを作成しなければならない場合は、「[az group](https://docs.microsoft.com/cli/azure/group?view=azure-cli-latest#az_group_create)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/create-azure-publish-profile.md b/translations/ja-JP/data/reusables/actions/create-azure-publish-profile.md new file mode 100644 index 0000000000..b5d8d6cdad --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/create-azure-publish-profile.md @@ -0,0 +1,5 @@ +1. Azure公開プロフィールを設定して、`AZURE_WEBAPP_PUBLISH_PROFILE`シークレットを作成してください。 + + 公開されたプロフィールを使って、Azureのデプロイ資格情報を生成してください。 For more information, see "[Generate deployment credentials](https://docs.microsoft.com/azure/app-service/deploy-github-actions?tabs=applevel#generate-deployment-credentials)" in the Azure documentation. + + {% data variables.product.prodname_dotcom %}リポジトリで、公開されたプロフィールの内容を含む`AZURE_WEBAPP_PUBLISH_PROFILE`という名前のシークレットを生成してください。 シークレットの作成に関する詳しい情報については「[暗号化されたシークレット](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/docs/you-can-read-docs-for-your-product.md b/translations/ja-JP/data/reusables/docs/you-can-read-docs-for-your-product.md new file mode 100644 index 0000000000..8de7a8d98f --- /dev/null +++ b/translations/ja-JP/data/reusables/docs/you-can-read-docs-for-your-product.md @@ -0,0 +1 @@ +You can read documentation that reflects the features available to you on {% data variables.product.product_name %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md b/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md index b78499d214..534d9c25e0 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md @@ -1 +1 @@ -A user account is considered to be dormant if it has not been active for {% ifversion ghec %}90 days{% else %}at least a month{% endif %}.{% ifversion ghes %} You may choose to suspend dormant users to release user licenses.{% endif %} +{% ifversion not ghec%}By default, a{% else %}A{% endif %} user account is considered to be dormant if it has not been active for 90 days. {% ifversion not ghec %}You can configure the length of time a user must be inactive to be considered dormant{% ifversion ghes%} and choose to suspend dormant users to release user licenses{% endif %}.{% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise_migrations/locking-repositories.md b/translations/ja-JP/data/reusables/enterprise_migrations/locking-repositories.md index c21ab72811..ae6a976d40 100644 --- a/translations/ja-JP/data/reusables/enterprise_migrations/locking-repositories.md +++ b/translations/ja-JP/data/reusables/enterprise_migrations/locking-repositories.md @@ -1,6 +1,6 @@ {% tip %} -**ノート:** リポジトリをロックすると、そのリポジトリへの読み書きを防ぐことができます。 ロックされたリポジトリには、新しいTeamやコラボレータを関連づけることはできません。 +**Note:** Locking a repository prevents all write access to the repository. ロックされたリポジトリには、新しいTeamやコラボレータを関連づけることはできません。 トライアル実行をしているなら、リポジトリをロックする必要はありません。 使用中のリポジトリからデータを移行する場合、 {% data variables.product.company_short %}はそのリポジトリをロックすることを強くおすすめします。 詳細は「[移行について](/enterprise/admin/migrations/about-migrations#types-of-migrations)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/pages/check-workflow-run.md b/translations/ja-JP/data/reusables/pages/check-workflow-run.md new file mode 100644 index 0000000000..9a20b621d1 --- /dev/null +++ b/translations/ja-JP/data/reusables/pages/check-workflow-run.md @@ -0,0 +1,8 @@ +{% ifversion fpt %} +1. If your {% data variables.product.prodname_pages %} site is built from a public repository, it is built and deployed with a {% data variables.product.prodname_actions %} workflow run unless you've configured your {% data variables.product.prodname_pages %} site to use a different CI tool. For more information about how to view the workflow status, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." + +{% note %} + +{% data reusables.pages.pages-builds-with-github-actions-public-beta %} + +{% endnote %}{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/pages/pages-builds-with-github-actions-public-beta.md b/translations/ja-JP/data/reusables/pages/pages-builds-with-github-actions-public-beta.md new file mode 100644 index 0000000000..68073a7756 --- /dev/null +++ b/translations/ja-JP/data/reusables/pages/pages-builds-with-github-actions-public-beta.md @@ -0,0 +1,5 @@ +{% ifversion fpt %} + +**Note:** {% data variables.product.prodname_actions %} workflow runs for your {% data variables.product.prodname_pages %} sites are in public beta for public repositories and subject to change. {% data variables.product.prodname_actions %} workflow runs are free for public repositories. + +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/pages/twenty-minutes-to-publish.md b/translations/ja-JP/data/reusables/pages/twenty-minutes-to-publish.md index 278777b613..52a088fdc8 100644 --- a/translations/ja-JP/data/reusables/pages/twenty-minutes-to-publish.md +++ b/translations/ja-JP/data/reusables/pages/twenty-minutes-to-publish.md @@ -1 +1 @@ -**メモ:** サイトに対する変更は、その変更を{% data variables.product.product_name %}にプッシュしてから公開されるまでに、最大20分かかることがあります。 1時間経っても変更がブラウザーに反映されなければ、「[{% data variables.product.prodname_pages %}サイトのJekyllビルドエラーについて](/articles/about-jekyll-build-errors-for-github-pages-sites)」を参照してください。 +**メモ:** サイトに対する変更は、その変更を{% data variables.product.product_name %}にプッシュしてから公開されるまでに、最大10分かかることがあります。 If your don't see your {% data variables.product.prodname_pages %} site changes reflected in your browser after an hour, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)." \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/saml/saml-accounts.md b/translations/ja-JP/data/reusables/saml/saml-accounts.md index 0d33751848..7a54db723a 100644 --- a/translations/ja-JP/data/reusables/saml/saml-accounts.md +++ b/translations/ja-JP/data/reusables/saml/saml-accounts.md @@ -1 +1,7 @@ -If you configure SAML SSO, members of your organization will continue to log into their user accounts on {% data variables.product.prodname_dotcom_the_website %}. SAML SSO を使用する Organization 内のリソースにメンバーがアクセスすると、{% data variables.product.prodname_dotcom %} は認証のためにメンバーを IdP にリダイレクトします。 認証に成功すると、IdP はメンバーを {% data variables.product.prodname_dotcom %} にリダイレクトして戻し、そこでメンバーは Organization のリソースにアクセスできます。 +If you configure SAML SSO, members of your organization will continue to log into their user accounts on {% data variables.product.prodname_dotcom_the_website %}. When a member accesses non-public resources within your organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} redirects the member to your IdP to authenticate. 認証に成功すると、IdP はメンバーを {% data variables.product.prodname_dotcom %} にリダイレクトして戻し、そこでメンバーは Organization のリソースにアクセスできます。 + +{% note %} + +**Note:** Organization members can perform read operations such as viewing, cloning, and forking on public resources owned by your organization even without a valid SAML session. + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-private-repo.md index ea9ac478dc..e3205af06b 100644 --- a/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/translations/ja-JP/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -18,6 +18,8 @@ Asana | Asana Personal Access Token | asana_personal_access_token{% endif %} Atl {%- ifversion fpt or ghec or ghes > 3.1 or ghae %} Atlassian | Bitbucket Server Personal Access Token | bitbucket_server_personal_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.3 %} +Azure | Azure Active Directory Application Secret | azure_active_directory_application_secret{% endif %} +{%- ifversion fpt or ghec or ghes > 3.3 %} Azure | Azure Cache for Redis Access Key | azure_cache_for_redis_access_key{% endif %} Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token Azure | Azure SAS Token | azure_sas_token Azure | Azure Service Management Certificate | azure_management_certificate {%- ifversion ghes < 3.4 or ghae or ghae-issue-5342 %} Azure | Azure SQL Connection String | azure_sql_connection_string{% endif %} Azure | Azure Storage Account Key | azure_storage_account_key diff --git a/translations/ja-JP/data/ui.yml b/translations/ja-JP/data/ui.yml index 49f8365c77..33b23f1e1b 100644 --- a/translations/ja-JP/data/ui.yml +++ b/translations/ja-JP/data/ui.yml @@ -29,6 +29,7 @@ toc: popular: 人気 guides: ガイド whats_new: 更新情報 + videos: 動画 pages: article_version: 'Article version' miniToc: 'ここには以下の内容があります:' diff --git a/translations/ja-JP/data/variables/product.yml b/translations/ja-JP/data/variables/product.yml index 275bb4ac63..42a521b2d5 100644 --- a/translations/ja-JP/data/variables/product.yml +++ b/translations/ja-JP/data/variables/product.yml @@ -17,6 +17,7 @@ prodname_ghe_server: 'GitHub Enterprise Server' prodname_ghe_cloud: 'GitHub Enterprise Cloud' prodname_ghe_managed: 'GitHub AE' prodname_ghe_one: 'GitHub One' +prodname_docs: 'GitHub Docs' ## Use these variables when referring specifically to a location within a product product_location: >- {% ifversion ghes %}your GitHub Enterprise Server instance{% elsif ghae %}your enterprise{% else %}GitHub.com{% endif %} @@ -182,7 +183,7 @@ api_url_code: >- {% ifversion fpt or ghec %}https://api.github.com{% elsif ghes %}http(s)://[hostname]/api/v3{% elsif ghae %}https://[hostname]/api/v3{% endif %} #Use this inside command-line code blocks graphql_url_pre: >- - {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://[hostname]/api/graphql{% elsif ghae %}https://api.[hostname]/graphql{% endif %} + {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://[hostname]/api/graphql{% elsif ghae %}https://[hostname]/api/graphql{% endif %} #Use this all other code blocks graphql_url_code: >- - {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://[hostname]/api/graphql{% elsif ghae %}https://api.[hostname]/graphql{% endif %} + {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://[hostname]/api/graphql{% elsif ghae %}https://[hostname]/api/graphql{% endif %} diff --git a/translations/log/ja-resets.csv b/translations/log/ja-resets.csv index 0ae055f949..84ac5ae748 100644 --- a/translations/log/ja-resets.csv +++ b/translations/log/ja-resets.csv @@ -62,8 +62,17 @@ translations/ja-JP/content/actions/creating-actions/setting-exit-codes-for-actio translations/ja-JP/content/actions/deployment/about-deployments/about-continuous-deployment.md,rendering error translations/ja-JP/content/actions/deployment/about-deployments/deploying-with-github-actions.md,rendering error translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-amazon-elastic-container-service.md,rendering error -translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure-app-service.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/index.md,rendering error translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-google-kubernetes-engine.md,rendering error +translations/ja-JP/content/actions/deployment/deploying-to-your-cloud-provider/index.md,rendering error translations/ja-JP/content/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md,rendering error translations/ja-JP/content/actions/deployment/index.md,rendering error translations/ja-JP/content/actions/deployment/managing-your-deployments/viewing-deployment-history.md,rendering error @@ -228,6 +237,7 @@ translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-s translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md,rendering error translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md,rendering error translations/ja-JP/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md,rendering error +translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md,rendering error translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md,rendering error translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md,rendering error translations/ja-JP/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md,rendering error @@ -262,6 +272,7 @@ translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-ser translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-vmware.md,rendering error translations/ja-JP/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-xenserver.md,rendering error translations/ja-JP/content/admin/overview/about-enterprise-accounts.md,rendering error +translations/ja-JP/content/admin/overview/about-github-ae.md,rendering error translations/ja-JP/content/admin/overview/about-the-github-enterprise-api.md,rendering error translations/ja-JP/content/admin/overview/about-upgrades-to-new-releases.md,rendering error translations/ja-JP/content/admin/overview/system-overview.md,rendering error @@ -473,13 +484,22 @@ translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/set translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md,rendering error translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md,rendering error translations/ja-JP/content/communities/documenting-your-project-with-wikis/about-wikis.md,rendering error +translations/ja-JP/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md,rendering error +translations/ja-JP/content/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md,rendering error +translations/ja-JP/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md,rendering error +translations/ja-JP/content/communities/documenting-your-project-with-wikis/index.md,rendering error translations/ja-JP/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md,rendering error translations/ja-JP/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md,rendering error +translations/ja-JP/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md,rendering error translations/ja-JP/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md,rendering error +translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md,rendering error translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md,Listed in localization-support#489 translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md,rendering error +translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/index.md,rendering error translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md,rendering error translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md,rendering error +translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/index.md,rendering error +translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md,rendering error translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md,rendering error translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md,rendering error translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md,rendering error @@ -491,11 +511,18 @@ translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/ins translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,rendering error translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md,rendering error translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/overview/keyboard-shortcuts.md,rendering error +translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md,rendering error translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md,rendering error translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md,rendering error +translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app.md,rendering error translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md,rendering error +translations/ja-JP/content/developers/apps/building-github-apps/index.md,rendering error +translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md,rendering error translations/ja-JP/content/developers/apps/building-github-apps/refreshing-user-to-server-access-tokens.md,rendering error +translations/ja-JP/content/developers/apps/building-github-apps/setting-permissions-for-github-apps.md,rendering error translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md,rendering error +translations/ja-JP/content/developers/apps/building-oauth-apps/creating-an-oauth-app.md,rendering error +translations/ja-JP/content/developers/apps/building-oauth-apps/index.md,rendering error translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md,rendering error translations/ja-JP/content/developers/apps/getting-started-with-apps/about-apps.md,rendering error translations/ja-JP/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md,rendering error @@ -504,14 +531,45 @@ translations/ja-JP/content/developers/apps/getting-started-with-apps/migrating-o translations/ja-JP/content/developers/apps/guides/creating-ci-tests-with-the-checks-api.md,rendering error translations/ja-JP/content/developers/apps/guides/using-content-attachments.md,rendering error translations/ja-JP/content/developers/apps/guides/using-the-github-api-in-your-app.md,rendering error +translations/ja-JP/content/developers/apps/index.md,rendering error +translations/ja-JP/content/developers/apps/managing-github-apps/deleting-a-github-app.md,rendering error +translations/ja-JP/content/developers/apps/managing-github-apps/editing-a-github-apps-permissions.md,rendering error +translations/ja-JP/content/developers/apps/managing-github-apps/index.md,rendering error translations/ja-JP/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md,rendering error +translations/ja-JP/content/developers/apps/managing-github-apps/modifying-a-github-app.md,rendering error +translations/ja-JP/content/developers/apps/managing-github-apps/transferring-ownership-of-a-github-app.md,rendering error +translations/ja-JP/content/developers/apps/managing-oauth-apps/deleting-an-oauth-app.md,rendering error +translations/ja-JP/content/developers/apps/managing-oauth-apps/index.md,rendering error +translations/ja-JP/content/developers/apps/managing-oauth-apps/modifying-an-oauth-app.md,rendering error +translations/ja-JP/content/developers/apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app.md,rendering error +translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-authorization-request-errors.md,rendering error +translations/ja-JP/content/developers/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors.md,rendering error +translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app.md,rendering error +translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/security-best-practices-for-apps.md,rendering error +translations/ja-JP/content/developers/github-marketplace/creating-apps-for-github-marketplace/viewing-metrics-for-your-listing.md,rendering error translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md,rendering error translations/ja-JP/content/developers/github-marketplace/github-marketplace-overview/index.md,rendering error +translations/ja-JP/content/developers/github-marketplace/index.md,rendering error +translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md,rendering error +translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md,rendering error +translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/index.md,rendering error +translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing.md,rendering error +translations/ja-JP/content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md,rendering error +translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/billing-customers.md,rendering error +translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/index.md,rendering error translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps.md,rendering error translations/ja-JP/content/developers/github-marketplace/selling-your-app-on-github-marketplace/receiving-payment-for-app-purchases.md,rendering error translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md,rendering error +translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-cancellations.md,rendering error +translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes.md,rendering error +translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/index.md,rendering error +translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md,rendering error +translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md,rendering error +translations/ja-JP/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api.md,rendering error translations/ja-JP/content/developers/overview/managing-deploy-keys.md,rendering error +translations/ja-JP/content/developers/overview/replacing-github-services.md,rendering error translations/ja-JP/content/developers/overview/secret-scanning-partner-program.md,rendering error +translations/ja-JP/content/developers/overview/using-ssh-agent-forwarding.md,rendering error translations/ja-JP/content/developers/webhooks-and-events/events/issue-event-types.md,rendering error translations/ja-JP/content/developers/webhooks-and-events/webhooks/about-webhooks.md,rendering error translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md,rendering error @@ -544,11 +602,16 @@ translations/ja-JP/content/get-started/getting-started-with-git/updating-credent translations/ja-JP/content/get-started/index.md,rendering error translations/ja-JP/content/get-started/learning-about-github/about-github-advanced-security.md,Listed in localization-support#489 translations/ja-JP/content/get-started/learning-about-github/about-github-advanced-security.md,parsing error +translations/ja-JP/content/get-started/learning-about-github/about-versions-of-github-docs.md,rendering error translations/ja-JP/content/get-started/learning-about-github/access-permissions-on-github.md,rendering error translations/ja-JP/content/get-started/learning-about-github/githubs-products.md,rendering error translations/ja-JP/content/get-started/learning-about-github/index.md,rendering error translations/ja-JP/content/get-started/learning-about-github/types-of-github-accounts.md,rendering error +translations/ja-JP/content/get-started/onboarding/getting-started-with-github-ae.md,rendering error translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md,rendering error +translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-server.md,rendering error +translations/ja-JP/content/get-started/onboarding/getting-started-with-github-team.md,rendering error +translations/ja-JP/content/get-started/onboarding/getting-started-with-your-github-account.md,rendering error translations/ja-JP/content/get-started/quickstart/be-social.md,rendering error translations/ja-JP/content/get-started/quickstart/communicating-on-github.md,rendering error translations/ja-JP/content/get-started/quickstart/create-a-repo.md,rendering error @@ -622,11 +685,23 @@ translations/ja-JP/content/graphql/guides/migrating-graphql-global-node-ids.md,r translations/ja-JP/content/graphql/index.md,rendering error translations/ja-JP/content/graphql/reference/mutations.md,rendering error translations/ja-JP/content/issues/guides.md,rendering error +translations/ja-JP/content/issues/index.md,rendering error +translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md,rendering error +translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md,rendering error +translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md,rendering error +translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md,rendering error +translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md,rendering error +translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md,rendering error +translations/ja-JP/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md,rendering error +translations/ja-JP/content/issues/tracking-your-work-with-issues/about-issues.md,rendering error translations/ja-JP/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md,rendering error +translations/ja-JP/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md,rendering error translations/ja-JP/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md,rendering error translations/ja-JP/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md,rendering error translations/ja-JP/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md,rendering error translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/about-milestones.md,rendering error +translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md,rendering error +translations/ja-JP/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md,rendering error translations/ja-JP/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md,rendering error translations/ja-JP/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md,rendering error translations/ja-JP/content/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.md,rendering error @@ -709,23 +784,43 @@ translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pag translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md,rendering error translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md,rendering error translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md,rendering error +translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md,rendering error translations/ja-JP/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md,rendering error +translations/ja-JP/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md,rendering error +translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md,rendering error +translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md,rendering error +translations/ja-JP/content/pages/getting-started-with-github-pages/index.md,rendering error +translations/ja-JP/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md,rendering error +translations/ja-JP/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md,rendering error translations/ja-JP/content/pages/index.md,rendering error translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md,rendering error translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md,rendering error translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md,rendering error +translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md,rendering error +translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/index.md,rendering error translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md,rendering error +translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md,rendering error translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/index.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/index.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/getting-started/index.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/index.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/index.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/index.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/index.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md,rendering error translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/working-with-forks/index.md,rendering error @@ -785,13 +880,19 @@ translations/ja-JP/content/repositories/working-with-files/managing-large-files/ translations/ja-JP/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md,rendering error translations/ja-JP/content/repositories/working-with-files/using-files/navigating-code-on-github.md,rendering error translations/ja-JP/content/repositories/working-with-files/using-files/tracking-changes-in-a-file.md,rendering error +translations/ja-JP/content/rest/guides/best-practices-for-integrators.md,rendering error +translations/ja-JP/content/rest/guides/building-a-ci-server.md,rendering error +translations/ja-JP/content/rest/guides/delivering-deployments.md,rendering error translations/ja-JP/content/rest/guides/discovering-resources-for-a-user.md,rendering error translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md,rendering error translations/ja-JP/content/rest/guides/index.md,rendering error +translations/ja-JP/content/rest/guides/rendering-data-as-graphs.md,rendering error translations/ja-JP/content/rest/guides/traversing-with-pagination.md,rendering error translations/ja-JP/content/rest/guides/working-with-comments.md,rendering error translations/ja-JP/content/rest/index.md,rendering error translations/ja-JP/content/rest/overview/api-previews.md,rendering error +translations/ja-JP/content/rest/overview/libraries.md,rendering error +translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md,rendering error translations/ja-JP/content/rest/reference/actions.md,rendering error translations/ja-JP/content/rest/reference/activity.md,rendering error translations/ja-JP/content/rest/reference/branches.md,rendering error @@ -814,6 +915,8 @@ translations/ja-JP/content/rest/reference/teams.md,rendering error translations/ja-JP/content/rest/reference/webhooks.md,rendering error translations/ja-JP/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md,rendering error translations/ja-JP/content/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment.md,rendering error +translations/ja-JP/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md,rendering error +translations/ja-JP/content/search-github/index.md,rendering error translations/ja-JP/content/search-github/searching-on-github/searching-commits.md,rendering error translations/ja-JP/content/search-github/searching-on-github/searching-discussions.md,rendering error translations/ja-JP/content/search-github/searching-on-github/searching-for-repositories.md,rendering error