diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index beb264a264..494eac3b3f 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -48,7 +48,7 @@ The repository owner has full control of the repository. In addition to the acti | Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" | | Manage data use for a private repository | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"|{% endif %} | Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | -| Archive the repository | "[About archiving repositories](/github/creating-cloning-and-archiving-repositories/about-archiving-repositories)" |{% ifversion fpt %} +| Archive the repository | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt %} | Create security advisories | "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" | | Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 %} | Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | {% endif %} diff --git a/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md b/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md index 28d83bb82f..fcb7ebb0dc 100644 --- a/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md +++ b/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md @@ -9,7 +9,7 @@ shortTitle: Approve public fork runs ## About workflow runs from public forks -{% data reusables.actions.workflow-run-approve-public-fork %} However, you can configure this behavior for a [repository](/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account#configuring-required-approval-for-workflows-from-public-forks). +{% data reusables.actions.workflow-run-approve-public-fork %} However, you can configure this behavior for a [repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account#configuring-required-approval-for-workflows-from-public-forks). Workflow runs that have been awaiting approval for more than 30 days are automatically deleted. diff --git a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index 5330e6bd3d..fb3accb468 100644 --- a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -13,7 +13,7 @@ shortTitle: Download workflow artifacts {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -{% ifversion fpt or ghes > 2.22 or ghae %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Configuring the retention period for GitHub Actions artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} +{% ifversion fpt or ghes > 2.22 or ghae %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} {% ifversion ghes = 2.22 %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %} {% data reusables.repositories.permissions-statement-read %} diff --git a/content/actions/reference/authentication-in-a-workflow.md b/content/actions/reference/authentication-in-a-workflow.md index ebaa65a81a..770e1fb7cd 100644 --- a/content/actions/reference/authentication-in-a-workflow.md +++ b/content/actions/reference/authentication-in-a-workflow.md @@ -97,7 +97,7 @@ jobs: For information about the API endpoints {% data variables.product.prodname_github_apps %} can access with each permission, see "[{% data variables.product.prodname_github_app %} Permissions](/rest/reference/permissions-required-for-github-apps)." {% ifversion fpt or ghes > 3.1 or ghae-next %} -The following table shows the permissions granted to the `GITHUB_TOKEN` by default. People with admin permissions to an {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository{% endif %} can set the default permissions to be either permissive or restricted. For information on how to set the default permissions for the `GITHUB_TOKEN` for your {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository,{% endif %} see {% ifversion not ghes %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account#setting-the-permissions-of-the-github_token-for-your-enterprise)," {% endif %}"[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)," or "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#setting-the-permissions-of-the-github_token-for-a-repository)." +The following table shows the permissions granted to the `GITHUB_TOKEN` by default. People with admin permissions to an {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository{% endif %} can set the default permissions to be either permissive or restricted. For information on how to set the default permissions for the `GITHUB_TOKEN` for your {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository,{% endif %} see {% ifversion not ghes %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account#setting-the-permissions-of-the-github_token-for-your-enterprise)," {% endif %}"[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)," or "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." | Scope | Default access
(permissive) | Default access
(restricted) | Maximum access
by forked repos | |---------------|-----------------------------|-----------------------------|--------------------------------| diff --git a/content/actions/reference/usage-limits-billing-and-administration.md b/content/actions/reference/usage-limits-billing-and-administration.md index 2d62f6b455..c0f7a0439b 100644 --- a/content/actions/reference/usage-limits-billing-and-administration.md +++ b/content/actions/reference/usage-limits-billing-and-administration.md @@ -69,9 +69,9 @@ You can configure the artifact and log retention period for your repository, org For more information, see: -- [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository) -- [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization) -- [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your enterprise](/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account) +- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)" +- "[Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)" +- "[Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your enterprise](/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account)" {% endif %} ## Disabling or limiting {% data variables.product.prodname_actions %} for your repository or organization @@ -79,7 +79,7 @@ For more information, see: {% data reusables.github-actions.disabling-github-actions %} For more information, see: -- "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository)" +- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)" - "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)"{% ifversion fpt %} - "[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)" for {% data variables.product.prodname_ghe_cloud %}{% endif %} diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 8c7f036664..ae11de4494 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -38,7 +38,7 @@ shortTitle: Enforce repository policies --- ## Configuring the default visibility of new repositories in your enterprise -Each time someone creates a new repository on your enterprise, that person must choose a visibility for the repository. When you configure a default visibility setting for the enterprise, you choose which visibility is selected by default. For more information on repository visibility, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +Each time someone creates a new repository on your enterprise, that person must choose a visibility for the repository. When you configure a default visibility setting for the enterprise, you choose which visibility is selected by default. For more information on repository visibility, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." If an enterprise owner disallows members from creating certain types of repositories, members will not be able to create that type of repository even if the visibility setting defaults to that type. For more information, see "[Setting a policy for repository creation](#setting-a-policy-for-repository-creation)." diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md index d4985d4904..9b74d60545 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md @@ -83,7 +83,7 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when | Value | Action | More information | | :- | :- | :- | | 
auto-merge deployment api
| Automatic merge of the base branch via a deployment created with the API | "[Repositories](/rest/reference/repos#create-a-deployment)" in the REST API documentation | -| 
blob#save
| Change to a file's contents in the web interface | "[Editing files in your repository](/github/managing-files-in-a-repository/editing-files-in-your-repository)" | +| 
blob#save
| Change to a file's contents in the web interface | "[Editing files](/repositories/working-with-files/managing-files/editing-files)" | | 
branch merge api
| Merge of a branch via the API | "[Repositories](/rest/reference/repos#merge-a-branch)" in the REST API documentation | | 
branches page delete button
| Deletion of a branch in the web interface | "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" | | 
git refs create api
| Creation of a ref via the API | "[Git database](/rest/reference/git#create-a-reference)" in the REST API documentation | diff --git a/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md b/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md index ca2768fff6..27d9546f4b 100644 --- a/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md +++ b/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md @@ -18,7 +18,7 @@ shortTitle: Internal repository migration --- ## About internal repositories -Internal repositories are available in {% data variables.product.prodname_ghe_server %} 2.20+. {% data reusables.repositories.about-internal-repos %} For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)." +Internal repositories are available in {% data variables.product.prodname_ghe_server %} 2.20+. {% data reusables.repositories.about-internal-repos %} For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." In future releases of {% data variables.product.prodname_ghe_server %}, we will adjust how repository visibility works so that the terms public, internal, and private have a uniform meaning for developers on {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 58ba599b89..8a9e0a2ee9 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -77,7 +77,7 @@ If you scan on push, then the results appear in the **Security** tab for your re ### Scanning pull requests -The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% ifversion ghes %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} +The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% ifversion ghes %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)." diff --git a/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md b/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md index 968cd042eb..f0d51b2bf8 100644 --- a/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md +++ b/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md @@ -47,7 +47,7 @@ Anyone with write permissions to a security advisory can add changes to a tempor 4. In the "Security Advisories" list, click the security advisory you'd like to add changes to. ![Security advisory in list](/assets/images/help/security/security-advisory-in-list.png) 5. Add your changes on {% data variables.product.product_name %} or locally: - - To add changes on {% data variables.product.product_name %}, under "Add changes to this advisory", click **the temporary private fork**. Then, create a new branch and edit files. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)" and "[Editing files in your repository](/articles/editing-files-in-your-repository)." + - To add changes on {% data variables.product.product_name %}, under "Add changes to this advisory", click **the temporary private fork**. Then, create a new branch and edit files. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)" and "[Editing files](/repositories/working-with-files/managing-files/editing-files)." - To add changes locally, follow the instructions under "Clone and create a new branch" and "Make your changes, then push." ![Add changes to this advisory box](/assets/images/help/security/add-changes-to-this-advisory-box.png) diff --git a/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md b/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md index 678792dc3f..abf03de104 100644 --- a/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md +++ b/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md @@ -35,7 +35,7 @@ You can check the current service status on the [Status Dashboard](https://www.g ## Option 3: Clone the repository locally or edit in the browser -While {% data variables.product.prodname_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see [Editing files in your repository](/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository). +While {% data variables.product.prodname_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve. diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index f26ead15f2..0bde988f1e 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -40,7 +40,7 @@ You can create default contribution guidelines for your organization{% ifversion {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Rendering differences in prose documents](/github/managing-files-in-a-repository/rendering-differences-in-prose-documents)." +3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." ![New file name](/assets/images/help/repository/new-file-name.png) - To make your contributing guidelines visible in the repository's root directory, type *CONTRIBUTING*. - To make your contributing guidelines visible in the repository's `docs` directory, type *docs/* to create the new directory, then *CONTRIBUTING*. diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 4cffb9f65a..0206d63b67 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -127,7 +127,7 @@ You can see the teams that are working on or have submitted an assignment in the ## Next steps -- After you create the assignment and your students form teams, team members can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and the team can review the commit history for the repository. For more information, see "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)," "[Creating, cloning, and archiving repositories](/github/creating-cloning-and-archiving-repositories)," "[Using Git](/github/getting-started-with-github/using-git)," and "[Collaborating with issues and pull requests](/github/collaborating-with-issues-and-pull-requests)," and the free course on [managing merge conflicts](https://lab.github.com/githubtraining/managing-merge-conflicts) from {% data variables.product.prodname_learning %}. +- After you create the assignment and your students form teams, team members can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and the team can review the commit history for the repository. For more information, see "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)," "[Repositories](/repositories)," "[Using Git](/github/getting-started-with-github/using-git)," and "[Collaborating with issues and pull requests](/github/collaborating-with-issues-and-pull-requests)," and the free course on [managing merge conflicts](https://lab.github.com/githubtraining/managing-merge-conflicts) from {% data variables.product.prodname_learning %}. - When a team finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand how the team collaborated. For more information, see "[Visualizing repository data with graphs](/github/visualizing-repository-data-with-graphs)." diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md index 4f0b38850d..de52eecf56 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md @@ -107,7 +107,7 @@ You can see whether a student has joined the classroom and accepted or submitted ## Next steps -- Once you create the assignment, students can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and student can review the commit history for the repository. For more information, see "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)," "[Creating, cloning, and archiving repositories](/github/creating-cloning-and-archiving-repositories)," "[Using Git](/github/getting-started-with-github/using-git)," and "[Collaborating with issues and pull requests](/github/collaborating-with-issues-and-pull-requests)." +- Once you create the assignment, students can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and student can review the commit history for the repository. For more information, see "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)," "[Repositories](/repositories)," and "[Collaborating with issues and pull requests](/github/collaborating-with-issues-and-pull-requests)." - When a student finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand the student's work. For more information, see "[Visualizing repository data with graphs](/github/visualizing-repository-data-with-graphs)." diff --git a/content/get-started/quickstart/set-up-git.md b/content/get-started/quickstart/set-up-git.md index b71911292d..a984e7652e 100644 --- a/content/get-started/quickstart/set-up-git.md +++ b/content/get-started/quickstart/set-up-git.md @@ -33,7 +33,7 @@ If you don't need to work with files locally, {% data variables.product.product_ - [Creating a repository](/articles/create-a-repo) - [Forking a repository](/articles/fork-a-repo) -- [Managing files](/articles/managing-files-on-github/) +- [Managing files](/repositories/working-with-files/managing-files) - [Being social](/articles/be-social) ## Setting up Git diff --git a/content/get-started/using-github/keyboard-shortcuts.md b/content/get-started/using-github/keyboard-shortcuts.md index 2d0afc97df..b1ff417d28 100644 --- a/content/get-started/using-github/keyboard-shortcuts.md +++ b/content/get-started/using-github/keyboard-shortcuts.md @@ -92,7 +92,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr | Keyboard shortcut | Description |-----------|------------ |c | Create an issue -| control / or command / | Focus your cursor on the issues or pull requests search bar. For more information, see "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)."|| +| control / or command / | Focus your cursor on the issues or pull requests search bar. For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."|| |u | Filter by author |l | Filter by or edit labels. For more information, see "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)." | alt and click | While filtering by labels, exclude labels. For more information, see "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)." diff --git a/content/get-started/using-github/troubleshooting-connectivity-problems.md b/content/get-started/using-github/troubleshooting-connectivity-problems.md index 14f4503358..e625ba58fe 100644 --- a/content/get-started/using-github/troubleshooting-connectivity-problems.md +++ b/content/get-started/using-github/troubleshooting-connectivity-problems.md @@ -29,7 +29,7 @@ If you're unable to verify with the captcha: ## Switching cloning methods -Switching from cloning via SSH to cloning via HTTPS, or vice versa may improve connectivity. For more information, see "[Cloning a repository from {% data variables.product.prodname_dotcom %}](/articles/cloning-a-repository-from-github)." +Switching from cloning via SSH to cloning via HTTPS, or vice versa may improve connectivity. For more information, see "[Troubleshooting cloning errors](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)." If you're encountering timeouts with SSH, see "[Error: Bad file number](/articles/error-bad-file-number)." diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees.md b/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees.md deleted file mode 100644 index f20d55f775..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Filtering issues and pull requests by assignees -intro: 'Once you''ve [assigned an issue or pull request to someone](/articles/assigning-issues-and-pull-requests-to-other-github-users), you can find items based on who''s working on them.' -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees - - /articles/filtering-issues-and-pull-requests-by-assignees - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Filter by assignee ---- -{% data reusables.cli.filter-issues-and-pull-requests-tip %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -3. In the upper-right corner, select the Assignee drop-down menu. -4. The Assignee drop-down menu lists everyone who has write access to your repository. Click the name of the person whose assigned items you want to see, or click **Assigned to nobody** to see which issues are unassigned. -![Using the Assignees drop-down tab](/assets/images/help/issues/issues_assignee_dropdown.png) - -{% tip %} - -To clear your filter selection, click **Clear current search query, filters, and sorts**. - -{% endtip %} - -## Further reading - -- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" -- "[Viewing all of your issues and pull requests](/articles/viewing-all-of-your-issues-and-pull-requests)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels.md b/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels.md deleted file mode 100644 index 0cadc973c3..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Filtering issues and pull requests by labels -intro: 'Once you''ve [applied labels to an issue or pull request](/articles/applying-labels-to-issues-and-pull-requests), you can find items based on their labels.' -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels - - /articles/filtering-issues-and-pull-requests-by-labels - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Filter by labels ---- -{% data reusables.cli.filter-issues-and-pull-requests-tip %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.labels %} -4. In the list of labels, click a label to see the issues and pull requests that it's been applied to. - ![List of a repository's labels](/assets/images/help/issues/labels-page.png) - -{% tip %} - -**Tip:** To clear your filter selection, click **Clear current search query, filters, and sorts**. - -{% endtip %} - -## Further reading - -- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests.md b/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests.md deleted file mode 100644 index de78b2aaf2..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Filtering issues and pull requests -intro: Issues and pull requests come with a set of default filters you can apply to organize your listings. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests - - /articles/filtering-issues-and-pull-requests - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Filter issues & PRs ---- -{% data reusables.search.requested_reviews_search %} - -You can filter issues and pull requests to find: -- All open issues and pull requests -- Issues and pull requests that you've created -- Issues and pull requests that are assigned to you -- Issues and pull requests where you're [**@mentioned**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) - -{% data reusables.cli.filter-issues-and-pull-requests-tip %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -3. Click **Filters** to choose the type of filter you're interested in. - ![Using the Filters drop-down](/assets/images/help/issues/issues_filter_dropdown.png) - -## Further reading - -- "[Filtering issues and pull requests by assignees](/articles/filtering-issues-and-pull-requests-by-assignees)" -- "[Filtering issues and pull requests by milestones](/articles/filtering-issues-and-pull-requests-by-milestone)" -- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)" -- "[Filtering pull requests by review status](/articles/filtering-pull-requests-by-review-status)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" -- "[Viewing all of your issues and pull requests](/articles/viewing-all-of-your-issues-and-pull-requests)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status.md b/content/github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status.md deleted file mode 100644 index 5c1ae09636..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Filtering pull requests by review status -intro: You can use filters to list pull requests by review status and to find pull requests that you've reviewed or other people have asked you to review. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-pull-requests-by-review-status - - /articles/filtering-pull-requests-by-review-status - - /github/managing-your-work-on-github/filtering-pull-requests-by-review-status -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Filter by review status ---- -You can filter a repository's list of pull requests to find: -- Pull requests that haven't been [reviewed](/articles/about-pull-request-reviews) yet -- Pull requests that [require a review](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged -- Pull requests that a reviewer has approved -- Pull requests in which a reviewer has asked for changes -- Pull requests that you have reviewed -- Pull requests that [someone has asked you, or a team you're a member of, to review](/articles/requesting-a-pull-request-review) - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-pr %} -3. In the upper-right corner, select the Reviews drop-down menu. - ![Reviews drop-down menu in the filter menu above the list of pull requests](/assets/images/help/pull_requests/reviews-filter-dropdown.png) -4. Choose a filter to find all of the pull requests with that filter's status. - ![List of filters in the Reviews drop-down menu](/assets/images/help/pull_requests/pr-review-filters.png) - -## Further reading - -- "[About pull request reviews](/articles/about-pull-request-reviews)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Viewing all of your issues and pull requests](/articles/viewing-all-of-your-issues-and-pull-requests)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/index.md b/content/github/administering-a-repository/finding-information-in-a-repository/index.md deleted file mode 100644 index 61dce22145..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Finding information in a repository -intro: 'To find detailed information about a repository on GitHub, you can filter, sort, and search issues and pull requests that are relevant to the repository.' -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/ - - /articles/finding-information-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -children: - - /filtering-issues-and-pull-requests - - /filtering-issues-and-pull-requests-by-assignees - - /filtering-issues-and-pull-requests-by-labels - - /filtering-pull-requests-by-review-status - - /sorting-issues-and-pull-requests - - /using-search-to-filter-issues-and-pull-requests - - /sharing-filters -shortTitle: Find information in a repo ---- - diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/sharing-filters.md b/content/github/administering-a-repository/finding-information-in-a-repository/sharing-filters.md deleted file mode 100644 index e838f4dfe6..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/sharing-filters.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Sharing filters -intro: 'When you filter or sort issues and pull requests, your browser''s URL is automatically updated to match the new view.' -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/sharing-filters - - /articles/sharing-filters - - /github/managing-your-work-on-github/sharing-filters -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests ---- -You can send the URL that issues generates to any user, and they'll be able to see the same filter view that you see. - -For example, if you filter on issues assigned to Hubot, and sort on the oldest open issues, your URL would update to something like the following: - -``` -/issues?q=state:open+type:issue+assignee:hubot+sort:created-asc -``` - -## Further reading - -* "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -* "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -* "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests.md b/content/github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests.md deleted file mode 100644 index 5174f81923..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Sorting issues and pull requests -intro: Filters can be sorted to provide better information during a specific time period. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/sorting-issues-and-pull-requests - - /articles/sorting-issues-and-pull-requests - - /github/managing-your-work-on-github/sorting-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Sort issues & PRs ---- -You can sort any filtered view by: - -* The newest created issues or pull requests -* The oldest created issues or pull requests -* The most commented issues or pull requests -* The least commented issues or pull requests -* The newest updated issues or pull requests -* The oldest updated issues or pull requests -* The most added reaction on issues or pull requests - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. In the upper-right corner, select the Sort drop-down menu. - ![Using the Sort drop-down tab](/assets/images/help/issues/issues_sort_dropdown.png) - -To clear your sort selection, click **Sort** > **Newest**. - -## Further reading - -* "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -* "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -* "[Sharing filters](/articles/sharing-filters)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests.md b/content/github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests.md deleted file mode 100644 index f01989b0c9..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: Using search to filter issues and pull requests -intro: You can use advanced filters to search for issues and pull requests that meet specific criteria. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests - - /articles/using-search-to-filter-issues-and-pull-requests - - /github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Use search to filter ---- - -## Searching for issues and pull requests - -{% include tool-switcher %} - -{% webui %} - -The issues and pull requests search bar allows you to define your own custom filters and sort by a wide variety of criteria. You can find the search bar on each repository's **Issues** and **Pull requests** tabs and on your [Issues and Pull requests dashboards](/articles/viewing-all-of-your-issues-and-pull-requests). - -![The issues and pull requests search bar](/assets/images/help/issues/issues_search_bar.png) - -{% tip %} - -**Tip:** {% data reusables.search.search_issues_and_pull_requests_shortcut %} - -{% endtip %} - -{% endwebui %} - -{% cli %} - -{% data reusables.cli.cli-learn-more %} - -You can use the {% data variables.product.prodname_cli %} to search for issues or pull requests. Use the `gh issue list` or `gh pr list` subcommand along with the `--search` argument and a search query. - -For example, you can list, in order of date created, all issues that have no assignee and that have the label `help wanted` or `bug`. - -```shell -gh issue list --search 'no:assignee label:"help wanted",bug sort:created-asc' -``` - -You can also list all pull requests that mention the `octo-org/octo-team` team. - -```shell -gh pr list --search "team:octo-org/octo-team" -``` - -{% endcli %} - -## About search terms - -With issue and pull request search terms, you can: - -- Filter issues and pull requests by author: `state:open type:issue author:octocat` -- Filter issues and pull requests that involve, but don't necessarily [**@mention**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), certain people: `state:open type:issue involves:octocat` -- Filter issues and pull requests by assignee: `state:open type:issue assignee:octocat` -- Filter issues and pull requests by label: `state:open type:issue label:"bug"` -- Filter out search terms by using `-` before the term: `state:open type:issue -author:octocat` - -{% ifversion fpt or ghes > 3.2 or ghae-next %} -{% tip %} - -**Tip:** You can filter issues and pull requests by label using logical OR or using logical AND. -- To filter issues using logical OR, use the comma syntax: `label:"bug","wip"`. -- To filter issues using logical AND, use separate label filters: `label:"bug" label:"wip"`. - -{% endtip %} -{% endif %} - -{% ifversion fpt or ghes or ghae %} -For issues, you can also use search to: - -- Filter for issues that are linked to a pull request by a closing reference: `linked:pr` -{% endif %} - -For pull requests, you can also use search to: -- Filter [draft](/articles/about-pull-requests#draft-pull-requests) pull requests: `is:draft` -- Filter pull requests that haven't been [reviewed](/articles/about-pull-request-reviews) yet: `state:open type:pr review:none` -- Filter pull requests that [require a review](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged: `state:open type:pr review:required` -- Filter pull requests that a reviewer has approved: `state:open type:pr review:approved` -- Filter pull requests in which a reviewer has asked for changes: `state:open type:pr review:changes_requested` -- Filter pull requests by [reviewer](/articles/about-pull-request-reviews/): `state:open type:pr reviewed-by:octocat` -- Filter pull requests by the specific user [requested for review](/articles/requesting-a-pull-request-review): `state:open type:pr review-requested:octocat` -- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom`{% ifversion fpt or ghes or ghae %} -- Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue`{% endif %} - -{% note %} - -**Note:** {% data reusables.pull_requests.large-search-workaround %} You can limit your search with the `org:`, `user:`, or `repo:` qualifiers. For more information, see "[Searching issues and pull requests](/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-within-a-users-or-organizations-repositories)." - -{% endnote %} - - - -## Further reading - -- "[Searching issues and pull requests](/articles/searching-issues)" -- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" diff --git a/content/github/administering-a-repository/index.md b/content/github/administering-a-repository/index.md deleted file mode 100644 index e8d09a42a4..0000000000 --- a/content/github/administering-a-repository/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Administering a repository -redirect_from: - - /categories/administering-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /managing-repository-settings - - /managing-branches-in-your-repository - - /configuring-pull-request-merges - - /defining-the-mergeability-of-pull-requests - - /releasing-projects-on-github - - /finding-information-in-a-repository -shortTitle: Administer a repo ---- - diff --git a/content/github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md b/content/github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md deleted file mode 100644 index 4ef4f3f7c7..0000000000 --- a/content/github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Configuring the retention period for GitHub Actions artifacts and logs in your repository -intro: 'You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository.' -versions: - fpt: '*' - ghes: '>=3.0' - ghae: '*' -topics: - - Repositories -redirect_from: - - /github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository -shortTitle: Set log retention for Actions ---- -{% data reusables.actions.about-artifact-log-retention %} - -You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)." - -## Setting the retention period for a repository - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.repositories.settings-sidebar-actions %} -{% data reusables.github-actions.change-retention-period-for-artifacts-logs %} diff --git a/content/github/administering-a-repository/managing-repository-settings/index.md b/content/github/administering-a-repository/managing-repository-settings/index.md deleted file mode 100644 index c546e59435..0000000000 --- a/content/github/administering-a-repository/managing-repository-settings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Managing repository settings -intro: 'Repository administrators and organization owners can change settings for a repository, like the name, ownership, and visibility, or delete the repository.' -redirect_from: - - /articles/managing-repository-settings -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /setting-repository-visibility - - /managing-teams-and-people-with-access-to-your-repository - - /classifying-your-repository-with-topics - - /customizing-how-changed-files-appear-on-github - - /about-email-notifications-for-pushes-to-your-repository - - /displaying-a-sponsor-button-in-your-repository - - /customizing-your-repositorys-social-media-preview - - /viewing-deployment-activity-for-your-repository - - /managing-the-forking-policy-for-your-repository - - /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository - - /disabling-or-limiting-github-actions-for-a-repository - - /enabling-or-disabling-github-discussions-for-a-repository - - /disabling-project-boards-in-a-repository - - /disabling-issues - - /managing-git-lfs-objects-in-archives-of-your-repository - - /managing-security-and-analysis-settings-for-your-repository - - /enabling-anonymous-git-read-access-for-a-repository - - /configuring-autolinks-to-reference-external-resources - - /renaming-a-repository - - /transferring-a-repository - - /deleting-a-repository - - /restoring-a-deleted-repository -shortTitle: Manage repository settings ---- - diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index b7098039b2..e2e65ab0a5 100644 --- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -18,7 +18,7 @@ shortTitle: Remove sensitive data --- The `git filter-repo` tool and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository. -You can remove the file from the latest commit with `git rm`. For information on removing a file that was added with the latest commit, see "[Removing files from a repository's history](/articles/removing-files-from-a-repository-s-history)." +You can remove the file from the latest commit with `git rm`. For information on removing a file that was added with the latest commit, see "[About large files on {% data variables.product.prodname_dotcom %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github#removing-files-from-a-repositorys-history)." {% warning %} diff --git a/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md b/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md index 34af6392e1..ba43e59b93 100644 --- a/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md +++ b/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md @@ -63,7 +63,7 @@ If you want to simulate a two-dot diff in a pull request and see a comparison be For more information about Git commands to compare changes, see "[Git diff options](https://git-scm.com/docs/git-diff#git-diff-emgitdiffemltoptionsgtltcommitgtltcommitgt--ltpathgt82308203)" from the _Pro Git_ book site. ## Reasons diffs will not display -- You've exceeded the total limit of files or certain file types. For more information, see "[Limits for viewing content and diffs in a repository](/articles/limits-for-viewing-content-and-diffs-in-a-repository/#diff-limits)." +- You've exceeded the total limit of files or certain file types. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#limits-for-viewing-content-and-diffs-in-a-repository)." - Your file matches a rule in the repository's *.gitattributes* file to block that file from displaying by default. For more information, see "[Customizing how changed files appear on GitHub](/articles/customizing-how-changed-files-appear-on-github)." ## Further reading diff --git a/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index 69c6d2f307..1db679a4a0 100644 --- a/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -32,7 +32,7 @@ Once you've created a pull request, you can push commits from your topic branch Other contributors can review your proposed changes, add review comments, contribute to the pull request discussion, and even add commits to the pull request. {% ifversion fpt %} -You can see information about the branch's current deployment status and past deployment activity on the "Conversation" tab. For more information, see "[Viewing deployment activity for a repository](/articles/viewing-deployment-activity-for-your-repository)." +You can see information about the branch's current deployment status and past deployment activity on the "Conversation" tab. For more information, see "[Viewing deployment activity for a repository](/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository)." {% endif %} After you're happy with the proposed changes, you can merge the pull request. If you're working in a shared repository model, you create a pull request and you, or someone else, will merge your changes from your feature branch into the base branch you specify in your pull request. For more information, see "[Merging a pull request](/articles/merging-a-pull-request)." @@ -71,7 +71,4 @@ The compare and pull request pages use different methods to calculate the diff f - "[Pull request](/articles/github-glossary/#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary - "[About branches](/articles/about-branches)" - "[Commenting on a pull request](/articles/commenting-on-a-pull-request)" -- "[Merging a pull request](/articles/merging-a-pull-request)" -- "[Closing a pull request](/articles/closing-a-pull-request)" -- "[Deleting unused branches](/articles/deleting-unused-branches)" -- "[About pull request merges](/articles/about-pull-request-merges)" +- "[Closing a pull request](/articles/closing-a-pull-request)" \ No newline at end of file diff --git a/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index 49d9f697e9..2303ae033d 100644 --- a/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -68,6 +68,5 @@ The new commit, message, and badge will appear on {% data variables.product.prod - "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)" - "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)" -- "[Viewing a summary of repository activity](/articles/viewing-a-summary-of-repository-activity)" - "[Viewing a project’s contributors](/articles/viewing-a-projects-contributors)" - "[Changing a commit message](/articles/changing-a-commit-message)" diff --git a/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md b/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md index a391933779..58d0c57da6 100644 --- a/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md +++ b/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md @@ -83,7 +83,6 @@ The new commit and message will appear on {% data variables.product.product_loca {% ifversion ghes or ghae %} - "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)" - "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %} -- "[Viewing a summary of repository activity](/articles/viewing-a-summary-of-repository-activity)" - "[Viewing a project's contributors](/articles/viewing-a-projects-contributors)" - "[Changing a commit message](/articles/changing-a-commit-message)" - "[Committing and reviewing changes to your project](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project#4-write-a-commit-message-and-push-your-changes)" in the {% data variables.product.prodname_desktop %} documentation diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/archiving-repositories.md deleted file mode 100644 index 64b03cc200..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/archiving-repositories.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Archiving repositories -intro: You can archive a repository to make it read-only for all users and indicate that it's no longer actively maintained. You can also unarchive repositories that have been archived. -redirect_from: - - /articles/archiving-repositories - - /github/creating-cloning-and-archiving-repositories/archiving-repositories -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -{% data reusables.repositories.archiving-repositories-recommendation %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -3. Under "Danger Zone", click **Archive this repository** or **Unarchive this repository**. - ![Archive this repository button](/assets/images/help/repository/archive-repository.png) -4. Read the warnings. -5. Type the name of the repository you want to archive or unarchive. - ![Archive repository warnings](/assets/images/help/repository/archive-repository-warnings.png) -6. Click **I understand the consequences, archive this repository**. - -## Further reading -- "[About archiving repositories](/articles/about-archiving-repositories)" diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md deleted file mode 100644 index 6cbf0ff753..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: 'Error: Remote HEAD refers to nonexistent ref, unable to checkout' -intro: 'This error occurs if the default branch of a repository has been deleted on {% data variables.product.product_location %}.' -redirect_from: - - /articles/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout - - /github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Unable to checkout ---- -Detecting this error is simple; Git will warn you when you try to clone the repository: - -```shell -$ git clone https://{% data variables.command_line.codeblock %}/user/repo.git -# Clone a repo -> Cloning into 'repo'... -> remote: Counting objects: 66179, done. -> remote: Compressing objects: 100% (15587/15587), done. -> remote: Total 66179 (delta 46985), reused 65596 (delta 46402) -> Receiving objects: 100% (66179/66179), 51.66 MiB | 667 KiB/s, done. -> Resolving deltas: 100% (46985/46985), done. -> warning: remote HEAD refers to nonexistent ref, unable to checkout. -``` - -To fix the error, you'll need to be an administrator of the repository on {% data variables.product.product_location %}. -You'll want to [change the default branch](/github/administering-a-repository/changing-the-default-branch) of the repository. - -After that, you can get a list of all the available branches from the command line: - -```shell -$ git branch -a -# Lists ALL the branches -> remotes/origin/awesome -> remotes/origin/more-work -> remotes/origin/new-main -``` - -Then, you can just switch to your new branch: - -```shell -$ git checkout new-main -# Create and checkout a tracking branch -> Branch new-main set up to track remote branch new-main from origin. -> Switched to a new branch 'new-main' -``` diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-repository-not-found.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-repository-not-found.md deleted file mode 100644 index 8cac0ea0ec..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-repository-not-found.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: 'Error: Repository not found' -intro: '{% ifversion fpt or ghae %}If you see this error when cloning a repository, it means that the repository does not exist or you do not have permission to access it.{% else %}If you see this error when cloning a repository, it means that the repository does not exist, you do not have permission to access it, or {% data variables.product.product_location %} is in private mode.{% endif %} There are a few solutions to this error, depending on the cause.' -redirect_from: - - /articles/error-repository-not-found - - /github/creating-cloning-and-archiving-repositories/error-repository-not-found -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Repository not found ---- -## Check your spelling - -Typos happen, and repository names are case-sensitive. If you try to clone `git@{% data variables.command_line.codeblock %}:user/repo.git`, but the repository is really named `User/Repo` you will receive this error. - -To avoid this error, when cloning, always copy and paste the clone URL from the repository's page. For more information, see "[Cloning a repository](/articles/cloning-a-repository)." - -To update the remote on an existing repository, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)". - -## Checking your permissions - -If you are trying to clone a private repository but do not have permission to view the repository, you will receive this error. - -Make sure that you have access to the repository in one of these ways: - -* The owner of the repository -* A [collaborator](/articles/inviting-collaborators-to-a-personal-repository) on the repository -* A [member of a team](/articles/adding-organization-members-to-a-team) that has access to the repository (if the repository belongs to an organization) - -## Check your SSH access - -In rare circumstances, you may not have the proper SSH access to a repository. - -You should ensure that the SSH key you are using is attached to your {% data variables.product.product_name %} user account. You can check this by typing -the following into the command line: - -```shell -$ ssh -T git@{% data variables.command_line.codeblock %} -> Hi username! You've successfully authenticated, but GitHub does not -> provide shell access. -``` - -If the repository belongs to an organization and you're using an SSH key generated by an OAuth App, OAuth App access may have been restricted by an organization owner. For more information, see "About OAuth App access restrictions." - -For more information, see [Adding a new SSH key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account). - -{% ifversion ghes %} -## Check if your instance is in private mode - -If your site administrator has enabled private mode on your GitHub Enterprise instance, anonymous clones over `git://` will be disabled. If you are unable to clone a repository, contact your site administrator. -{% endif %} - -## Check that the repository really exists - -If all else fails, make sure that the repository really exists on {% data variables.product.product_location %}! -If you're trying to push to a repository that doesn't exist, you'll get this error. diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/https-cloning-errors.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/https-cloning-errors.md deleted file mode 100644 index fa240b6466..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/https-cloning-errors.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: HTTPS cloning errors -intro: 'There are a few common errors when using HTTPS with Git. These errors usually indicate you have an old version of Git, or you don''t have access to the repository.' -redirect_from: - - /articles/error-the-requested-url-returned-error-403/ - - /articles/error-the-requested-url-returned-error-401/ - - /articles/error-did-you-run-git-update-server-info-on-the-server/ - - /articles/error-the-requested-url-returned-error-403-while-accessing-https-github-com-user-repo-git-info-refs/ - - /articles/https-cloning-errors - - /github/creating-cloning-and-archiving-repositories/https-cloning-errors -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -Here's an example of an HTTPS error you might receive: - -```shell -> error: The requested URL returned error: 401 while accessing -> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs?service=git-receive-pack -> fatal: HTTP request failed -``` - -```shell -> Error: The requested URL returned error: 403 while accessing -> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs -> fatal: HTTP request failed -``` - -```shell -> Error: https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs not found: did you run git -> update-server-info on the server? -``` - -## Check your Git version - -There's no minimum Git version necessary to interact with {% data variables.product.product_name %}, but we've found version 1.7.10 to be a comfortable stable version that's available on many platforms. You can always [download the latest version on the Git website](https://git-scm.com/downloads). - -## Ensure the remote is correct - -The repository you're trying to fetch must exist on {% data variables.product.product_location %}, and the URL is case-sensitive. - -You can find the URL of the local repository by opening the command line and -typing `git remote -v`: - -```shell -$ git remote -v -# View existing remotes -> origin https://github.com/ghost/reactivecocoa.git (fetch) -> origin https://github.com/ghost/reactivecocoa.git (push) - -$ git remote set-url origin https://github.com/ghost/ReactiveCocoa.git -# Change the 'origin' remote's URL - -$ git remote -v -# Verify new remote URL -> origin https://github.com/ghost/ReactiveCocoa.git (fetch) -> origin https://github.com/ghost/ReactiveCocoa.git (push) -``` - -Alternatively, you can change the URL through our -[{% data variables.product.prodname_desktop %}](https://desktop.github.com/) application. - -## Provide an access token - -To access {% data variables.product.prodname_dotcom %}, you must authenticate with a personal access token instead of your password. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." - -{% data reusables.command_line.provide-an-access-token %} - -## Check your permissions - -When prompted for a username and password, make sure you use an account that has access to the repository. - -{% tip %} - -**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/getting-started-with-github/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail. - -{% endtip %} - -## Use SSH instead - -If you've previously set up SSH keys, you can use the SSH clone URL instead of HTTPS. For more information, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/index.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/index.md deleted file mode 100644 index 39eb4819b6..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Cloning a repository from GitHub -intro: 'You can clone a remote repository to your local machine. If you run into errors, there are some common troubleshooting solutions.' -redirect_from: - - /articles/cloning-a-repository-from-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /cloning-a-repository - - /https-cloning-errors - - /error-repository-not-found - - /error-remote-head-refers-to-nonexistent-ref-unable-to-checkout -shortTitle: Clone a repository ---- - diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories.md deleted file mode 100644 index 7ff0753c74..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: About repositories -intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository. -redirect_from: - - /articles/about-repositories - - /github/creating-cloning-and-archiving-repositories/about-repositories -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -You can own repositories individually, or you can share ownership of repositories with other people in an organization. - -You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." - -For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization/)." - -{% ifversion fpt %} -With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} -{% else %} -Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. -{% endif %} - -You can use repositories to manage your work and collaborate with others. -- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt %} -- {% data reusables.discussions.you-can-use-discussions %}{% endif %} -- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." -- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." - -{% data reusables.repositories.repo-size-limit %} - -## Further reading - -- "[Creating a new repository](/articles/creating-a-new-repository)" -- "[Collaborating with issues and pull requests](/categories/collaborating-with-issues-and-pull-requests)" -- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" -- "[Administering a repository](/categories/administering-a-repository)" -- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)" -- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" -- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)" diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-visibility.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-visibility.md deleted file mode 100644 index 4960077f13..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-visibility.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: About repository visibility -intro: 'You can restrict who has access to a repository by choosing a repository''s visibility: {% ifversion fpt or ghes %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}.' -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -redirect_from: - - /github/creating-cloning-and-archiving-repositories/about-repository-visibility -shortTitle: Repository visibility ---- -## About repository visibility - -{% ifversion ghae %}When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal.{% else %}When you create a repository, you can choose to make the repository public or private.{% ifversion fpt or ghes %} If you're creating the repository in an organization{% ifversion fpt %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %} - -{% ifversion ghes %} -If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. {% ifversion ghes %} Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %} -{% elsif ghae %} -Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." -{% else %} -Public repositories are accessible to everyone on the internet. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." -{% endif %} - -Organization owners always have access to every repository created in an organization. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." - -People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." - -{% ifversion fpt or ghae or ghes %} -## About internal repositories - -{% note %} - -**Note:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - -{% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." - -All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt %}outside of the enterprise{% else %}who are not members of an organization{% endif %}, including outside collaborators on organization repositories. For more information, see {% ifversion fpt or ghae %}"[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and {% endif %}"[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)." - -{% data reusables.repositories.internal-repo-default %} - -If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. -{% endif %} diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/index.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/index.md deleted file mode 100644 index eed653820b..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Creating a repository on GitHub -intro: 'After you create your repository on {% data variables.product.product_name %}, you can customize its settings and content.' -redirect_from: - - /articles/creating-a-repository-on-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /about-repositories - - /about-repository-visibility - - /creating-a-new-repository - - /creating-a-repository-from-a-template - - /about-readmes - - /about-code-owners - - /about-repository-languages - - /licensing-a-repository - - /about-citation-files - - /creating-a-template-repository - - /creating-an-issues-only-repository - - /limits-for-viewing-content-and-diffs-in-a-repository - - /duplicating-a-repository -shortTitle: Create a repository ---- - diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/limits-for-viewing-content-and-diffs-in-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/limits-for-viewing-content-and-diffs-in-a-repository.md deleted file mode 100644 index a664a323e6..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/limits-for-viewing-content-and-diffs-in-a-repository.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Limits for viewing content and diffs in a repository -intro: 'Certain types of resources can be quite large, requiring excessive processing on {% data variables.product.product_name %}. Because of this, limits are set to ensure requests complete in a reasonable amount of time.' -redirect_from: - - /articles/what-are-the-limits-for-viewing-content-and-diffs-in-my-repository/ - - /articles/limits-for-viewing-content-and-diffs-in-a-repository - - /github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Content & diffs limits ---- -Most of the limits below affect both {% data variables.product.product_name %} and the API. - -## Text limits - -Text files over **1 MB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). - -Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. - -## Diff limits - -Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: - -- In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. -- No single file's diff may exceed *3,000 lines that you can load* or *100 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. -- The maximum number of files in a single diff is limited to *300*. -- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. - -Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. - -## Commit listings limits - -The compare view and pull requests pages display a list of commits between the `base` and `head` revisions. These lists are limited to **250** commits. If they exceed that limit, a note indicates that additional commits are present (but they're not shown). diff --git a/content/github/creating-cloning-and-archiving-repositories/index.md b/content/github/creating-cloning-and-archiving-repositories/index.md deleted file mode 100644 index cda0ac7951..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 'Creating, cloning, and archiving repositories' -intro: 'You can choose from a variety of configuration options when creating or cloning a repository. You can also use repositories to archive content and data on {% data variables.product.prodname_dotcom %}.' -redirect_from: - - /categories/repositories/ - - /categories/24/articles/ - - /categories/creating-cloning-and-archiving-repositories -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /creating-a-repository-on-github - - /cloning-a-repository-from-github - - /archiving-a-github-repository -shortTitle: 'Create, clone & archive' ---- - diff --git a/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md index 67b222cd57..89eafcc04e 100644 --- a/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md +++ b/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md @@ -58,7 +58,7 @@ shortTitle: Add a project locally {% mac %} -1. [Create a new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. +1. [Create a new repository](/repositories/creating-and-managing-repositories/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. @@ -169,4 +169,4 @@ shortTitle: Add a project locally ## Further reading -- "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)" +- "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)" diff --git a/content/github/index.md b/content/github/index.md index 540b50988a..fdfeb64ed6 100644 --- a/content/github/index.md +++ b/content/github/index.md @@ -14,17 +14,12 @@ children: - /copilot - /setting-up-and-managing-your-enterprise - /writing-on-github - - /creating-cloning-and-archiving-repositories - /committing-changes-to-your-project - /collaborating-with-pull-requests - /searching-for-information-on-github - /importing-your-projects-to-github - - /administering-a-repository - - /visualizing-repository-data-with-graphs - /managing-security-vulnerabilities - /finding-security-vulnerabilities-and-errors-in-your-code - - /managing-files-in-a-repository - - /managing-large-files - /customizing-your-github-workflow - /extending-github - /working-with-github-support diff --git a/content/github/managing-files-in-a-repository/index.md b/content/github/managing-files-in-a-repository/index.md deleted file mode 100644 index 85098e1287..0000000000 --- a/content/github/managing-files-in-a-repository/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Managing files in a repository -redirect_from: - - /categories/81/articles/ - - /categories/manipulating-files/ - - /categories/managing-files-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /managing-files-on-github - - /managing-files-using-the-command-line - - /working-with-non-code-files -shortTitle: Manage files in a repository ---- - diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/adding-a-file-to-a-repository.md b/content/github/managing-files-in-a-repository/managing-files-on-github/adding-a-file-to-a-repository.md deleted file mode 100644 index 71cd5f52b8..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/adding-a-file-to-a-repository.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Adding a file to a repository -intro: 'You can upload and commit an existing file to a {% data variables.product.product_name %} repository. Drag and drop a file to any directory in the file tree, or upload files from the repository''s main page.' -redirect_from: - - /articles/adding-a-file-to-a-repository - - /github/managing-files-in-a-repository/adding-a-file-to-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Add a file ---- -Files that you add to a repository via a browser are limited to {% data variables.large_files.max_github_browser_size %} per file. You can add larger files, up to {% data variables.large_files.max_github_size %} each, via the command line. For more information, see "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)." - -{% tip %} - -**Tips:** -- You can upload multiple files to {% data variables.product.product_name %} at the same time. -- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} - -{% endtip %} - -{% data reusables.repositories.navigate-to-repo %} -2. Above the list of files, using the **Add file** drop-down, click **Upload files**. - !["Upload files" in the "Add file" dropdown](/assets/images/help/repository/upload-files-button.png) -3. Drag and drop the file or folder you'd like to upload to your repository onto the file tree. -![Drag and drop area](/assets/images/help/repository/upload-files-drag-and-drop.png) -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose_commit_branch %} -6. Click **Commit changes**. -![Commit changes button](/assets/images/help/repository/commit-changes-button.png) diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository.md b/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository.md deleted file mode 100644 index 8aa97b831a..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Editing files in another user's repository -intro: 'When you edit a file in another user''s repository, we''ll automatically [fork the repository](/articles/fork-a-repo) and [open a pull request](/articles/creating-a-pull-request) for you.' -redirect_from: - - /articles/editing-files-in-another-users-repository/ - - /articles/editing-files-in-another-user-s-repository - - /articles/editing-files-in-another-users-repository - - /github/managing-files-in-a-repository/editing-files-in-another-users-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Edit another user's files ---- -1. In another user's repository, browse to the folder that contains the file you want to edit. Click the name of the file you want to edit. -2. Above the file content, click {% octicon "pencil" aria-label="The edit icon" %}. At this point, GitHub forks the repository for you. -3. Make any changes you need to the file. -![New content in file](/assets/images/help/repository/edit-readme-light.png) -{% data reusables.files.preview_change %} -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose-commit-email %} -6. Click **Propose file change**. -![Commit Changes button](/assets/images/help/repository/propose_file_change_button.png) -7. Type a title and description for your pull request. -![Pull Request description page](/assets/images/help/pull_requests/pullrequest-description.png) -8. Click **Create pull request**. -![Pull Request button](/assets/images/help/pull_requests/pullrequest-send.png) - -## Further reading - -* "[Editing files in your repository](/articles/editing-files-in-your-repository)" diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository.md b/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository.md deleted file mode 100644 index 220b4f32fd..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Editing files in your repository -intro: 'You can edit files directly on {% data variables.product.product_name %} in any of your repositories using the file editor.' -redirect_from: - - /articles/editing-files/ - - /articles/editing-files-in-your-repository - - /github/managing-files-in-a-repository/editing-files-in-your-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Edit your files ---- -{% tip %} - -**Tip**: {% data reusables.repositories.protected-branches-block-web-edits-uploads %} - -{% endtip %} - -{% note %} - -**Note:** {% data variables.product.product_name %}'s file editor uses [CodeMirror](https://codemirror.net/). - -{% endnote %} - -1. In your repository, browse to the file you want to edit. -{% data reusables.repositories.edit-file %} -3. On the **Edit file** tab, make any changes you need to the file. -![New content in file](/assets/images/help/repository/edit-readme-light.png) -{% data reusables.files.preview_change %} -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose-commit-email %} -{% data reusables.files.choose_commit_branch %} -{% data reusables.files.propose_file_change %} - -## Further reading - -* "[Editing files in another user's repository](/articles/editing-files-in-another-user-s-repository)" diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/index.md b/content/github/managing-files-in-a-repository/managing-files-on-github/index.md deleted file mode 100644 index da8f7e77b7..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Managing files on GitHub -intro: 'On {% data variables.product.product_name %}, you can create, edit, move, and delete files in a repository.' -redirect_from: - - /articles/managing-files-on-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /navigating-code-on-github - - /creating-new-files - - /adding-a-file-to-a-repository - - /moving-a-file-to-a-new-location - - /editing-files-in-your-repository - - /editing-files-in-another-users-repository - - /tracking-changes-in-a-file - - /deleting-files-in-a-repository - - /renaming-a-file - - /getting-permanent-links-to-files ---- - diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/moving-a-file-to-a-new-location.md b/content/github/managing-files-in-a-repository/managing-files-on-github/moving-a-file-to-a-new-location.md deleted file mode 100644 index f54fa5ae7d..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/moving-a-file-to-a-new-location.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Moving a file to a new location -intro: 'When editing a file, you can choose to move it anywhere within your repository, even if the directory doesn''t exist.' -redirect_from: - - /articles/moving-a-file-to-a-new-location - - /github/managing-files-in-a-repository/moving-a-file-to-a-new-location -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Move a file ---- -In addition to changing the file location, you can also [update the contents of your file](/articles/editing-files-in-your-repository), or [give it a new name](/articles/renaming-a-file) in the same commit. - -{% tip %} - -**Tips**: - -- If you try to move a file in a repository that you don’t have access to, we'll fork the project to your user account and help you send [a pull request](/articles/about-pull-requests) to the original repository after you commit your change. -- Some files, such as images, require that you move them from the command line. For more information, see "[Moving a file to a new location using the command line](/articles/moving-a-file-to-a-new-location-using-the-command-line)". -- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} - -{% endtip %} - -1. In your repository, browse to the file you want to move. -2. In the upper right corner of the file view, click {% octicon "pencil" aria-label="The edit icon" %} to open the file editor. -![Edit file icon](/assets/images/help/repository/move-file-edit-file-icon.png) -3. In the filename field, change the name of the file using these guidelines: - ![Editing a file name](/assets/images/help/repository/moving_files.gif) - - To move the file **into a subfolder**, type the name of the folder you want, followed by `/`. Your new folder name becomes a new item in the navigation breadcrumbs. - - To move the file into a directory **above the file's current location**, place your cursor at the beginning of the filename field, then either type `../` to jump up one full directory level, or type the `backspace` key to edit the parent folder's name. -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose_commit_branch %} -{% data reusables.files.propose_file_change %} diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/renaming-a-file.md b/content/github/managing-files-in-a-repository/managing-files-on-github/renaming-a-file.md deleted file mode 100644 index 46eaa20f6f..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/renaming-a-file.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Renaming a file -intro: 'You can rename any file in your repositories directly in {% data variables.product.product_name %}. Renaming a file also gives you the opportunity to [move the file to a new location](/articles/moving-a-file-to-a-new-location).' -redirect_from: - - /articles/renaming-a-file - - /github/managing-files-in-a-repository/renaming-a-file -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -{% tip %} - -**Tips**: - -- If you try to rename a file in a repository that you don’t have access to, we will fork the project to your user account and help you send [a pull request](/articles/about-pull-requests) to the original repository after you commit your change. -- File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. -- Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](/articles/renaming-a-file-using-the-command-line)." - -{% endtip %} - -1. In your repository, browse to the file you want to rename. -2. In the upper right corner of the file view, click {% octicon "pencil" aria-label="The edit icon" %} to open the file editor. -![Edit file icon](/assets/images/help/repository/edit-file-icon.png) -3. In the filename field, change the name of the file to the new filename you want. You can also update the contents of your file at the same time. -![Editing a file name](/assets/images/help/repository/changing-file-name.png) -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose_commit_branch %} -{% data reusables.files.propose_file_change %} diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/adding-a-file-to-a-repository-using-the-command-line.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/adding-a-file-to-a-repository-using-the-command-line.md deleted file mode 100644 index 1461590d0f..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/adding-a-file-to-a-repository-using-the-command-line.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Adding a file to a repository using the command line -intro: 'You can upload an existing file to a {% data variables.product.product_name %} repository using the command line.' -redirect_from: - - /articles/adding-a-file-to-a-repository-from-the-command-line/ - - /articles/adding-a-file-to-a-repository-using-the-command-line - - /github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Add a file locally ---- -{% tip %} - -**Tip:** You can also [add an existing file to a repository from the {% data variables.product.product_name %} website](/articles/adding-a-file-to-a-repository). - -{% endtip %} - -{% data reusables.command_line.manipulating_file_prereqs %} - -{% data reusables.repositories.sensitive-info-warning %} - -1. On your computer, move the file you'd like to upload to {% data variables.product.product_name %} into the local directory that was created when you cloned the repository. -{% data reusables.command_line.open_the_multi_os_terminal %} -{% data reusables.command_line.switching_directories_procedural %} -{% data reusables.git.stage_for_commit %} - ```shell - $ git add . - # Adds the file to your local repository and stages it for commit. {% data reusables.git.unstage-codeblock %} - ``` -{% data reusables.git.commit-file %} - ```shell - $ git commit -m "Add existing file" - # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} - ``` -{% data reusables.git.git-push %} - -## Further reading - -- "[Creating new files](/articles/creating-new-files)" -- "[Adding an existing project to GitHub using the command line](/articles/adding-an-existing-project-to-github-using-the-command-line)" diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/index.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/index.md deleted file mode 100644 index 5c5b9c30ff..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Managing files using the command line -intro: 'Using the command line, you can add, rename, and move files in a repository.' -redirect_from: - - /articles/managing-files-using-the-command-line -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /adding-a-file-to-a-repository-using-the-command-line - - /renaming-a-file-using-the-command-line - - /moving-a-file-to-a-new-location-using-the-command-line -shortTitle: Manage files locally ---- - diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/moving-a-file-to-a-new-location-using-the-command-line.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/moving-a-file-to-a-new-location-using-the-command-line.md deleted file mode 100644 index 99b8ad3efc..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/moving-a-file-to-a-new-location-using-the-command-line.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Moving a file to a new location using the command line -intro: You can use the command line to move files within a repository by removing the file from the old location and then adding it in the new location. -redirect_from: - - /articles/moving-a-file-to-a-new-location-using-the-command-line - - /github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Move a file locally ---- -Many files can be [moved directly on {% data variables.product.product_name %}](/articles/moving-a-file-to-a-new-location), but some files, such as images, require that you move them from the command line. - -{% data reusables.command_line.manipulating_file_prereqs %} - -1. On your computer, move the file to a new location within the directory that was created locally on your computer when you cloned the repository. -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Use `git status` to check the old and new file locations. - ```shell - $ git status - > # On branch your-branch - > # Changes not staged for commit: - > # (use "git add/rm ..." to update what will be committed) - > # (use "git checkout -- ..." to discard changes in working directory) - > # - > # deleted: /old-folder/image.png - > # - > # Untracked files: - > # (use "git add ..." to include in what will be committed) - > # - > # /new-folder/image.png - > # - > # no changes added to commit (use "git add" and/or "git commit -a") - ``` -{% data reusables.git.stage_for_commit %} This will delete, or `git rm`, the file from the old location and add, or `git add`, the file to the new location. - ```shell - $ git add . - # Adds the file to your local repository and stages it for commit. - # {% data reusables.git.unstage-codeblock %} - ``` -5. Use `git status` to check the changes staged for commit. - ```shell - $ git status - > # On branch your-branch - > # Changes to be committed: - > # (use "git reset HEAD ..." to unstage) - > # - > # renamed: /old-folder/image.png -> /new-folder/image.png - # Displays the changes staged for commit - ``` -{% data reusables.git.commit-file %} - ```shell - $ git commit -m "Move file to new directory" - # Commits the tracked changes and prepares them to be pushed to a remote repository. - # {% data reusables.git.reset-head-to-previous-commit-codeblock %} - ``` -{% data reusables.git.git-push %} - -## Further reading - -- "[Renaming a file using the command line](/articles/renaming-a-file-using-the-command-line)" -- "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)" diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/renaming-a-file-using-the-command-line.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/renaming-a-file-using-the-command-line.md deleted file mode 100644 index a3cda1ad40..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/renaming-a-file-using-the-command-line.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Renaming a file using the command line -intro: You can use the command line to rename any file in your repository. -redirect_from: - - /articles/renaming-a-file-using-the-command-line - - /github/managing-files-in-a-repository/renaming-a-file-using-the-command-line -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Rename a file locally ---- -Many files can be [renamed directly on {% data variables.product.product_name %}](/articles/renaming-a-file), but some files, such as images, require that you rename them from the command line. - -{% data reusables.command_line.manipulating_file_prereqs %} - -{% data reusables.command_line.open_the_multi_os_terminal %} -{% data reusables.command_line.switching_directories_procedural %} -3. Rename the file, specifying the old file name and the new name you'd like to give the file. This will stage your change for commit. - ```shell - $ git mv old_filename new_filename - ``` -4. Use `git status` to check the old and new file names. - ```shell - $ git status - > # On branch your-branch - > # Changes to be committed: - > # (use "git reset HEAD ..." to unstage) - > # - > # renamed: old_filename -> new_filename - > # - ``` -{% data reusables.git.commit-file %} - ```shell - $ git commit -m "Rename file" - # Commits the tracked changes and prepares them to be pushed to a remote repository. - # {% data reusables.git.reset-head-to-previous-commit-codeblock %} - ``` -{% data reusables.git.git-push %} - -## Further reading -- "[Moving a file to a new location using the command line](/articles/moving-a-file-to-a-new-location-using-the-command-line)" -- "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)" diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/3d-file-viewer.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/3d-file-viewer.md deleted file mode 100644 index f9571f4b47..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/3d-file-viewer.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: 3D File Viewer -redirect_from: - - /articles/stl-file-viewer/ - - /articles/3d-file-viewer - - /github/managing-files-in-a-repository/3d-file-viewer -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -{% data variables.product.product_name %} can host and render 3D files with the *.stl* extension. - -When looking directly at an STL file on {% data variables.product.product_name %} you can: - -* Click and drag to spin the model. -* Right click and drag to translate the view. -* Scroll to zoom in and out. -* Click the different view modes to change the view. - -## Diffs - -When looking at a commit or set of changes which includes an STL file, you'll be able to see a before and after diff of the file. - -By default, you'll get a view where everything unchanged is in wireframe. Additions are colored in green, and removed parts are colored in red. - -![wireframe](/assets/images/help/repository/stl_wireframe.png) - -You can also select the **Revision Slider** option, which lets you use a slider at the top of the file to transition between the current and previous revisions. - -## Fixing slow performance - -If you see this icon in the corner of the viewer, then the WebGL technology is not available on your browser: - -![WebGL pop error](/assets/images/help/repository/render_webgl_error.png) - -WebGL is necessary to take advantage of your computer's hardware to its fullest. We recommend you try browsers like [Chrome](https://www.google.com/intl/en/chrome/browser/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/), which ship with WebGL enabled. - -## Error: "Unable to display" - -If your model is invalid, GitHub may not be able to display the file. In addition, files that are larger than 10 MB are too big for GitHub to display. - -## Embedding your model elsewhere - -To display your 3D file elsewhere on the internet, modify this template and place it on any HTML page that supports JavaScript: - -```html - -``` - -For example, if your model's URL is [github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl](https://github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl), your embed code would be: - -```html - -``` - -By default, the embedded renderer is 420 pixels wide by 620 pixels high, but you can customize the output by passing height and width variables as parameters at the end of the URL, such as `?height=300&width=500`. - -{% tip %} - -**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). - -{% endtip %} diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/index.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/index.md deleted file mode 100644 index 960d2d455d..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Working with non-code files -intro: '' -redirect_from: - - /categories/89/articles/ - - /articles/working-with-non-code-files -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /rendering-and-diffing-images - - /3d-file-viewer - - /rendering-csv-and-tsv-data - - /rendering-pdf-documents - - /rendering-differences-in-prose-documents - - /mapping-geojson-files-on-github - - /working-with-jupyter-notebook-files-on-github -shortTitle: Work with non-code files ---- - diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/mapping-geojson-files-on-github.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/mapping-geojson-files-on-github.md deleted file mode 100644 index ee0277edaa..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/mapping-geojson-files-on-github.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Mapping geoJSON files on GitHub -redirect_from: - - /articles/mapping-geojson-files-on-github - - /github/managing-files-in-a-repository/mapping-geojson-files-on-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Mapping geoJSON files ---- -{% data variables.product.product_name %} supports rendering geoJSON and topoJSON map files within {% data variables.product.product_name %} repositories. Simply commit the file as you would normally using a `.geojson` or `.topojson` extension. Files with a `.json` extension are also supported, but only if `type` is set to `FeatureCollection`, `GeometryCollection`, or `topology`. Then, navigate to the path of the geoJSON file on GitHub.com. - -When you click the paper icon on the right, you'll also see the changes made to that file as part of a commit. - -![Source Render toggle screenshot](/assets/images/help/repository/source-render-toggle-geojson.png) - -## Geometry Types - -Maps on {% data variables.product.product_name %} use [Leaflet.js](http://leafletjs.com) and support all the geometry types outlined in [the geoJSON spec](http://www.geojson.org/geojson-spec.html) (Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, and GeometryCollection). TopoJSON files should be type "Topology" and adhere to the [topoJSON spec](https://github.com/mbostock/topojson/wiki/Specification). - -## Styling features - -You can customize the way features are displayed, such as specifying a particular color or adding a descriptive icon, by passing additional metadata within the geoJSON object's properties. The options are: - -* `marker-size` - `small`, `medium`, or `large` -* `marker-color` - valid RGB hex color -* `marker-symbol` - an icon ID from [the Maki project](http://mapbox.com/maki/) or a single alphanumeric character (a-z or 0-9). -* `stroke` - color of a polygon edge or line (RGB) -* `stroke-opacity` - opacity of a polygon edge or line (0.0 - 1.0) -* `stroke-width` - width of a polygon edge or line -* `fill` - the color of the interior of a polygon (GRB) -* `fill-opacity` - the opacity of the interior of a polygon (0.0-1.0) - -See [version 1.1.0 of the open simplestyle spec](https://github.com/mapbox/simplestyle-spec/tree/master/1.1.0) for more information. - -## Embedding your map elsewhere - -Want to make your geoJSON map available someplace other than {% data variables.product.product_name %}? Simply modify this template, and place it in any HTML page that supports javascript (e.g., [{% data variables.product.prodname_pages %}](http://pages.github.com)): - -```html - -``` - -For example, if your map's URL is [github.com/benbalter/dc-wifi-social/blob/master/bars.geojson](https://github.com/benbalter/dc-wifi-social/blob/master/bars.geojson), your embed code would be: - -```html - -``` - -By default, the embedded map 420px x 620px, but you can customize the output by passing height and width variables as parameters at the end, such as `?height=300&width=500`. - -{% tip %} - -**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). - -{% endtip %} - -## Clustering - -If your map contains a large number of markers (roughly over 750), GitHub will automatically cluster nearby markers at higher zoom levels. Simply click the cluster or zoom in to see individual markers. - -## Something's up with the underlying map - -The underlying map data (street names, roads, etc.) are driven by [OpenStreetMap](http://www.openstreetmap.org/), a collaborative project to create a free editable map of the world. If you notice something's not quite right, since it's open source, simply [sign up](https://www.openstreetmap.org/user/new) and submit a fix. - -## Troubleshooting - -If you're having trouble rendering geoJSON files, ensure you have a valid geoJSON file by running it through a [geoJSON linter](http://geojsonlint.com/). If your points aren't appearing where you'd expect (e.g., in the middle of the ocean), it's likely that the data is in a projection which is currently unsupported. Currently, {% data variables.product.product_name %} only supports the `urn:ogc:def:crs:OGC:1.3:CRS84` projection. - -Additionally, if your `.geojson` file is especially large (over 10 MB), it is not possible to render within the browser. If that's the case, you'll generally see a message that looks something like this: - -![Large file](/assets/images/help/repository/view_raw.png) - -It may still be possible to render the data by converting the `.geojson` file to [TopoJSON](https://github.com/mbostock/topojson), a compression format that, in some cases, can reduce filesize by up to 80%. Of course, you can always break the file into smaller chunks (such as by state or by year), and store the data as multiple files within the repository. - -## Additional Resources - -* [Leaflet.js geojson documentation](http://leafletjs.com/examples/geojson.html) -* [MapBox marker-styling documentation](http://www.mapbox.com/developers/simplestyle/) -* [TopoJSON Wiki](https://github.com/mbostock/topojson/wiki) diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images.md deleted file mode 100644 index b50620b6c8..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Rendering and diffing images -intro: '{% data variables.product.product_name %} can display several common image formats, including PNG, JPG, GIF, PSD, and SVG. In addition to simply displaying them, there are several ways to compare differences between versions of those image formats.' -redirect_from: - - /articles/rendering-and-diffing-images - - /github/managing-files-in-a-repository/rendering-and-diffing-images -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Render & diff images ---- -{% note %} - -**Note:** If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render. - -{% endnote %} - -## Viewing images - -You can directly browse and view images in your {% data variables.product.product_name %} repository: - -![inline image](/assets/images/help/images/view.png) - -SVGs don't currently support inline scripting or animation. - -## Viewing differences - -You can visually compare images in three different modes: [2-up](#2-up), [swipe](#swipe), and [onion skin](#onion-skin). - -### 2-up - -**2-up** is the default mode; it gives you a quick glimpse of both images. In addition, if the image has changed size between versions, the actual dimension change is displayed. This should make it very apparent when things are resized, such as when assets are upgraded to higher resolutions. - -![2-up](/assets/images/help/repository/images-2up-view.png) - -### Swipe - -**Swipe** lets you view portions of your image side by side. Not sure if colors shifted between different versions? Drag the swipe slider over the area in question and compare the pixels for yourself. - -![Swipe](/assets/images/help/repository/images-swipe-view.png) - -### Onion skin - -**Onion Skin** really comes in handy when elements move around by small, hard to notice amounts. Did an icon shift two pixels to the left? Drag the opacity slider back a bit and notice if things move around. - -![Onion skin](/assets/images/help/repository/images-onion-view.gif) diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-csv-and-tsv-data.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-csv-and-tsv-data.md deleted file mode 100644 index 6558cd2824..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-csv-and-tsv-data.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Rendering CSV and TSV data -redirect_from: - - /articles/rendering-csv-and-tsv-data - - /github/managing-files-in-a-repository/rendering-csv-and-tsv-data -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Render CSV & TSV data ---- -GitHub supports rendering tabular data in the form of *.csv* (comma-separated) and .*tsv* (tab-separated) files. - -![Rendered CSV sample](/assets/images/help/repository/rendered_csv.png) - -When viewed, any _.csv_ or _.tsv_ file committed to a {% data variables.product.product_name %} repository automatically renders as an interactive table, complete with headers and row numbering. By default, we'll always assume the first row is your header row. - -You can link to a particular row by clicking the row number, or select multiple rows by holding down the shift key. Just copy the URL and send it to a friend. - -## Searching data - -If you want to find a certain value in your dataset, you can start typing in the search bar directly above the file. The rows will filter automatically: - -![Searching for values](/assets/images/help/repository/searching_csvs.gif) - -## Handling errors - -Occasionally, you may discover that your CSV or TSV file isn't rendering. In those instances, an error box appears at the bottom of your raw text, suggesting what the error may be. - -![CSV render error message](/assets/images/help/repository/csv_render_error.png) - -Common errors include: - -* Mismatched column counts. You must have the same number of separators in each row, even if the cell is blank -* Exceeding the file size. Our rendering only works for files up to 512KB. Anything bigger than that slows down the browser. diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-differences-in-prose-documents.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-differences-in-prose-documents.md deleted file mode 100644 index be519a9f91..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-differences-in-prose-documents.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Rendering differences in prose documents -redirect_from: - - /articles/rendering-differences-in-prose-documents - - /github/managing-files-in-a-repository/rendering-differences-in-prose-documents -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Differences in prose ---- -Commits and pull requests that include prose documents have the ability to represent those documents with *source* and *rendered* views. - -The source view shows the raw text that has been typed, while the rendered -view shows how that text would look once it's rendered on {% data variables.product.product_name %}. For example, -this might be the difference between showing `**bold**` in Markdown, and **bold** in the rendered view. - -Prose rendering is supported for rendered documents supported by [github/markup](https://github.com/github/markup): - -* Markdown -* AsciiDoc -* Textile -* ReStructuredText -* Rdoc -* Org -* Creole -* MediaWiki -* Pod - -![Paper icon to view rendered prose document](/assets/images/help/repository/rendered_prose_diff.png) - -You can click {% octicon "file" aria-label="The paper icon" %} to see the changes made to the document as part of a commit. - -![Rendered Prose changes](/assets/images/help/repository/rendered_prose_changes.png) - -## Visualizing attribute changes - -We provide a tooltip -describing changes to attributes that, unlike words, would not otherwise be visible in the rendered document. For example, if a link URL changes from one website to -another, we'd show a tooltip like this: - -![Rendered Prose attribute changes](/assets/images/help/repository/prose_diff_attributes.png) - -## Commenting on changes - -[Commit comments](/articles/commenting-on-differences-between-files) can only -be added to files within the *source* view, on a line-by-line basis. - -## Linking to headers - -As with [other rendered prose documents](/articles/about-readmes), -hovering over a header in your document creates a link icon. You can link readers -of your rendered prose diff to specific sections. - -## Viewing complex diffs - -Some pull requests involve a large number of changes with large, complex documents. When the changes take too long to analyze, {% data variables.product.product_name %} can't always produce a rendered view of the changes. If this happens, you'll see an error message when you click the rendered button. - -![Message when view can't be rendered](/assets/images/help/repository/prose_diff_rendering.png) - -You can still use the source view to analyze and comment on changes. - -## Viewing HTML elements - -We don't directly support rendered views of commits to HTML documents. Some formats, such as Markdown, let you embed arbitrary HTML in a document. When these documents are shown on {% data variables.product.product_name %}, some of that embedded HTML can be shown in a preview, while some (like an embedded YouTube video) cannot. - -In general, rendered views of changes to a document containing embedded HTML will show changes to the elements that are supported in {% data variables.product.product_name %}'s view of the document. Changes to documents containing embedded HTML should always be reviewed in both the rendered and source views for completeness. diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-pdf-documents.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-pdf-documents.md deleted file mode 100644 index 338a1a68ad..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-pdf-documents.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Rendering PDF documents -redirect_from: - - /articles/rendering-pdf-documents - - /github/managing-files-in-a-repository/rendering-pdf-documents -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -GitHub supports rendering of PDF documents. - -![Rendered PDF Document](/assets/images/help/repository/rendered-pdf.png) - -Currently, links within PDFs are ignored. diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/working-with-jupyter-notebook-files-on-github.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/working-with-jupyter-notebook-files-on-github.md deleted file mode 100644 index ed946a9201..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/working-with-jupyter-notebook-files-on-github.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Working with Jupyter Notebook files on GitHub -intro: 'When you add Jupyter Notebook or IPython Notebook files with a *.ipynb* extension on {% data variables.product.product_location %}, they will render as static HTML files in your repository.' -redirect_from: - - /articles/working-with-jupyter-notebook-files-on-github - - /github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Jupyter Notebook files ---- -The interactive features of the notebook, such as custom JavaScript plots, will not work in your repository on {% data variables.product.product_location %}. For an example, see [*Linking and Interactions.ipynb*](https://github.com/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb). - -To view your Jupyter notebook with JavaScript content rendered or to share your notebook files with others you can use [nbviewer](https://nbviewer.jupyter.org/). For an example, see [*Linking and Interactions.ipynb*](https://nbviewer.jupyter.org/github/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb) rendered on nbviewer. - -To view a fully interactive version of your Jupyter Notebook, you can set up a notebook server locally. For more information, see [Jupyter's official documentation](http://jupyter.readthedocs.io/en/latest/index.html). - -## Troubleshooting - -If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert): - -```shell -$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb -``` - -## Further reading - -- [Jupyter Notebook's GitHub repository](https://github.com/jupyter/jupyter_notebook) -- [Gallery of Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki/A-gallery-of-interesting-Jupyter-Notebooks) diff --git a/content/github/managing-large-files/index.md b/content/github/managing-large-files/index.md deleted file mode 100644 index d34d067182..0000000000 --- a/content/github/managing-large-files/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Managing large files -intro: You can manage large files with Git Large File Storage. -redirect_from: - - /categories/managing-large-files -versions: - fpt: '*' - ghes: '*' - ghae: '*' -children: - - /working-with-large-files - - /versioning-large-files ---- - diff --git a/content/github/managing-large-files/working-with-large-files/conditions-for-large-files.md b/content/github/managing-large-files/working-with-large-files/conditions-for-large-files.md deleted file mode 100644 index 396999d4f5..0000000000 --- a/content/github/managing-large-files/working-with-large-files/conditions-for-large-files.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Conditions for large files -intro: '{% data variables.product.product_name %} limits the size of files allowed in repositories, and will block a push to a repository if the files are larger than the maximum file limit.' -redirect_from: - - /articles/conditions-for-large-files - - /github/managing-large-files/conditions-for-large-files -versions: - fpt: '*' - ghes: '*' - ghae: '*' -shortTitle: Large file conditions ---- -{% data reusables.large_files.use_lfs_tip %} - -## Warning for files larger than {% data variables.large_files.warning_size %} - -If you attempt to add or update a file that is larger than {% data variables.large_files.warning_size %}, you will receive a warning from Git. The changes will still successfully push to your repository, but you can consider removing the commit to minimize performance impact. For more information, see "[Removing files from a repository's history](/github/managing-large-files/removing-files-from-a-repositorys-history)." - -## Blocked pushes for large files - -{% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} blocks pushes that exceed {% data variables.large_files.max_github_size %}. {% ifversion ghes %}However, a site administrator can configure a different limit for {% data variables.product.product_location %}. For more information, see "[Setting Git push limits](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-git-push-limits)".{% endif %} diff --git a/content/github/managing-large-files/working-with-large-files/distributing-large-binaries.md b/content/github/managing-large-files/working-with-large-files/distributing-large-binaries.md deleted file mode 100644 index 93774177f5..0000000000 --- a/content/github/managing-large-files/working-with-large-files/distributing-large-binaries.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Distributing large binaries -intro: 'Some projects require distributing large files, such as binaries or installers, in addition to distributing source code.' -redirect_from: - - /articles/distributing-large-binaries - - /github/managing-large-files/distributing-large-binaries -versions: - fpt: '*' - ghes: '*' - ghae: '*' -shortTitle: Distribute large binaries ---- -If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %}. Releases allow you to package software, release notes, and links to binary files, for other people to use. For more information, visit "[About releases](/github/administering-a-repository/about-releases)." - -{% ifversion fpt %} - -We don't limit the total size of the binary files in the release or the bandwidth used to deliver them. However, each individual file must be smaller than {% data variables.large_files.max_lfs_size %}. - -{% endif %} - -{% data reusables.large_files.use_lfs_tip %} diff --git a/content/github/managing-large-files/working-with-large-files/index.md b/content/github/managing-large-files/working-with-large-files/index.md deleted file mode 100644 index 582965cf86..0000000000 --- a/content/github/managing-large-files/working-with-large-files/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Working with large files -intro: 'A Git repository contains every version of every file. But for some file types, this is not practical. Multiple revisions of large files increase the clone and fetch times for other users of a repository.' -redirect_from: - - /articles/working-with-large-files -versions: - fpt: '*' - ghes: '*' - ghae: '*' -children: - - /conditions-for-large-files - - /removing-files-from-a-repositorys-history - - /distributing-large-binaries - - /what-is-my-disk-quota ---- - diff --git a/content/github/managing-large-files/working-with-large-files/removing-files-from-a-repositorys-history.md b/content/github/managing-large-files/working-with-large-files/removing-files-from-a-repositorys-history.md deleted file mode 100644 index 7e15f7b7c5..0000000000 --- a/content/github/managing-large-files/working-with-large-files/removing-files-from-a-repositorys-history.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Removing files from a repository's history -intro: 'To remove a large file from your repository, you must completely remove it from your local repository and from {% data variables.product.product_location %}.' -redirect_from: - - /articles/removing-files-from-a-repository-s-history - - /articles/removing-files-from-a-repositorys-history - - /github/managing-large-files/removing-files-from-a-repositorys-history -versions: - fpt: '*' - ghes: '*' - ghae: '*' -shortTitle: Remove repository history ---- -{% warning %} - -**Warning**: These procedures will permanently remove files from the repository on your computer and {% data variables.product.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. - -{% endwarning %} - -## Removing a file added in the most recent unpushed commit - -If the file was added with your most recent commit, and you have not pushed to {% data variables.product.product_location %}, you can delete the file and amend the commit: - -{% data reusables.command_line.open_the_multi_os_terminal %} -{% data reusables.command_line.switching_directories_procedural %} -3. To remove the file, enter `git rm --cached`: - ```shell - $ git rm --cached giant_file - # Stage our giant file for removal, but leave it on disk - ``` -4. Commit this change using `--amend -CHEAD`: - ```shell - $ git commit --amend -CHEAD - # Amend the previous commit with your change - # Simply making a new commit won't work, as you need - # to remove the file from the unpushed history as well - ``` -5. Push your commits to {% data variables.product.product_location %}: - ```shell - $ git push - # Push our rewritten, smaller commit - ``` - -## Removing a file that was added in an earlier commit - -If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)." diff --git a/content/github/managing-large-files/working-with-large-files/what-is-my-disk-quota.md b/content/github/managing-large-files/working-with-large-files/what-is-my-disk-quota.md deleted file mode 100644 index af7258a763..0000000000 --- a/content/github/managing-large-files/working-with-large-files/what-is-my-disk-quota.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: What is my disk quota? -redirect_from: - - /articles/what-is-the-size-limit-for-a-repository/ - - /articles/what-is-my-disk-quota - - /github/managing-large-files/what-is-my-disk-quota -intro: '{% data variables.product.product_name %} tries to provide abundant storage for all Git repositories, although there are hard limits for file and repository sizes.' -versions: - fpt: '*' ---- -{% data reusables.large_files.use_lfs_tip %} - -## File and repository size limitations - -To ensure performance and reliability for our users, we actively monitor signals of overall repository health. Repository health is a function of various interacting factors, including size, commit frequency, contents, and structure. - -We recommend repositories remain small, ideally less than 1 GB, and less than 5 GB is strongly recommended. Smaller repositories are faster to clone and easier to work with and maintain. Individual files in a repository are strictly limited to a {% data variables.large_files.max_github_size %} maximum size limit. For more information, see "[Working with large files](/github/managing-large-files/working-with-large-files)." - -If your repository excessively impacts our infrastructure, you might receive an email from {% data variables.contact.github_support %} asking you to take corrective action. We try to be flexible, especially with large projects that have many collaborators, and will work with you to find a resolution whenever possible. You can prevent your repository from impacting our infrastructure by effectively managing your repository's size and overall health. You can find advice and a tool for repository analysis in the [`github/git-sizer`](https://github.com/github/git-sizer) repository. - -{% note %} - -**Note:** If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[Adding a file to a repository](/github/managing-files-in-a-repository/adding-a-file-to-a-repository)." - -{% endnote %} - -## Backups - -Git is not designed to serve as a backup tool. However, there are many solutions specifically designed for performing backups, such as [Arq](https://www.arqbackup.com/), [Carbonite](http://www.carbonite.com/), and [CrashPlan](https://www.crashplan.com/en-us/). - -## Database dumps - -Version control systems, such as Git, are not designed to handle large SQL files. To share large databases with other developers, we recommend using [Dropbox](https://www.dropbox.com/). - -Git shouldn't be used to backup your production servers. For more information, see "[Backups](/github/managing-large-files/what-is-my-disk-quota#backups)." - -## External dependencies - -External dependencies can cause Git repositories to become very large. To avoid filling a repository with external dependencies, we recommend you use a package manager. Popular package managers for common languages include [Bundler](http://bundler.io/), [Node's Package Manager](http://npmjs.org/), and [Maven](http://maven.apache.org/). These package managers support using Git repositories directly, so you don't need pre-packaged sources. - -## Packaged release versions - -We don't recommend distributing compiled code and pre-packaged releases within your repository. For more information, see "[Distributing large binaries](/github/managing-large-files/distributing-large-binaries)." - -## Changing history of an existing repository - -If you already have a repository that's quite large, you can reduce the size of a repository by removing large files from the repository's history. For more information, see "[Removing files from a repository's history](/github/managing-large-files/removing-files-from-a-repositorys-history)." diff --git a/content/github/searching-for-information-on-github/getting-started-with-searching-on-github/sorting-search-results.md b/content/github/searching-for-information-on-github/getting-started-with-searching-on-github/sorting-search-results.md index 267689b2e4..b6e2d4c2ce 100644 --- a/content/github/searching-for-information-on-github/getting-started-with-searching-on-github/sorting-search-results.md +++ b/content/github/searching-for-information-on-github/getting-started-with-searching-on-github/sorting-search-results.md @@ -69,5 +69,5 @@ The `sort:updated` qualifier sorts by how recently the items were updated. ## Further reading -- [About searching on GitHub](/articles/about-searching-on-github) -- [Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests/) +- "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)" +- "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)" diff --git a/content/github/searching-for-information-on-github/searching-on-github/searching-commits.md b/content/github/searching-for-information-on-github/searching-on-github/searching-commits.md index 96c3cbf8c8..46bc8fae9b 100644 --- a/content/github/searching-for-information-on-github/searching-on-github/searching-commits.md +++ b/content/github/searching-for-information-on-github/searching-on-github/searching-commits.md @@ -100,7 +100,7 @@ To search commits in all repositories owned by a certain user or organization, u ## Filter by repository visibility -The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility). +The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes %} diff --git a/content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md b/content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md index 92eae969d6..0e8580d970 100644 --- a/content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md +++ b/content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md @@ -37,7 +37,7 @@ To search discussions in all repositories owned by a certain user or organizatio ## Filter by repository visibility -You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example | :- | :- |{% ifversion fpt or ghes %} diff --git a/content/github/searching-for-information-on-github/searching-on-github/searching-for-repositories.md b/content/github/searching-for-information-on-github/searching-on-github/searching-for-repositories.md index e73fbb7b30..475deae14d 100644 --- a/content/github/searching-for-information-on-github/searching-on-github/searching-for-repositories.md +++ b/content/github/searching-for-information-on-github/searching-on-github/searching-for-repositories.md @@ -143,7 +143,7 @@ You can search repositories by the type of license in the repositories. You must ## Search by repository visibility -You can filter your search based on the visibility of the repositories. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +You can filter your search based on the visibility of the repositories. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes %} @@ -166,7 +166,7 @@ You can search repositories based on whether the repositories are mirrors and ho ## Search based on whether a repository is archived -You can search repositories based on whether or not the repositories are archived. For more information, see "[About archiving repositories](/github/creating-cloning-and-archiving-repositories/about-archiving-repositories)." +You can search repositories based on whether or not the repositories are archived. For more information, see "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)." | Qualifier | Example | ------------- | ------------- diff --git a/content/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests.md b/content/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests.md index 77f2e8acd6..5104494e41 100644 --- a/content/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests.md @@ -74,7 +74,7 @@ You can filter issues and pull requests based on whether they're open or closed ## Filter by repository visibility -You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes %} diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/index.md b/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/index.md deleted file mode 100644 index 8ffa36311c..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Accessing basic repository data -intro: 'You can view basic information about a repository, such as the repository''s activity{% ifversion fpt %}, traffic,{% endif %} and contribution activity.' -redirect_from: - - /articles/accessing-basic-repository-data -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /about-repository-graphs - - /viewing-a-summary-of-repository-activity - - /viewing-a-projects-contributors - - /viewing-traffic-to-a-repository -shortTitle: Access basic repository data ---- - diff --git a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/index.md b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/index.md deleted file mode 100644 index f9a8d0f1fd..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Analyzing changes to a repository's content -intro: 'You can see the changes to the content of a repository by analyzing the repository''s commits, commit frequency, and content additions and deletions.' -redirect_from: - - /articles/viewing-commit-frequency-in-a-repository/ - - /articles/analyzing-changes-to-a-repository-s-content - - /articles/analyzing-changes-to-a-repositorys-content -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /visualizing-commits-in-a-repository - - /visualizing-additions-and-deletions-to-content-in-a-repository -shortTitle: Analyze changes to repository ---- - diff --git a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-additions-and-deletions-to-content-in-a-repository.md b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-additions-and-deletions-to-content-in-a-repository.md deleted file mode 100644 index 9d262527a2..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-additions-and-deletions-to-content-in-a-repository.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Visualizing additions and deletions to content in a repository -intro: The code frequency graph displays the content additions and deletions for each week in a repository's history. -product: '{% data reusables.gated-features.repository-insights %}' -redirect_from: - - /articles/visualizing-additions-and-deletions-to-content-in-a-repository - - /github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: View changes to content ---- -{% ifversion fpt %} - -![Code frequency graph](/assets/images/help/graphs/repo_code_frequency_graph_dotcom.png) - -{% endif %} - -## Accessing the code frequency graph - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Code frequency**. -![Code frequency tab](/assets/images/help/graphs/code_frequency_tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-commits-in-a-repository.md b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-commits-in-a-repository.md deleted file mode 100644 index 301e26849d..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-commits-in-a-repository.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Visualizing commits in a repository -intro: You can see all commits made to a repository in the past year (excluding merge commits) in the Commit graph. -product: '{% data reusables.gated-features.repository-insights %}' -redirect_from: - - /articles/visualizing-commits-in-a-repository - - /github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: View commits in repository ---- -The top graph shows commits for the entire year by week. - -![Repository commit year graph](/assets/images/help/graphs/repo_commit_activity_year_graph.png) - -The bottom graph shows the average number of commits by day of the week for the selected week. - -![Repository commit week graph](/assets/images/help/graphs/repo_commit_activity_week_graph.png) - -## Accessing the commits graph - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Commits**. -![Commits tab](/assets/images/help/graphs/commits_tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/index.md b/content/github/visualizing-repository-data-with-graphs/index.md deleted file mode 100644 index a0e7cbc7d1..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Visualizing repository data with graphs -intro: You can use a variety of graphs to gain a better understanding of your repositories. -redirect_from: - - /categories/44/articles/ - - /categories/graphs-and-contributions/ - - /categories/graphs/ - - /categories/visualizing-repository-data-with-graphs -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /accessing-basic-repository-data - - /analyzing-changes-to-a-repositorys-content - - /understanding-connections-between-repositories -shortTitle: View repository graphs ---- - diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/index.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/index.md deleted file mode 100644 index 02ee01bbde..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Understanding connections between repositories -intro: 'You can better understand the connections that exist between repositories by viewing a repository''s network{% ifversion fpt %}, projects that depend on the repository,{% endif %} and its forks.' -redirect_from: - - /articles/understanding-connections-between-repositories -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /viewing-a-repositorys-network - - /listing-the-forks-of-a-repository - - /viewing-the-dependencies-of-a-repository - - /about-the-dependency-graph - - /exploring-the-dependencies-of-a-repository -shortTitle: Connections between repos ---- - diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/listing-the-forks-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/listing-the-forks-of-a-repository.md deleted file mode 100644 index 58f7f742a6..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/listing-the-forks-of-a-repository.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Listing the forks of a repository -intro: The Members graph displays all the forks of a repository. -redirect_from: - - /articles/listing-the-forks-of-a-repository - - /github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: List repository forks ---- -Forks are listed alphabetically by the username of the person who forked the repository. You can click on the username to be redirected to the user's {% data variables.product.product_name %} profile page or click on the fork name to be redirected to the specific fork of the repository. - -{% ifversion fpt %} - -![Repository members graph](/assets/images/help/graphs/repo_forks_graph_dotcom.png) - -{% else %} - -![Repository members graph](/assets/images/help/graphs/repo_members_graph.png) - -{% endif %} - -## Accessing the Members graph - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Forks**. -![Forks tab](/assets/images/help/graphs/graphs-sidebar-forks-tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-a-repositorys-network.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-a-repositorys-network.md deleted file mode 100644 index 38aa295acc..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-a-repositorys-network.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Viewing a repository's network -intro: 'The network graph displays the branch history of the entire repository network, including branches of the root repository and branches of forks that contain commits unique to the network.' -product: '{% data reusables.gated-features.repository-insights %}' -redirect_from: - - /articles/viewing-a-repository-s-network - - /articles/viewing-a-repositorys-network - - /github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: View repository network ---- -![Repository network graph](/assets/images/help/graphs/repo_network_graph.png) - -{% tip %} - -**Tip:** To see older branches, click and drag within the graph. - -{% endtip %} - -## Accessing the network graph - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Network**. -![Network tab](/assets/images/help/graphs/network_tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-the-dependencies-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-the-dependencies-of-a-repository.md deleted file mode 100644 index 4624fd890c..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-the-dependencies-of-a-repository.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Viewing the dependencies of a repository -intro: You can use the dependency graph to explore the code your repository depends on. -versions: - fpt: '*' - ghes: '>=3.0' -redirect_from: - - /github/visualizing-repository-data-with-graphs/viewing-the-dependencies-of-a-repository -shortTitle: View dependencies ---- -Almost all software relies on code developed and maintained by other developers, often known as a supply chain. For example, utilities, libraries, and frameworks. These dependencies are an integral part of your code and any bugs or vulnerabilities in them may affect your code. It's important to review and maintain these dependencies. - -The dependency graph provides a great way to visualize and explore the dependencies for a repository. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)" and "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository)." - -You can also set up your repository so that {% data variables.product.company_short %} alerts you automatically whenever a security vulnerability is found in one of your dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." diff --git a/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md b/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md index dd07de9cb9..12f263d29c 100644 --- a/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md +++ b/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md @@ -49,7 +49,7 @@ You can download a ZIP file of a gist by clicking the **Download ZIP** button at {% ifversion fpt %} -Gist supports mapping GeoJSON files. These maps are displayed in embedded gists, so you can easily share and embed maps. For more information, see "[Mapping GeoJSON files on {% data variables.product.product_name %}](/articles/mapping-geojson-files-on-github)." +Gist supports mapping GeoJSON files. These maps are displayed in embedded gists, so you can easily share and embed maps. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#mapping-geojson-files-on-github)." {% endif %} diff --git a/content/index.md b/content/index.md index b9fbae52a9..53e57e2b80 100644 --- a/content/index.md +++ b/content/index.md @@ -4,7 +4,7 @@ featuredLinks: gettingStarted: - /github/getting-started-with-github/set-up-git - /github/authenticating-to-github/connecting-to-github-with-ssh - - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github + - /repositories/creating-and-managing-repositories - /github/writing-on-github/basic-writing-and-formatting-syntax popular: - /github/collaborating-with-issues-and-pull-requests/about-pull-requests @@ -16,6 +16,7 @@ versions: '*' children: - get-started - account-and-profile + - repositories - github - admin - billing diff --git a/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md new file mode 100644 index 0000000000..c4ba4fb634 --- /dev/null +++ b/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md @@ -0,0 +1,233 @@ +--- +title: Filtering and searching issues and pull requests +intro: 'To find detailed information about a repository on {% data variables.product.product_name %}, you can filter, sort, and search issues and pull requests that are relevant to the repository.' +redirect_from: + - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees + - /articles/filtering-issues-and-pull-requests-by-assignees + - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees + - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels + - /articles/filtering-issues-and-pull-requests-by-labels + - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels + - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests + - /articles/filtering-issues-and-pull-requests + - /github/managing-your-work-on-github/filtering-issues-and-pull-requests + - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-pull-requests-by-review-status + - /articles/filtering-pull-requests-by-review-status + - /github/managing-your-work-on-github/filtering-pull-requests-by-review-status + - /github/managing-your-work-on-github/finding-information-in-a-repository + - /articles/finding-information-in-a-repository + - /github/managing-your-work-on-github/finding-information-in-a-repository/sharing-filters + - /articles/sharing-filters + - /github/managing-your-work-on-github/sharing-filters + - /github/managing-your-work-on-github/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests + - /articles/using-search-to-filter-issues-and-pull-requests + - /github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests + - /github/managing-your-work-on-github/finding-information-in-a-repository/sorting-issues-and-pull-requests + - /articles/sorting-issues-and-pull-requests + - /github/managing-your-work-on-github/sorting-issues-and-pull-requests + - /github/administering-a-repository/finding-information-in-a-repository + - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests + - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees + - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels + - /github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status + - /github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests + - /github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests + - /github/administering-a-repository/finding-information-in-a-repository/sharing-filters +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Issues + - Pull requests +shortTitle: Filter and search +--- + +{% data reusables.cli.filter-issues-and-pull-requests-tip %} + +## Filtering issues and pull requests + +Issues and pull requests come with a set of default filters you can apply to organize your listings. + +{% data reusables.search.requested_reviews_search %} + +You can filter issues and pull requests to find: +- All open issues and pull requests +- Issues and pull requests that you've created +- Issues and pull requests that are assigned to you +- Issues and pull requests where you're [**@mentioned**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) + +{% data reusables.cli.filter-issues-and-pull-requests-tip %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +3. Click **Filters** to choose the type of filter you're interested in. + ![Using the Filters drop-down](/assets/images/help/issues/issues_filter_dropdown.png) + +## Filtering issues and pull requests by assignees + +Once you've [assigned an issue or pull request to someone](/articles/assigning-issues-and-pull-requests-to-other-github-users), you can find items based on who's working on them. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +3. In the upper-right corner, select the Assignee drop-down menu. +4. The Assignee drop-down menu lists everyone who has write access to your repository. Click the name of the person whose assigned items you want to see, or click **Assigned to nobody** to see which issues are unassigned. +![Using the Assignees drop-down tab](/assets/images/help/issues/issues_assignee_dropdown.png) + +{% tip %} + +To clear your filter selection, click **Clear current search query, filters, and sorts**. + +{% endtip %} + +## Filtering issues and pull requests by labels + +Once you've [applied labels to an issue or pull request](/articles/applying-labels-to-issues-and-pull-requests), you can find items based on their labels. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +{% data reusables.project-management.labels %} +4. In the list of labels, click a label to see the issues and pull requests that it's been applied to. + ![List of a repository's labels](/assets/images/help/issues/labels-page.png) + +{% tip %} + +**Tip:** To clear your filter selection, click **Clear current search query, filters, and sorts**. + +{% endtip %} + +## Filtering pull requests by review status + +You can use filters to list pull requests by review status and to find pull requests that you've reviewed or other people have asked you to review. + +You can filter a repository's list of pull requests to find: +- Pull requests that haven't been [reviewed](/articles/about-pull-request-reviews) yet +- Pull requests that [require a review](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged +- Pull requests that a reviewer has approved +- Pull requests in which a reviewer has asked for changes +- Pull requests that you have reviewed +- Pull requests that [someone has asked you, or a team you're a member of, to review](/articles/requesting-a-pull-request-review) + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-pr %} +3. In the upper-right corner, select the Reviews drop-down menu. + ![Reviews drop-down menu in the filter menu above the list of pull requests](/assets/images/help/pull_requests/reviews-filter-dropdown.png) +4. Choose a filter to find all of the pull requests with that filter's status. + ![List of filters in the Reviews drop-down menu](/assets/images/help/pull_requests/pr-review-filters.png) + +## Using search to filter issues and pull requests + +You can use advanced filters to search for issues and pull requests that meet specific criteria. + +### Searching for issues and pull requests + +{% include tool-switcher %} + +{% webui %} + +The issues and pull requests search bar allows you to define your own custom filters and sort by a wide variety of criteria. You can find the search bar on each repository's **Issues** and **Pull requests** tabs and on your [Issues and Pull requests dashboards](/articles/viewing-all-of-your-issues-and-pull-requests). + +![The issues and pull requests search bar](/assets/images/help/issues/issues_search_bar.png) + +{% tip %} + +**Tip:** {% data reusables.search.search_issues_and_pull_requests_shortcut %} + +{% endtip %} + +{% endwebui %} + +{% cli %} + +{% data reusables.cli.cli-learn-more %} + +You can use the {% data variables.product.prodname_cli %} to search for issues or pull requests. Use the `gh issue list` or `gh pr list` subcommand along with the `--search` argument and a search query. + +For example, you can list, in order of date created, all issues that have no assignee and that have the label `help wanted` or `bug`. + +```shell +gh issue list --search 'no:assignee label:"help wanted",bug sort:created-asc' +``` + +You can also list all pull requests that mention the `octo-org/octo-team` team. + +```shell +gh pr list --search "team:octo-org/octo-team" +``` + +{% endcli %} + +### About search terms + +With issue and pull request search terms, you can: + +- Filter issues and pull requests by author: `state:open type:issue author:octocat` +- Filter issues and pull requests that involve, but don't necessarily [**@mention**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), certain people: `state:open type:issue involves:octocat` +- Filter issues and pull requests by assignee: `state:open type:issue assignee:octocat` +- Filter issues and pull requests by label: `state:open type:issue label:"bug"` +- Filter out search terms by using `-` before the term: `state:open type:issue -author:octocat` + +{% ifversion fpt or ghes > 3.2 or ghae-next %} +{% tip %} + +**Tip:** You can filter issues and pull requests by label using logical OR or using logical AND. +- To filter issues using logical OR, use the comma syntax: `label:"bug","wip"`. +- To filter issues using logical AND, use separate label filters: `label:"bug" label:"wip"`. + +{% endtip %} +{% endif %} + +{% ifversion fpt or ghes or ghae %} +For issues, you can also use search to: + +- Filter for issues that are linked to a pull request by a closing reference: `linked:pr` +{% endif %} + +For pull requests, you can also use search to: +- Filter [draft](/articles/about-pull-requests#draft-pull-requests) pull requests: `is:draft` +- Filter pull requests that haven't been [reviewed](/articles/about-pull-request-reviews) yet: `state:open type:pr review:none` +- Filter pull requests that [require a review](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged: `state:open type:pr review:required` +- Filter pull requests that a reviewer has approved: `state:open type:pr review:approved` +- Filter pull requests in which a reviewer has asked for changes: `state:open type:pr review:changes_requested` +- Filter pull requests by [reviewer](/articles/about-pull-request-reviews/): `state:open type:pr reviewed-by:octocat` +- Filter pull requests by the specific user [requested for review](/articles/requesting-a-pull-request-review): `state:open type:pr review-requested:octocat` +- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom`{% ifversion fpt or ghes or ghae %} +- Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue`{% endif %} + +## Sorting issues and pull requests + +Filters can be sorted to provide better information during a specific time period. + +You can sort any filtered view by: + +* The newest created issues or pull requests +* The oldest created issues or pull requests +* The most commented issues or pull requests +* The least commented issues or pull requests +* The newest updated issues or pull requests +* The oldest updated issues or pull requests +* The most added reaction on issues or pull requests + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +1. In the upper-right corner, select the Sort drop-down menu. + ![Using the Sort drop-down tab](/assets/images/help/issues/issues_sort_dropdown.png) + +To clear your sort selection, click **Sort** > **Newest**. + + +## Sharing filters + +When you filter or sort issues and pull requests, your browser's URL is automatically updated to match the new view. + +You can send the URL that issues generates to any user, and they'll be able to see the same filter view that you see. + +For example, if you filter on issues assigned to Hubot, and sort on the oldest open issues, your URL would update to something like the following: + +``` +/issues?q=state:open+type:issue+assignee:hubot+sort:created-asc +``` + +## Further reading + +- "[Searching issues and pull requests](/articles/searching-issues)"" diff --git a/content/issues/tracking-your-work-with-issues/index.md b/content/issues/tracking-your-work-with-issues/index.md index c42359a616..c8f3b877b3 100644 --- a/content/issues/tracking-your-work-with-issues/index.md +++ b/content/issues/tracking-your-work-with-issues/index.md @@ -16,6 +16,7 @@ children: - /linking-a-pull-request-to-an-issue - /assigning-issues-and-pull-requests-to-other-github-users - /viewing-all-of-your-issues-and-pull-requests + - /filtering-and-searching-issues-and-pull-requests - /marking-issues-or-pull-requests-as-a-duplicate - /pinning-an-issue-to-your-repository - /transferring-an-issue-to-another-repository diff --git a/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md b/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md index 32a218e350..c111ea0f00 100644 --- a/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md +++ b/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md @@ -79,7 +79,7 @@ You can create labels for a repository to categorize issues, pull requests, and For more information, see "[Creating a label](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)." -Once you have created a label in a repository, you can apply it on any issue, pull request or discussion in the repository. You can then filter issues and pull requests by label to find all associated work. For example, find all the front end bugs in your project by filtering for issues with the `front-end` and `bug` labels. For more information, see "[Filtering issues and pull requests by labels](/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels)." +Once you have created a label in a repository, you can apply it on any issue, pull request or discussion in the repository. You can then filter issues and pull requests by label to find all associated work. For example, find all the front end bugs in your project by filtering for issues with the `front-end` and `bug` labels. For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)." ### Label example Below is an example of a `front-end` label that we created and added to the issue. diff --git a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md index 09c885ce70..9bbabbc723 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md +++ b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md @@ -31,8 +31,5 @@ shortTitle: Filter by milestone ## Further reading -- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" +- "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)" - "[Filtering cards on a project board](/articles/filtering-cards-on-a-project-board)" diff --git a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md index 14c007907c..fb39d840bf 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md +++ b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md @@ -94,6 +94,6 @@ Deleting a label will remove the label from issues and pull requests. {% data reusables.project-management.delete-label %} ## Further reading -- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% ifversion fpt or ghes %} +- "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)"{% ifversion fpt or ghes %} - "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"{% endif %}{% ifversion fpt %} - "[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/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md index f1f628511c..dc490fdbb9 100644 --- a/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -587,9 +587,9 @@ For more information, see "[Managing the publication of {% data variables.produc | `self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." | `self_hosted_runner_offline` | Triggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."{% endif %}{% ifversion fpt or ghes %} | `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)."{% endif %}{% ifversion fpt %} -| `set_actions_fork_pr_approvals_policy` | Triggered when the setting for requiring approvals for workflows from public forks is changed. For more information, see "[Requiring approval for workflows from public forks](/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository#requiring-approval-for-workflows-from-public-forks)."{% endif %}{% ifversion fpt or ghes > 2.22 or ghae %} -| `set_actions_retention_limit` | Triggered when the retention period for {% data variables.product.prodname_actions %} artifacts and logs is changed. For more information, see "[Configuring the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository](/github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %}{% ifversion fpt or ghes > 2.22 %} -| `set_fork_pr_workflows_policy` | Triggered when the policy for workflows on private repository forks is changed. For more information, see "[Enabling workflows for private repository forks](/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} +| `set_actions_fork_pr_approvals_policy` | Triggered when the setting for requiring approvals for workflows from public forks is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks)."{% endif %}{% ifversion fpt or ghes > 2.22 or ghae %} +| `set_actions_retention_limit` | Triggered when the retention period for {% data variables.product.prodname_actions %} artifacts and logs is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %}{% ifversion fpt or ghes > 2.22 %} +| `set_fork_pr_workflows_policy` | Triggered when the policy for workflows on private repository forks is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} | `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository). | `transfer_start` | Triggered when a repository transfer is about to occur. | `unarchived` | Triggered when a repository admin unarchives a repository.{% ifversion fpt or ghes %} diff --git a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index 83e5cd894d..10b9fe29ef 100644 --- a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -14,7 +14,7 @@ topics: shortTitle: Restrict repository creation --- -You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %} For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% ifversion fpt %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %} For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." Organization owners can always create any type of repository. diff --git a/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md index df4f7ddd42..f694ec10bf 100644 --- a/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md @@ -32,4 +32,4 @@ You can restrict the ability to change repository visibility to organization own ## Further reading -- "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)" +- "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md index 330f913e71..05c49faf04 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md @@ -35,7 +35,7 @@ To access the organization's protected resources using the API and Git on the co The first time a member uses SAML SSO to access your organization, {% data variables.product.prodname_dotcom %} automatically creates a record that links your organization, the member's {% data variables.product.prodname_dotcom %} account, and the member's account on your IdP. You can view and revoke the linked SAML identity, active sessions, and authorized credentials for members of your organization or enterprise account. For more information, see "[Viewing and managing a member's SAML access to your organization](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[Viewing and managing a user's SAML access to your enterprise account](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise-account)." -If members are signed in with a SAML SSO session when they create a new repository, the default visibility of that repository is private. Otherwise, the default visibility is public. For more information on repository visibility, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +If members are signed in with a SAML SSO session when they create a new repository, the default visibility of that repository is private. Otherwise, the default visibility is public. For more information on repository visibility, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." Organization members must also have an active SAML session to authorize an {% data variables.product.prodname_oauth_app %}. You can opt out of this requirement by contacting {% data variables.contact.contact_support %}. {% data variables.product.product_name %} does not recommend opting out of this requirement, which will expose your organization to a higher risk of account takeovers and potential data loss. diff --git a/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md index 5aefe71a70..cc70e384bf 100644 --- a/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ b/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md @@ -41,7 +41,7 @@ If you manually added a Jekyll theme to your repository in the past, those files 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 in your repository](/articles/editing-files-in-your-repository/)." + - To edit the file now, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." 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. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index ff8b1ad00c..e4b10d85be 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -157,7 +157,7 @@ This errors means that you have relative permalinks, which are not supported by Permalinks are permanent URLs that reference a particular page on your site. Absolute permalinks begin with the root of the site, while relative permalinks begin with the folder containing the referenced page. {% data variables.product.prodname_pages %} and Jekyll no longer support relative permalinks. For more information about permalinks, see "[Permalinks](https://jekyllrb.com/docs/permalinks/)" in the Jekyll documentation. -To troubleshoot, remove the `relative_permalinks` line from your *_config.yml* file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[Editing files in your repository](/articles/editing-files-in-your-repository)." +To troubleshoot, remove the `relative_permalinks` line from your *_config.yml* file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." ## Symlink does not exist within your site's repository diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md b/content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md similarity index 95% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md rename to content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md index 24aa8ffeb3..288a4f81a0 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md +++ b/content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md @@ -4,6 +4,7 @@ intro: 'You can archive content and data on {% data variables.product.product_na redirect_from: - /articles/about-archiving-content-and-data-on-github - /github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github versions: fpt: '*' topics: diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-repositories.md b/content/repositories/archiving-a-github-repository/archiving-repositories.md similarity index 55% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-repositories.md rename to content/repositories/archiving-a-github-repository/archiving-repositories.md index aba8a2c047..4e35b266c3 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-repositories.md +++ b/content/repositories/archiving-a-github-repository/archiving-repositories.md @@ -1,17 +1,23 @@ --- -title: About archiving repositories -intro: 'When you archive a repository, you are letting people know that a project is no longer actively maintained.' +title: Archiving repositories +intro: You can archive a repository to make it read-only for all users and indicate that it's no longer actively maintained. You can also unarchive repositories that have been archived. redirect_from: + - /articles/archiving-repositories + - /github/creating-cloning-and-archiving-repositories/archiving-repositories - /articles/about-archiving-repositories - /github/creating-cloning-and-archiving-repositories/about-archiving-repositories + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-repositories + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/archiving-repositories versions: fpt: '*' ghes: '*' ghae: '*' topics: - Repositories -shortTitle: Repositories --- + +## About repository archival + {% ifversion fpt %} {% note %} @@ -28,5 +34,15 @@ When a repository is archived, its issues, pull requests, code, labels, mileston You can search for archived repositories. For more information, see "[Searching for repositories](/articles/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)." You can also search for issues and pull requests within archived repositories. For more information, see "[Searching issues and pull requests](/articles/searching-issues-and-pull-requests/#search-based-on-whether-a-repository-is-archived)." -## Further reading -- "[Archiving repositories](/articles/archiving-repositories)" +## Archiving a repository + +{% data reusables.repositories.archiving-repositories-recommendation %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +3. Under "Danger Zone", click **Archive this repository** or **Unarchive this repository**. + ![Archive this repository button](/assets/images/help/repository/archive-repository.png) +4. Read the warnings. +5. Type the name of the repository you want to archive or unarchive. + ![Archive repository warnings](/assets/images/help/repository/archive-repository-warnings.png) +6. Click **I understand the consequences, archive this repository**. \ No newline at end of file diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository.md b/content/repositories/archiving-a-github-repository/backing-up-a-repository.md similarity index 96% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository.md rename to content/repositories/archiving-a-github-repository/backing-up-a-repository.md index 8621fbe109..8346b22105 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository.md +++ b/content/repositories/archiving-a-github-repository/backing-up-a-repository.md @@ -4,6 +4,7 @@ intro: 'You can use{% ifversion ghes or ghae %} Git and{% endif %} the API {% if redirect_from: - /articles/backing-up-a-repository - /github/creating-cloning-and-archiving-repositories/backing-up-a-repository + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/index.md b/content/repositories/archiving-a-github-repository/index.md similarity index 87% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/index.md rename to content/repositories/archiving-a-github-repository/index.md index 86018534e0..0731ab1aab 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/index.md +++ b/content/repositories/archiving-a-github-repository/index.md @@ -5,6 +5,7 @@ redirect_from: - /articles/can-i-archive-a-repository/ - /articles/archiving-a-github-repository - /enterprise/admin/user-management/archiving-and-unarchiving-repositories + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository versions: fpt: '*' ghes: '*' @@ -12,7 +13,6 @@ versions: topics: - Repositories children: - - /about-archiving-repositories - /archiving-repositories - /about-archiving-content-and-data-on-github - /referencing-and-citing-content diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/referencing-and-citing-content.md b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md similarity index 95% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/referencing-and-citing-content.md rename to content/repositories/archiving-a-github-repository/referencing-and-citing-content.md index 67489b43e6..3a45d2a74a 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/referencing-and-citing-content.md +++ b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md @@ -4,6 +4,7 @@ intro: You can use third-party tools to cite and reference content on GitHub. redirect_from: - /articles/referencing-and-citing-content - /github/creating-cloning-and-archiving-repositories/referencing-and-citing-content + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/referencing-and-citing-content versions: fpt: '*' topics: diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md similarity index 96% rename from content/github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md index 9344e720bf..ef056afbd4 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md @@ -4,13 +4,14 @@ intro: 'You can allow contributors with push access to your repository to merge redirect_from: - /articles/about-merge-methods-on-github - /github/administering-a-repository/about-merge-methods-on-github + - /github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github versions: fpt: '*' ghes: '*' ghae: '*' topics: - Repositories -shortTitle: Merge methods +shortTitle: About merge methods --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} You can enforce one type of merge method, such as commit squashing or rebasing, by only enabling the desired method for your repository. diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md similarity index 90% rename from content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md index 29fa0c22f2..4f6145d541 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md @@ -4,6 +4,7 @@ intro: 'You can enforce, allow, or disable commit rebasing for all pull request redirect_from: - /articles/configuring-commit-rebasing-for-pull-requests - /github/administering-a-repository/configuring-commit-rebasing-for-pull-requests + - /github/administering-a-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md similarity index 93% rename from content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md index a9ec3138f1..5fb84a3881 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md @@ -4,6 +4,7 @@ intro: 'You can enforce, allow, or disable commit squashing for all pull request redirect_from: - /articles/configuring-commit-squashing-for-pull-requests - /github/administering-a-repository/configuring-commit-squashing-for-pull-requests + - /github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/index.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/index.md similarity index 89% rename from content/github/administering-a-repository/configuring-pull-request-merges/index.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/index.md index a1dfb48cc2..a91abcbaf1 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/index.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/index.md @@ -3,6 +3,7 @@ title: Configuring pull request merges intro: 'You can configure pull request merges on {% data variables.product.product_location %} to match your workflow and preferences for managing Git history.' redirect_from: - /articles/configuring-pull-request-merges + - /github/administering-a-repository/configuring-pull-request-merges versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md similarity index 92% rename from content/github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md index ead2beacd7..56560741c6 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md @@ -11,6 +11,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository + - /github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository shortTitle: Manage auto merge --- ## About auto-merge diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md similarity index 90% rename from content/github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md index 1a50625872..07111367a9 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md @@ -4,6 +4,7 @@ intro: You can have head branches automatically deleted after pull requests are redirect_from: - /articles/managing-the-automatic-deletion-of-branches - /github/administering-a-repository/managing-the-automatic-deletion-of-branches + - /github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md similarity index 99% rename from content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index 3f39c2d03a..1015a4cb4f 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -16,6 +16,7 @@ redirect_from: - /articles/about-required-reviews-for-pull-requests - /github/administering-a-repository/about-required-reviews-for-pull-requests - /github/administering-a-repository/about-protected-branches + - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/index.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/index.md similarity index 90% rename from content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/index.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/index.md index dd7feff6e8..05214ed1ac 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/index.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/index.md @@ -5,6 +5,7 @@ redirect_from: - /articles/defining-the-mergeability-of-a-pull-request/ - /articles/defining-the-mergeability-of-pull-requests - /enterprise/admin/developer-workflow/establishing-pull-request-merge-conditions + - /github/administering-a-repository/defining-the-mergeability-of-pull-requests product: '{% data reusables.gated-features.protected-branches %}' versions: fpt: '*' diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md similarity index 98% rename from content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index 3063d729e3..36b9d5b9d4 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -17,6 +17,7 @@ redirect_from: - /github/administering-a-repository/enabling-force-pushes-to-a-protected-branch - /github/administering-a-repository/enabling-deletion-of-a-protected-branch - /github/administering-a-repository/managing-a-branch-protection-rule + - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md similarity index 95% rename from content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md index 5bfc3b29b5..c4e85e1f9b 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md @@ -10,6 +10,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/troubleshooting-required-status-checks + - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks shortTitle: Required status checks --- If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)." diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/index.md b/content/repositories/configuring-branches-and-merges-in-your-repository/index.md new file mode 100644 index 0000000000..dc41e62225 --- /dev/null +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/index.md @@ -0,0 +1,16 @@ +--- +title: Configuring branches and merges in your repository +intro: 'You can manage branches in your repository, configure the way branches are merged in your repository, and protect important branches by definining the mergeability of pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /managing-branches-in-your-repository + - /configuring-pull-request-merges + - /defining-the-mergeability-of-pull-requests +shortTitle: Branches and merges +--- + diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md similarity index 97% rename from content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md index 980d6377d2..2cc3646d51 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md @@ -10,6 +10,7 @@ redirect_from: - /github/administering-a-repository/setting-the-default-branch - /articles/setting-the-default-branch - /github/administering-a-repository/changing-the-default-branch + - /github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch topics: - Repositories shortTitle: Change the default branch diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md similarity index 93% rename from content/github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md index 0fedcc959c..76797d7123 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md @@ -7,13 +7,14 @@ redirect_from: - /articles/deleting-unused-branches/ - /articles/deleting-and-restoring-branches-in-a-pull-request - /github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request + - /github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request versions: fpt: '*' ghes: '*' ghae: '*' topics: - Repositories -shortTitle: Delete & restore +shortTitle: Delete & restore branches --- ## Deleting a branch used for a pull request diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/index.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/index.md similarity index 90% rename from content/github/administering-a-repository/managing-branches-in-your-repository/index.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/index.md index b1df7012fc..03d16a668c 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/index.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/index.md @@ -3,6 +3,7 @@ title: Managing branches in your repository intro: 'Whenever you propose a change in Git, you [create a new branch](/articles/creating-and-deleting-branches-within-your-repository/). Branch management is an important part of the Git workflow. After some time, your list of branches may grow, so it''s a good idea to delete merged or stale branches.' redirect_from: - /articles/managing-branches-in-your-repository + - /github/administering-a-repository/managing-branches-in-your-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md similarity index 97% rename from content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md index ade2a1c72a..bff251c5f1 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md @@ -9,6 +9,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/renaming-a-branch + - /github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch --- ## About renaming branches diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md similarity index 94% rename from content/github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md index 35db51c0e8..02e9e94b9f 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md @@ -4,6 +4,7 @@ intro: 'Branches are central to collaboration on {% data variables.product.produ redirect_from: - /articles/viewing-branches-in-your-repository - /github/administering-a-repository/viewing-branches-in-your-repository + - /github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository versions: fpt: '*' ghes: '*' diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md new file mode 100644 index 0000000000..53fac0b5e4 --- /dev/null +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -0,0 +1,115 @@ +--- +title: About repositories +intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository. +redirect_from: + - /articles/about-repositories + - /github/creating-cloning-and-archiving-repositories/about-repositories + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories + - /github/creating-cloning-and-archiving-repositories/about-repository-visibility + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-visibility + - /articles/what-are-the-limits-for-viewing-content-and-diffs-in-my-repository + - /articles/limits-for-viewing-content-and-diffs-in-a-repository + - /github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/limits-for-viewing-content-and-diffs-in-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +--- + +## About repositories + +You can own repositories individually, or you can share ownership of repositories with other people in an organization. + +You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](#about-repository-visibility)." + +For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization/)." + +{% ifversion fpt %} +With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} +{% else %} +Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. +{% endif %} + +You can use repositories to manage your work and collaborate with others. +- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt %} +- {% data reusables.discussions.you-can-use-discussions %}{% endif %} +- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." +- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." + +{% data reusables.repositories.repo-size-limit %} + +## About repository visibility + +You can restrict who has access to a repository by choosing a repository's visibility: {% ifversion fpt or ghes %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}. + +{% ifversion ghae %}When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal.{% else %}When you create a repository, you can choose to make the repository public or private.{% ifversion fpt or ghes %} If you're creating the repository in an organization{% ifversion fpt %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %} + +{% ifversion ghes %} +If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. {% ifversion ghes %} Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %} +{% elsif ghae %} +Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." +{% else %} +Public repositories are accessible to everyone on the internet. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." +{% endif %} + +Organization owners always have access to every repository created in an organization. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." + +People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)." + +{% ifversion fpt or ghae or ghes %} +## About internal repositories + +{% note %} + +**Note:** {% data reusables.gated-features.internal-repos %} + +{% endnote %} + +{% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." + +All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt %}outside of the enterprise{% else %}who are not members of an organization{% endif %}, including outside collaborators on organization repositories. For more information, see {% ifversion fpt or ghae %}"[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and {% endif %}"[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)." + +{% data reusables.repositories.internal-repo-default %} + +If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. +{% endif %} + +## Limits for viewing content and diffs in a repository + +Certain types of resources can be quite large, requiring excessive processing on {% data variables.product.product_name %}. Because of this, limits are set to ensure requests complete in a reasonable amount of time. + +Most of the limits below affect both {% data variables.product.product_name %} and the API. + +### Text limits + +Text files over **1 MB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). + +Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. + +### Diff limits + +Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: + +- In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. +- No single file's diff may exceed *3,000 lines that you can load* or *100 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. +- The maximum number of files in a single diff is limited to *300*. +- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. + +Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. + +### Commit listings limits + +The compare view and pull requests pages display a list of commits between the `base` and `head` revisions. These lists are limited to **250** commits. If they exceed that limit, a note indicates that additional commits are present (but they're not shown). + +## Further reading + +- "[Creating a new repository](/articles/creating-a-new-repository)" +- "[Collaborating with issues and pull requests](/categories/collaborating-with-issues-and-pull-requests)" +- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" +- "[Administering a repository](/categories/administering-a-repository)" +- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)" +- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" +- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)" diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository.md b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md similarity index 96% rename from content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository.md rename to content/repositories/creating-and-managing-repositories/cloning-a-repository.md index 394b57158d..a800e35239 100644 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md @@ -3,7 +3,9 @@ title: Cloning a repository intro: 'When you create a repository on {% data variables.product.product_location %}, it exists as a remote repository. You can clone your repository to create a local copy on your computer and sync between the two locations.' redirect_from: - /articles/cloning-a-repository + - /articles/cloning-a-repository-from-github - /github/creating-cloning-and-archiving-repositories/cloning-a-repository + - /github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository versions: fpt: '*' ghes: '*' @@ -93,4 +95,4 @@ If you're unable to clone a repository, check that: ## Further reading - "[Troubleshooting connectivity problems](/articles/troubleshooting-connectivity-problems)" -{% endif %} +{% endif %} \ No newline at end of file diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md similarity index 91% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository.md rename to content/repositories/creating-and-managing-repositories/creating-a-new-repository.md index e83d96e92e..3763a7926b 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md @@ -10,6 +10,7 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/creating-an-internal-repository - /github/creating-cloning-and-archiving-repositories/creating-an-internal-repository - /github/creating-cloning-and-archiving-repositories/creating-a-new-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository versions: fpt: '*' ghes: '*' @@ -40,7 +41,7 @@ topics: ![Owner drop-down menu](/assets/images/help/repository/create-repository-owner.png) {% data reusables.repositories.repo-name %} {% data reusables.repositories.choose-repo-visibility %} -6. If you're not using a template, there are a number of optional items you can pre-populate your repository with. If you're importing an existing repository to {% data variables.product.product_name %}, don't choose any of these options, as you may introduce a merge conflict. You can add or create new files using the user interface or choose to add new files using the command line later. For more information, see "[Importing a Git repository using the command line](/articles/importing-a-git-repository-using-the-command-line/)," "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)," and "[Addressing merge conflicts](/articles/addressing-merge-conflicts/)." +6. If you're not using a template, there are a number of optional items you can pre-populate your repository with. If you're importing an existing repository to {% data variables.product.product_name %}, don't choose any of these options, as you may introduce a merge conflict. You can add or create new files using the user interface or choose to add new files using the command line later. For more information, see "[Importing a Git repository using the command line](/articles/importing-a-git-repository-using-the-command-line/)," "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)," and "[Addressing merge conflicts](/articles/addressing-merge-conflicts/)." - You can create a README, which is a document describing your project. For more information, see "[About READMEs](/articles/about-readmes/)." - You can create a *.gitignore* file, which is a set of ignore rules. For more information, see "[Ignoring files](/github/getting-started-with-github/ignoring-files)."{% ifversion fpt %} - You can choose to add a software license for your project. For more information, see "[Licensing a repository](/articles/licensing-a-repository)."{% endif %} diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template.md b/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md similarity index 95% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template.md rename to content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md index cade17c7b0..d39d5de825 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md @@ -4,6 +4,7 @@ intro: You can generate a new repository with the same directory structure and f redirect_from: - /articles/creating-a-repository-from-a-template - /github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-template-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md similarity index 93% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-template-repository.md rename to content/repositories/creating-and-managing-repositories/creating-a-template-repository.md index ac6b9880c2..48e2733234 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-template-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md @@ -5,6 +5,7 @@ permissions: Anyone with admin permissions to a repository can make the reposito redirect_from: - /articles/creating-a-template-repository - /github/creating-cloning-and-archiving-repositories/creating-a-template-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-template-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository.md b/content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md similarity index 92% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository.md rename to content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md index 44a65c5ad6..165de7dad3 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md @@ -6,6 +6,7 @@ redirect_from: - /articles/is-there-issues-only-access-to-organization-repositories/ - /articles/creating-an-issues-only-repository - /github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md similarity index 95% rename from content/github/administering-a-repository/managing-repository-settings/deleting-a-repository.md rename to content/repositories/creating-and-managing-repositories/deleting-a-repository.md index a05a574a4b..d4530795c6 100644 --- a/content/github/administering-a-repository/managing-repository-settings/deleting-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -6,6 +6,7 @@ redirect_from: - /deleting-a-repo/ - /articles/deleting-a-repository - /github/administering-a-repository/deleting-a-repository + - /github/administering-a-repository/managing-repository-settings/deleting-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md similarity index 97% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md rename to content/repositories/creating-and-managing-repositories/duplicating-a-repository.md index 2199a6bc0b..ac5642672d 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md @@ -5,6 +5,7 @@ redirect_from: - /articles/duplicating-a-repo/ - /articles/duplicating-a-repository - /github/creating-cloning-and-archiving-repositories/duplicating-a-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/repositories/creating-and-managing-repositories/index.md b/content/repositories/creating-and-managing-repositories/index.md new file mode 100644 index 0000000000..a26450047d --- /dev/null +++ b/content/repositories/creating-and-managing-repositories/index.md @@ -0,0 +1,28 @@ +--- +title: Creating and managing repositories +intro: "You can create a repository on {% data variables.product.product_name %} to store and collaborate on your project's files, then manage the repository's name and location." +redirect_from: + - /articles/creating-a-repository-on-github + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /about-repositories + - /creating-a-new-repository + - /creating-a-repository-from-a-template + - /creating-a-template-repository + - /creating-an-issues-only-repository + - /duplicating-a-repository + - /cloning-a-repository + - /troubleshooting-cloning-errors + - /renaming-a-repository + - /transferring-a-repository + - /deleting-a-repository + - /restoring-a-deleted-repository +shortTitle: Create & manage repositories +--- + diff --git a/content/github/administering-a-repository/managing-repository-settings/renaming-a-repository.md b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md similarity index 96% rename from content/github/administering-a-repository/managing-repository-settings/renaming-a-repository.md rename to content/repositories/creating-and-managing-repositories/renaming-a-repository.md index f56a1d5810..9eecf0d258 100644 --- a/content/github/administering-a-repository/managing-repository-settings/renaming-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md @@ -4,6 +4,7 @@ intro: You can rename a repository if you're either an organization owner or hav redirect_from: - /articles/renaming-a-repository - /github/administering-a-repository/renaming-a-repository + - /github/administering-a-repository/managing-repository-settings/renaming-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository.md b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md similarity index 95% rename from content/github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository.md rename to content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md index 80fee61625..01dafcadee 100644 --- a/content/github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository.md +++ b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md @@ -4,6 +4,7 @@ intro: You can restore some deleted repositories to recover their contents. redirect_from: - /articles/restoring-a-deleted-repository - /github/administering-a-repository/restoring-a-deleted-repository + - /github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository versions: fpt: '*' topics: diff --git a/content/github/administering-a-repository/managing-repository-settings/transferring-a-repository.md b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md similarity index 98% rename from content/github/administering-a-repository/managing-repository-settings/transferring-a-repository.md rename to content/repositories/creating-and-managing-repositories/transferring-a-repository.md index 7b6dc7ff31..031bbb7c85 100644 --- a/content/github/administering-a-repository/managing-repository-settings/transferring-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -13,6 +13,7 @@ redirect_from: - /articles/transferring-a-repository-owned-by-your-organization/ - /articles/transferring-a-repository - /github/administering-a-repository/transferring-a-repository + - /github/administering-a-repository/managing-repository-settings/transferring-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md new file mode 100644 index 0000000000..b37af1b131 --- /dev/null +++ b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md @@ -0,0 +1,183 @@ +--- +title: Troubleshooting cloning errors +intro: "If you're having trouble cloning a repository, check these common errors." +redirect_from: + - /articles/error-the-requested-url-returned-error-403 + - /articles/error-the-requested-url-returned-error-401 + - /articles/error-did-you-run-git-update-server-info-on-the-server + - /articles/error-the-requested-url-returned-error-403-while-accessing-https-github-com-user-repo-git-info-refs + - /articles/https-cloning-errors + - /github/creating-cloning-and-archiving-repositories/https-cloning-errors + - /articles/error-repository-not-found + - /github/creating-cloning-and-archiving-repositories/error-repository-not-found + - /articles/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout + - /github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +--- + +## HTTPS cloning errors + +There are a few common errors when using HTTPS with Git. These errors usually indicate you have an old version of Git, or you don't have access to the repository. + +Here's an example of an HTTPS error you might receive: + +```shell +> error: The requested URL returned error: 401 while accessing +> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs?service=git-receive-pack +> fatal: HTTP request failed +``` + +```shell +> Error: The requested URL returned error: 403 while accessing +> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs +> fatal: HTTP request failed +``` + +```shell +> Error: https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs not found: did you run git +> update-server-info on the server? +``` + +### Check your Git version + +There's no minimum Git version necessary to interact with {% data variables.product.product_name %}, but we've found version 1.7.10 to be a comfortable stable version that's available on many platforms. You can always [download the latest version on the Git website](https://git-scm.com/downloads). + +### Ensure the remote is correct + +The repository you're trying to fetch must exist on {% data variables.product.product_location %}, and the URL is case-sensitive. + +You can find the URL of the local repository by opening the command line and +typing `git remote -v`: + +```shell +$ git remote -v +# View existing remotes +> origin https://github.com/ghost/reactivecocoa.git (fetch) +> origin https://github.com/ghost/reactivecocoa.git (push) + +$ git remote set-url origin https://github.com/ghost/ReactiveCocoa.git +# Change the 'origin' remote's URL + +$ git remote -v +# Verify new remote URL +> origin https://github.com/ghost/ReactiveCocoa.git (fetch) +> origin https://github.com/ghost/ReactiveCocoa.git (push) +``` + +Alternatively, you can change the URL through our +[{% data variables.product.prodname_desktop %}](https://desktop.github.com/) application. + +### Provide an access token + +To access {% data variables.product.prodname_dotcom %}, you must authenticate with a personal access token instead of your password. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." + +{% data reusables.command_line.provide-an-access-token %} + +### Check your permissions + +When prompted for a username and password, make sure you use an account that has access to the repository. + +{% tip %} + +**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/getting-started-with-github/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail. + +{% endtip %} + +### Use SSH instead + +If you've previously set up SSH keys, you can use the SSH clone URL instead of HTTPS. For more information, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." + +## Error: Repository not found + +{% ifversion fpt or ghae %}If you see this error when cloning a repository, it means that the repository does not exist or you do not have permission to access it.{% else %}If you see this error when cloning a repository, it means that the repository does not exist, you do not have permission to access it, or {% data variables.product.product_location %} is in private mode.{% endif %} There are a few solutions to this error, depending on the cause. + +### Check your spelling + +Typos happen, and repository names are case-sensitive. If you try to clone `git@{% data variables.command_line.codeblock %}:user/repo.git`, but the repository is really named `User/Repo` you will receive this error. + +To avoid this error, when cloning, always copy and paste the clone URL from the repository's page. For more information, see "[Cloning a repository](/articles/cloning-a-repository)." + +To update the remote on an existing repository, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)". + +### Checking your permissions + +If you are trying to clone a private repository but do not have permission to view the repository, you will receive this error. + +Make sure that you have access to the repository in one of these ways: + +* The owner of the repository +* A [collaborator](/articles/inviting-collaborators-to-a-personal-repository) on the repository +* A [member of a team](/articles/adding-organization-members-to-a-team) that has access to the repository (if the repository belongs to an organization) + +### Check your SSH access + +In rare circumstances, you may not have the proper SSH access to a repository. + +You should ensure that the SSH key you are using is attached to your {% data variables.product.product_name %} user account. You can check this by typing +the following into the command line: + +```shell +$ ssh -T git@{% data variables.command_line.codeblock %} +> Hi username! You've successfully authenticated, but GitHub does not +> provide shell access. +``` + +If the repository belongs to an organization and you're using an SSH key generated by an OAuth App, OAuth App access may have been restricted by an organization owner. For more information, see "About OAuth App access restrictions." + +For more information, see [Adding a new SSH key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account). + +{% ifversion ghes %} +### Check if your instance is in private mode + +If your site administrator has enabled private mode on your GitHub Enterprise instance, anonymous clones over `git://` will be disabled. If you are unable to clone a repository, contact your site administrator. +{% endif %} + +### Check that the repository really exists + +If all else fails, make sure that the repository really exists on {% data variables.product.product_location %}! +If you're trying to push to a repository that doesn't exist, you'll get this error. + +## Error: Remote HEAD refers to nonexistent ref, unable to checkout + +This error occurs if the default branch of a repository has been deleted on {% data variables.product.product_location %}. + +Detecting this error is simple; Git will warn you when you try to clone the repository: + +```shell +$ git clone https://{% data variables.command_line.codeblock %}/user/repo.git +# Clone a repo +> Cloning into 'repo'... +> remote: Counting objects: 66179, done. +> remote: Compressing objects: 100% (15587/15587), done. +> remote: Total 66179 (delta 46985), reused 65596 (delta 46402) +> Receiving objects: 100% (66179/66179), 51.66 MiB | 667 KiB/s, done. +> Resolving deltas: 100% (46985/46985), done. +> warning: remote HEAD refers to nonexistent ref, unable to checkout. +``` + +To fix the error, you'll need to be an administrator of the repository on {% data variables.product.product_location %}. +You'll want to [change the default branch](/github/administering-a-repository/changing-the-default-branch) of the repository. + +After that, you can get a list of all the available branches from the command line: + +```shell +$ git branch -a +# Lists ALL the branches +> remotes/origin/awesome +> remotes/origin/more-work +> remotes/origin/new-main +``` + +Then, you can just switch to your new branch: + +```shell +$ git checkout new-main +# Create and checkout a tracking branch +> Branch new-main set up to track remote branch new-main from origin. +> Switched to a new branch 'new-main' +``` \ No newline at end of file diff --git a/content/repositories/index.md b/content/repositories/index.md new file mode 100644 index 0000000000..af493c0c64 --- /dev/null +++ b/content/repositories/index.md @@ -0,0 +1,19 @@ +--- +title: Repositories +intro: "Learn to use and manage the repositories that allow you to store and collaborate on your project's code." +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /creating-and-managing-repositories + - /managing-your-repositorys-settings-and-features + - /configuring-branches-and-merges-in-your-repository + - /working-with-files + - /releasing-projects-on-github + - /viewing-activity-and-data-for-your-repository + - /archiving-a-github-repository +--- + diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md similarity index 97% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md index 4cc5a8f7dd..e2368c2e8d 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md @@ -1,6 +1,8 @@ --- title: About CITATION files intro: You can add a CITATION file to your repository to help users correctly cite your software. +redirect_from: + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files versions: fpt: '*' ghes: '>=3.3' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md similarity index 98% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 434033d128..fbdbfe5546 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -5,6 +5,7 @@ redirect_from: - /articles/about-codeowners/ - /articles/about-code-owners - /github/creating-cloning-and-archiving-repositories/about-code-owners + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners product: '{% data reusables.gated-features.code-owners %}' versions: fpt: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md similarity index 97% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md index 29444823a4..53e463b5f2 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md @@ -6,6 +6,7 @@ redirect_from: - /articles/relative-links-in-readmes/ - /articles/about-readmes - /github/creating-cloning-and-archiving-repositories/about-readmes + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-languages.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md similarity index 93% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-languages.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md index 9bf74a5607..7e4feab23f 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-languages.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md @@ -9,6 +9,7 @@ redirect_from: - /articles/why-isn-t-my-favorite-language-recognized-by-github/ - /articles/about-repository-languages - /github/creating-cloning-and-archiving-repositories/about-repository-languages + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-languages versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md similarity index 96% rename from content/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index d9c824488d..676e63f892 100644 --- a/content/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -5,6 +5,7 @@ redirect_from: - /articles/about-topics/ - /articles/classifying-your-repository-with-topics - /github/administering-a-repository/classifying-your-repository-with-topics + - /github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/customizing-your-repositorys-social-media-preview.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md similarity index 91% rename from content/github/administering-a-repository/managing-repository-settings/customizing-your-repositorys-social-media-preview.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md index ef6570cb7f..ea4a96c1db 100644 --- a/content/github/administering-a-repository/managing-repository-settings/customizing-your-repositorys-social-media-preview.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md @@ -4,6 +4,7 @@ intro: You can customize the image displayed on social media platforms when some redirect_from: - /articles/customizing-your-repositorys-social-media-preview - /github/administering-a-repository/customizing-your-repositorys-social-media-preview + - /github/administering-a-repository/managing-repository-settings/customizing-your-repositorys-social-media-preview versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md similarity index 97% rename from content/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index 2c1da6922e..27c000d7c6 100644 --- a/content/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -5,6 +5,7 @@ redirect_from: - /github/building-a-strong-community/displaying-a-sponsor-button-in-your-repository - /articles/displaying-a-sponsor-button-in-your-repository - /github/administering-a-repository/displaying-a-sponsor-button-in-your-repository + - /github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository versions: fpt: '*' topics: diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/index.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/index.md new file mode 100644 index 0000000000..0ce1d90b9b --- /dev/null +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/index.md @@ -0,0 +1,21 @@ +--- +title: Customizing your repository +intro: 'You can choose the way your repository appears by customizing your repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /about-readmes + - /licensing-a-repository + - /displaying-a-sponsor-button-in-your-repository + - /customizing-your-repositorys-social-media-preview + - /classifying-your-repository-with-topics + - /about-code-owners + - /about-repository-languages + - /about-citation-files +shortTitle: Customize your repository +--- + diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md similarity index 98% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md index 5e0688fcda..e60ae9919c 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md @@ -5,6 +5,7 @@ redirect_from: - /articles/open-source-licensing/ - /articles/licensing-a-repository - /github/creating-cloning-and-archiving-repositories/licensing-a-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/disabling-issues.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md similarity index 92% rename from content/github/administering-a-repository/managing-repository-settings/disabling-issues.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md index da7deb38d0..4f6b9cc926 100644 --- a/content/github/administering-a-repository/managing-repository-settings/disabling-issues.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md @@ -5,6 +5,7 @@ redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/disabling-issues - /articles/disabling-issues - /github/managing-your-work-on-github/disabling-issues + - /github/administering-a-repository/managing-repository-settings/disabling-issues versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/disabling-project-boards-in-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md similarity index 91% rename from content/github/administering-a-repository/managing-repository-settings/disabling-project-boards-in-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md index 3d4b5f445a..97c1635490 100644 --- a/content/github/administering-a-repository/managing-repository-settings/disabling-project-boards-in-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md @@ -5,6 +5,7 @@ redirect_from: - /github/managing-your-work-on-github/managing-project-boards/disabling-project-boards-in-a-repository - /articles/disabling-project-boards-in-a-repository - /github/managing-your-work-on-github/disabling-project-boards-in-a-repository + - /github/administering-a-repository/managing-repository-settings/disabling-project-boards-in-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md similarity index 90% rename from content/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md index ad389dc1e9..f8bba603f4 100644 --- a/content/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md @@ -9,6 +9,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository + - /github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository shortTitle: Discussions --- diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/index.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/index.md new file mode 100644 index 0000000000..9ad3dc1f15 --- /dev/null +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/index.md @@ -0,0 +1,18 @@ +--- +title: Enabling features for your repository +intro: 'You can enable, configure, and disable optional features for your repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /disabling-issues + - /disabling-project-boards-in-a-repository + - /managing-github-actions-settings-for-a-repository + - /enabling-or-disabling-github-discussions-for-a-repository + - /managing-security-and-analysis-settings-for-your-repository +shortTitle: Enable features +--- + diff --git a/content/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md similarity index 80% rename from content/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md index 9847112fb8..04adf61378 100644 --- a/content/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -1,16 +1,20 @@ --- -title: Disabling or limiting GitHub Actions for a repository -intro: 'Repository owners can disable, enable, and limit {% data variables.product.prodname_actions %} for a specific repository.' +title: Managing GitHub Actions settings for a repository +intro: 'You can disable or configure {% data variables.product.prodname_actions %} for a specific repository.' +redirect_from: + - /github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository + - /github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository + - /github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository + - /github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository versions: fpt: '*' ghes: '*' ghae: '*' topics: - - Repositories -redirect_from: - - /github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository -shortTitle: GitHub Actions + - Pull requests +shortTitle: Manage GitHub Actions settings --- + {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} @@ -119,3 +123,20 @@ The default permissions can also be configured in the organization settings. If ![Set GITHUB_TOKEN permissions for this repository](/assets/images/help/settings/actions-workflow-permissions-repository.png) 1. Click **Save** to apply the settings. {% endif %} + +{% ifversion fpt or ghes > 2.22 or ghae %} +## Configuring the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository + +You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository. + +{% data reusables.actions.about-artifact-log-retention %} + +You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)." + +## Setting the retention period for a repository + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.settings-sidebar-actions %} +{% data reusables.github-actions.change-retention-period-for-artifacts-logs %} +{% endif %} \ No newline at end of file diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md similarity index 98% rename from content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md index b56b1d9a33..e188911b9a 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -8,6 +8,7 @@ redirect_from: - /articles/managing-alerts-for-vulnerable-dependencies-in-your-organization - /github/managing-security-vulnerabilities/managing-alerts-for-vulnerable-dependencies-in-your-organization - /github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository + - /github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository versions: fpt: '*' ghes: '>=3.0' diff --git a/content/repositories/managing-your-repositorys-settings-and-features/index.md b/content/repositories/managing-your-repositorys-settings-and-features/index.md new file mode 100644 index 0000000000..ad219941a2 --- /dev/null +++ b/content/repositories/managing-your-repositorys-settings-and-features/index.md @@ -0,0 +1,20 @@ +--- +title: Managing your repository’s settings and features +intro: "You can customize your repository, enable or disable optional features for your repository, and manage your repository’s settings." +redirect_from: + - /categories/administering-a-repository + - /articles/managing-repository-settings + - /github/administering-a-repository/managing-repository-settings +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /customizing-your-repository + - /enabling-features-for-your-repository + - /managing-repository-settings +shortTitle: Manage repository settings +--- + diff --git a/content/github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md similarity index 97% rename from content/github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md index ae16032718..807b349dc8 100644 --- a/content/github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md @@ -8,6 +8,7 @@ redirect_from: - /articles/about-email-notifications-for-pushes-to-your-repository/ - /github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository - /github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository + - /github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md similarity index 94% rename from content/github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md index df168f0590..2070d9a169 100644 --- a/content/github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.autolinks %}' redirect_from: - /articles/configuring-autolinks-to-reference-external-resources - /github/administering-a-repository/configuring-autolinks-to-reference-external-resources + - /github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md similarity index 91% rename from content/github/administering-a-repository/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md index e7cbeb2dcb..b53513d3a4 100644 --- a/content/github/administering-a-repository/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md @@ -4,6 +4,7 @@ intro: 'As a repository administrator, you can enable or disable anonymous Git r redirect_from: - /articles/enabling-anonymous-git-read-access-for-a-repository - /github/administering-a-repository/enabling-anonymous-git-read-access-for-a-repository + - /github/administering-a-repository/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository versions: ghes: '*' shortTitle: Anonymous Git read access diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/index.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/index.md new file mode 100644 index 0000000000..aba77f6401 --- /dev/null +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/index.md @@ -0,0 +1,20 @@ +--- +title: Managing repository settings +intro: 'You can choose the way your repository functions by managing repository settings.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /setting-repository-visibility + - /managing-teams-and-people-with-access-to-your-repository + - /managing-the-forking-policy-for-your-repository + - /managing-git-lfs-objects-in-archives-of-your-repository + - /enabling-anonymous-git-read-access-for-a-repository + - /about-email-notifications-for-pushes-to-your-repository + - /configuring-autolinks-to-reference-external-resources +shortTitle: Manage repository settings +--- + diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md similarity index 95% rename from content/github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md index 5f644fe356..26a22595b8 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md @@ -9,6 +9,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository + - /github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository --- ## About {% data variables.large_files.product_name_short %} objects in archives diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md similarity index 96% rename from content/github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md index dcbf6d42e9..8cdb30c226 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md @@ -5,6 +5,7 @@ permissions: Repository administrators can manage teams and people with access t redirect_from: - /github/administering-a-repository/managing-people-and-teams-with-access-to-your-repository - /github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository + - /github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository versions: fpt: '*' topics: diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md similarity index 93% rename from content/github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index 4c2d133427..54bbe04e21 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -5,6 +5,7 @@ redirect_from: - /articles/allowing-people-to-fork-a-private-repository-owned-by-your-organization - /github/administering-a-repository/allowing-people-to-fork-a-private-repository-owned-by-your-organization - /github/administering-a-repository/managing-the-forking-policy-for-your-repository + - /github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository permissions: People with admin permissions for a repository can manage the forking policy for the repository. versions: fpt: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md similarity index 97% rename from content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 28652861bd..2d96b81446 100644 --- a/content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -7,6 +7,7 @@ redirect_from: - /articles/converting-a-public-repo-to-a-private-repo/ - /articles/setting-repository-visibility - /github/administering-a-repository/setting-repository-visibility + - /github/administering-a-repository/managing-repository-settings/setting-repository-visibility versions: fpt: '*' ghes: '*' @@ -89,4 +90,4 @@ For information about improving repository security, see "[Securing your reposit ## Further reading -- "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)" +- "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" diff --git a/content/github/administering-a-repository/releasing-projects-on-github/about-releases.md b/content/repositories/releasing-projects-on-github/about-releases.md similarity index 97% rename from content/github/administering-a-repository/releasing-projects-on-github/about-releases.md rename to content/repositories/releasing-projects-on-github/about-releases.md index e9586e5adc..dc014f7585 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/about-releases.md +++ b/content/repositories/releasing-projects-on-github/about-releases.md @@ -8,6 +8,7 @@ redirect_from: - /articles/getting-the-download-count-for-your-releases - /github/administering-a-repository/getting-the-download-count-for-your-releases - /github/administering-a-repository/about-releases + - /github/administering-a-repository/releasing-projects-on-github/about-releases versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md b/content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md similarity index 95% rename from content/github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md rename to content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md index 687002fe25..c82db87424 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md +++ b/content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md @@ -4,6 +4,7 @@ intro: 'To quickly create releases by auto-populating the new release form with redirect_from: - /articles/automation-for-release-forms-with-query-parameters - /github/administering-a-repository/automation-for-release-forms-with-query-parameters + - /github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/comparing-releases.md b/content/repositories/releasing-projects-on-github/comparing-releases.md similarity index 90% rename from content/github/administering-a-repository/releasing-projects-on-github/comparing-releases.md rename to content/repositories/releasing-projects-on-github/comparing-releases.md index dcf989a79d..5f3e0b5373 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/comparing-releases.md +++ b/content/repositories/releasing-projects-on-github/comparing-releases.md @@ -10,6 +10,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/comparing-releases + - /github/administering-a-repository/releasing-projects-on-github/comparing-releases --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} diff --git a/content/github/administering-a-repository/releasing-projects-on-github/index.md b/content/repositories/releasing-projects-on-github/index.md similarity index 89% rename from content/github/administering-a-repository/releasing-projects-on-github/index.md rename to content/repositories/releasing-projects-on-github/index.md index 4839987267..14d8bc84fc 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/index.md +++ b/content/repositories/releasing-projects-on-github/index.md @@ -4,6 +4,7 @@ intro: 'You can create a release to package software, release notes, and binary redirect_from: - /categories/85/articles/ - /categories/releases/ + - /github/administering-a-repository/releasing-projects-on-github versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/linking-to-releases.md b/content/repositories/releasing-projects-on-github/linking-to-releases.md similarity index 90% rename from content/github/administering-a-repository/releasing-projects-on-github/linking-to-releases.md rename to content/repositories/releasing-projects-on-github/linking-to-releases.md index f7165ea51b..dccbafff7d 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/linking-to-releases.md +++ b/content/repositories/releasing-projects-on-github/linking-to-releases.md @@ -4,6 +4,7 @@ intro: You can share every release you create on GitHub with a unique URL. redirect_from: - /articles/linking-to-releases - /github/administering-a-repository/linking-to-releases + - /github/administering-a-repository/releasing-projects-on-github/linking-to-releases versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository.md b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md similarity index 98% rename from content/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository.md rename to content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md index df2db8dd36..cc2628e23d 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository.md +++ b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md @@ -9,6 +9,7 @@ redirect_from: - /github/administering-a-repository/creating-releases - /github/administering-a-repository/editing-and-deleting-releases - /github/administering-a-repository/managing-releases-in-a-repository + - /github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository permissions: 'Repository collaborators and people with write access to a repository can create, edit, and delete a release.' versions: fpt: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md similarity index 92% rename from content/github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md rename to content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md index d15f57e53e..0ecb8b806e 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md +++ b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md @@ -6,6 +6,7 @@ redirect_from: - /articles/viewing-your-repositorys-tags - /github/administering-a-repository/viewing-your-repositorys-tags - /github/administering-a-repository/viewing-your-repositorys-releases-and-tags + - /github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags versions: fpt: '*' ghes: '*' diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/about-repository-graphs.md b/content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md similarity index 78% rename from content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/about-repository-graphs.md rename to content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md index 84028f731b..1337718b2d 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/about-repository-graphs.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md @@ -5,6 +5,7 @@ redirect_from: - /articles/using-graphs/ - /articles/about-repository-graphs - /github/visualizing-repository-data-with-graphs/about-repository-graphs + - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/about-repository-graphs versions: fpt: '*' ghes: '*' @@ -26,10 +27,4 @@ Some repository graphs are available only in public repositories with {% data va All other repository graphs are available in all repositories. Every repository graph is available in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} -{% endif %} - -## Further reading - -- "[Accessing basic repository data](/articles/accessing-basic-repository-data)" -- "[Analyzing changes to a repository's content](/articles/analyzing-changes-to-a-repository-s-content)" -- "[Understanding connections between repositories](/articles/understanding-connections-between-repositories)" +{% endif %} \ No newline at end of file diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/about-the-dependency-graph.md b/content/repositories/viewing-activity-and-data-for-your-repository/about-the-dependency-graph.md similarity index 97% rename from content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/about-the-dependency-graph.md rename to content/repositories/viewing-activity-and-data-for-your-repository/about-the-dependency-graph.md index 5d263c17f8..27ede81180 100644 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/about-the-dependency-graph.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/about-the-dependency-graph.md @@ -7,6 +7,7 @@ topics: - Repositories redirect_from: - /github/visualizing-repository-data-with-graphs/about-the-dependency-graph + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/about-the-dependency-graph shortTitle: Dependency graph --- diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md new file mode 100644 index 0000000000..753d86afb7 --- /dev/null +++ b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md @@ -0,0 +1,59 @@ +--- +title: Analyzing changes to a repository's content +intro: "You can see the changes to the content of a repository by analyzing the repository's commits, commit frequency, and content additions and deletions." +product: '{% data reusables.gated-features.repository-insights %}' +redirect_from: + - /articles/visualizing-additions-and-deletions-to-content-in-a-repository + - /github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository + - /articles/viewing-commit-frequency-in-a-repository + - /articles/analyzing-changes-to-a-repository-s-content + - /articles/analyzing-changes-to-a-repositorys-content + - /articles/visualizing-commits-in-a-repository + - /github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository + - /github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content + - /github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-commits-in-a-repository + - /github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-additions-and-deletions-to-content-in-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Analyze changes +--- + +## Visualizing commits in a repository + +You can see all commits made to a repository in the past year (excluding merge commits) in the Commit graph. + +The top graph shows commits for the entire year by week. + +![Repository commit year graph](/assets/images/help/graphs/repo_commit_activity_year_graph.png) + +The bottom graph shows the average number of commits by day of the week for the selected week. + +![Repository commit week graph](/assets/images/help/graphs/repo_commit_activity_week_graph.png) + +### Accessing the commits graph + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +3. In the left sidebar, click **Commits**. +![Commits tab](/assets/images/help/graphs/commits_tab.png) + +## Visualizing additions and deletion to content in a repository + +The code frequency graph displays the content additions and deletions for each week in a repository's history. + +{% ifversion fpt %} + +![Code frequency graph](/assets/images/help/graphs/repo_code_frequency_graph_dotcom.png) + +{% endif %} + +### Accessing the code frequency graph + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +3. In the left sidebar, click **Code frequency**. +![Code frequency tab](/assets/images/help/graphs/code_frequency_tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/exploring-the-dependencies-of-a-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/exploring-the-dependencies-of-a-repository.md similarity index 93% rename from content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/exploring-the-dependencies-of-a-repository.md rename to content/repositories/viewing-activity-and-data-for-your-repository/exploring-the-dependencies-of-a-repository.md index 97e99aea6b..c5dd50c20a 100644 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/exploring-the-dependencies-of-a-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/exploring-the-dependencies-of-a-repository.md @@ -7,6 +7,7 @@ topics: - Repositories redirect_from: - /github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/exploring-the-dependencies-of-a-repository shortTitle: Explore dependencies --- diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/index.md b/content/repositories/viewing-activity-and-data-for-your-repository/index.md new file mode 100644 index 0000000000..79ba712829 --- /dev/null +++ b/content/repositories/viewing-activity-and-data-for-your-repository/index.md @@ -0,0 +1,28 @@ +--- +title: Viewing activity and data for your repository +intro: 'Gain insight into your repository by viewing activity and data.' +redirect_from: + - /categories/44/articles + - /categories/graphs-and-contributions + - /categories/graphs + - /categories/visualizing-repository-data-with-graphs + - /github/visualizing-repository-data-with-graphs +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /viewing-deployment-activity-for-your-repository + - /about-repository-graphs + - /viewing-a-summary-of-repository-activity + - /viewing-traffic-to-a-repository + - /viewing-a-projects-contributors + - /analyzing-changes-to-a-repositorys-content + - /understanding-connections-between-repositories + - /about-the-dependency-graph + - /exploring-the-dependencies-of-a-repository +shortTitle: View activity and data +--- + diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md new file mode 100644 index 0000000000..018935cbc7 --- /dev/null +++ b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md @@ -0,0 +1,78 @@ +--- +title: Understanding connections between repositories +intro: "You can better understand the connections that exist between repositories by viewing a repository's network and forks and the projects that depend on the repository." +redirect_from: + - /articles/viewing-a-repository-s-network + - /articles/viewing-a-repositorys-network + - /github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network + - /articles/understanding-connections-between-repositories + - /articles/listing-the-forks-of-a-repository + - /github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository + - /github/visualizing-repository-data-with-graphs/viewing-the-dependencies-of-a-repository + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-a-repositorys-network + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/listing-the-forks-of-a-repository + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-the-dependencies-of-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Connections between repositories +--- + +## Viewing a repository's network + +'The network graph displays the branch history of the entire repository network, including branches of the root repository and branches of forks that contain commits unique to the network.' +product: '{% data reusables.gated-features.repository-insights %}' + +![Repository network graph](/assets/images/help/graphs/repo_network_graph.png) + +{% tip %} + +**Tip:** To see older branches, click and drag within the graph. + +{% endtip %} + +## Accessing the network graph + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +3. In the left sidebar, click **Network**. +![Network tab](/assets/images/help/graphs/network_tab.png) + +## Listing the forks of a repository + +The Members graph displays all the forks of a repository. + +Forks are listed alphabetically by the username of the person who forked the repository. You can click on the username to be redirected to the user's {% data variables.product.product_name %} profile page or click on the fork name to be redirected to the specific fork of the repository. + +{% ifversion fpt %} + +![Repository members graph](/assets/images/help/graphs/repo_forks_graph_dotcom.png) + +{% else %} + +![Repository members graph](/assets/images/help/graphs/repo_members_graph.png) + +{% endif %} + +### Accessing the Members graph + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +3. In the left sidebar, click **Forks**. +![Forks tab](/assets/images/help/graphs/graphs-sidebar-forks-tab.png) + +{% ifversion fpt or ghes > 2.22 %} +## Viewing the dependencies of a repository + +You can use the dependency graph to explore the code your repository depends on. + +Almost all software relies on code developed and maintained by other developers, often known as a supply chain. For example, utilities, libraries, and frameworks. These dependencies are an integral part of your code and any bugs or vulnerabilities in them may affect your code. It's important to review and maintain these dependencies. + +The dependency graph provides a great way to visualize and explore the dependencies for a repository. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)" and "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository)." + +You can also set up your repository so that {% data variables.product.company_short %} alerts you automatically whenever a security vulnerability is found in one of your dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." +{% endif %} \ No newline at end of file diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-projects-contributors.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md similarity index 96% rename from content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-projects-contributors.md rename to content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md index 69f974751d..8966d5e672 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-projects-contributors.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md @@ -6,6 +6,7 @@ redirect_from: - /articles/viewing-contribution-activity-in-a-repository/ - /articles/viewing-a-projects-contributors - /github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors + - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-projects-contributors product: '{% data reusables.gated-features.repository-insights %}' versions: fpt: '*' diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md similarity index 60% rename from content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity.md rename to content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md index f56e9edc9d..27fb1688d2 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md @@ -1,10 +1,11 @@ --- title: Viewing a summary of repository activity -intro: 'You can view an overview of a repository''s activity through Pulse. Pulse includes a list of open and merged pull requests, open and closed issues, and a graph showing the commit activity for the top 15 users who committed to the default branch of the project in the selected [time period](/articles/viewing-a-summary-of-repository-activity#filtering-by-time).' +intro: "You can view an overview of a repository's pull request, issue, and commit activity." product: '{% data reusables.gated-features.repository-insights %}' redirect_from: - /articles/viewing-a-summary-of-repository-activity - /github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity + - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity versions: fpt: '*' ghes: '*' @@ -13,9 +14,14 @@ topics: - Repositories shortTitle: View repository activity --- + +## About Pulse + +You can view an overview of a repository's activity through Pulse. Pulse includes a list of open and merged pull requests, open and closed issues, and a graph showing the commit activity for the top 15 users who committed to the default branch of the project in the selected [time period](/articles/viewing-a-summary-of-repository-activity#filtering-by-time). + Commit co-authors are included in the commit activity summary if their commits were merged into the repository's default branch and they're in the top 15 users who have contributed the most commits. -## Accessing pulse +## Accessing Pulse {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} @@ -24,4 +30,4 @@ Commit co-authors are included in the commit activity summary if their commits w By default, Pulse shows the last seven days of repository activity. To choose a different time period, click the **Period** dropdown in the upper-right corner of the Pulse overview. -![Filtering Pulse activity by time](/assets/images/help/pulse/pulse_time_filter_dropdown.png) +![Filtering Pulse activity by time](/assets/images/help/pulse/pulse_time_filter_dropdown.png) \ No newline at end of file diff --git a/content/github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md similarity index 92% rename from content/github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository.md rename to content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md index f1da1d62fa..3ddfeff71c 100644 --- a/content/github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md @@ -4,6 +4,7 @@ intro: You can view information about deployments for your entire repository or redirect_from: - /articles/viewing-deployment-activity-for-your-repository - /github/administering-a-repository/viewing-deployment-activity-for-your-repository + - /github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-traffic-to-a-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md similarity index 93% rename from content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-traffic-to-a-repository.md rename to content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md index e30f0a1c35..692f781636 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-traffic-to-a-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md @@ -5,12 +5,14 @@ product: 'This repository insights graph is available in public repositories wit redirect_from: - /articles/viewing-traffic-to-a-repository - /github/visualizing-repository-data-with-graphs/viewing-traffic-to-a-repository + - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-traffic-to-a-repository versions: fpt: '*' topics: - Repositories -shortTitle: View traffic to a repository +shortTitle: View repository traffic --- + You can navigate to referring sites, excluding search engines and {% data variables.product.product_name %} itself, from the links the specific paths were referred from. The popular content links to the specific content that generated traffic. Referring sites and popular content are ordered by views and unique visitors. Full clones and visitor information update hourly, while referring sites and popular content sections update daily. All data in the traffic graph uses the UTC+0 timezone, regardless of your location. diff --git a/content/repositories/working-with-files/index.md b/content/repositories/working-with-files/index.md new file mode 100644 index 0000000000..d5e323b6ea --- /dev/null +++ b/content/repositories/working-with-files/index.md @@ -0,0 +1,21 @@ +--- +title: Working with files +intro: 'Learn how to manage and use files in repositories.' +redirect_from: + - /categories/81/articles/ + - /categories/manipulating-files/ + - /categories/managing-files-in-a-repository + - /github/managing-files-in-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /managing-files + - /using-files + - /managing-large-files +shortTitle: Work with files +--- + diff --git a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md new file mode 100644 index 0000000000..2c1635a128 --- /dev/null +++ b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md @@ -0,0 +1,74 @@ +--- +title: Adding a file to a repository +intro: 'You can upload and commit an existing file to a repository on {% data variables.product.product_name %} or by using the command line.' +redirect_from: + - /articles/adding-a-file-to-a-repository + - /github/managing-files-in-a-repository/adding-a-file-to-a-repository + - /articles/adding-a-file-to-a-repository-from-the-command-line + - /articles/adding-a-file-to-a-repository-using-the-command-line + - /github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line + - /github/managing-files-in-a-repository/managing-files-on-github/adding-a-file-to-a-repository + - /github/managing-files-in-a-repository/managing-files-using-the-command-line/adding-a-file-to-a-repository-using-the-command-line +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Add a file +--- + +## Adding a file to a repository on {% data variables.product.product_name %} + +Files that you add to a repository via a browser are limited to {% data variables.large_files.max_github_browser_size %} per file. You can add larger files, up to {% data variables.large_files.max_github_size %} each, via the command line. For more information, see "[Adding a file to a repository using the command line](#adding-a-file-to-a-repository-using-the-command-line)." + +{% tip %} + +**Tips:** +- You can upload multiple files to {% data variables.product.product_name %} at the same time. +- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} + +{% endtip %} + +{% data reusables.repositories.navigate-to-repo %} +2. Above the list of files, using the **Add file** drop-down, click **Upload files**. + !["Upload files" in the "Add file" dropdown](/assets/images/help/repository/upload-files-button.png) +3. Drag and drop the file or folder you'd like to upload to your repository onto the file tree. +![Drag and drop area](/assets/images/help/repository/upload-files-drag-and-drop.png) +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +6. Click **Commit changes**. +![Commit changes button](/assets/images/help/repository/commit-changes-button.png) + +## Adding a file to a repository using the command line + +You can upload an existing file to a {% data variables.product.product_name %} repository using the command line. + +{% tip %} + +**Tip:** You can also [add an existing file to a repository from the {% data variables.product.product_name %} website](/articles/adding-a-file-to-a-repository). + +{% endtip %} + +{% data reusables.command_line.manipulating_file_prereqs %} + +{% data reusables.repositories.sensitive-info-warning %} + +1. On your computer, move the file you'd like to upload to {% data variables.product.product_name %} into the local directory that was created when you cloned the repository. +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +{% data reusables.git.stage_for_commit %} + ```shell + $ git add . + # Adds the file to your local repository and stages it for commit. {% data reusables.git.unstage-codeblock %} + ``` +{% data reusables.git.commit-file %} + ```shell + $ git commit -m "Add existing file" + # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} + ``` +{% data reusables.git.git-push %} + +## Further reading + +- "[Adding an existing project to GitHub using the command line](/articles/adding-an-existing-project-to-github-using-the-command-line)" diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/creating-new-files.md b/content/repositories/working-with-files/managing-files/creating-new-files.md similarity index 87% rename from content/github/managing-files-in-a-repository/managing-files-on-github/creating-new-files.md rename to content/repositories/working-with-files/managing-files/creating-new-files.md index 987b2e5544..ecca7cca08 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/creating-new-files.md +++ b/content/repositories/working-with-files/managing-files/creating-new-files.md @@ -4,6 +4,7 @@ intro: 'You can create new files directly on {% data variables.product.product_n redirect_from: - /articles/creating-new-files - /github/managing-files-in-a-repository/creating-new-files + - /github/managing-files-in-a-repository/managing-files-on-github/creating-new-files versions: fpt: '*' ghes: '*' @@ -30,9 +31,4 @@ When creating a file on {% data variables.product.product_name %}, consider the {% 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 - -- "[Adding a file to a repository](/articles/adding-a-file-to-a-repository)" -- "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)" +{% data reusables.files.propose_new_file %} \ No newline at end of file diff --git a/content/github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github.md b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md similarity index 92% rename from content/github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github.md rename to content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md index b0411f6e79..59375927d5 100644 --- a/content/github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github.md +++ b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md @@ -4,6 +4,7 @@ intro: 'To keep certain files from displaying in diffs by default, or counting t redirect_from: - /articles/customizing-how-changed-files-appear-on-github - /github/administering-a-repository/customizing-how-changed-files-appear-on-github + - /github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/deleting-files-in-a-repository.md b/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md similarity index 96% rename from content/github/managing-files-in-a-repository/managing-files-on-github/deleting-files-in-a-repository.md rename to content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md index 8daacce7a6..194d4dfdb2 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/deleting-files-in-a-repository.md +++ b/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md @@ -6,6 +6,7 @@ redirect_from: - /github/managing-files-in-a-repository/deleting-files - /github/managing-files-in-a-repository/deleting-a-file-or-directory - /github/managing-files-in-a-repository/deleting-files-in-a-repository + - /github/managing-files-in-a-repository/managing-files-on-github/deleting-files-in-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/repositories/working-with-files/managing-files/editing-files.md b/content/repositories/working-with-files/managing-files/editing-files.md new file mode 100644 index 0000000000..087dcc1eca --- /dev/null +++ b/content/repositories/working-with-files/managing-files/editing-files.md @@ -0,0 +1,61 @@ +--- +title: Editing files +intro: 'You can edit files directly on {% data variables.product.product_name %} in any of your repositories using the file editor.' +redirect_from: + - /articles/editing-files/ + - /articles/editing-files-in-your-repository + - /github/managing-files-in-a-repository/editing-files-in-your-repository + - /articles/editing-files-in-another-user-s-repository + - /github/managing-files-in-a-repository/editing-files-in-another-users-repository + - /github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository + - /github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Edit files +--- + +## Editing files in your repository + +{% tip %} + +**Tip**: {% data reusables.repositories.protected-branches-block-web-edits-uploads %} + +{% endtip %} + +{% note %} + +**Note:** {% data variables.product.product_name %}'s file editor uses [CodeMirror](https://codemirror.net/). + +{% endnote %} + +1. In your repository, browse to the file you want to edit. +{% data reusables.repositories.edit-file %} +3. On the **Edit file** tab, make any changes you need to the file. +![New content in file](/assets/images/help/repository/edit-readme-light.png) +{% data reusables.files.preview_change %} +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose-commit-email %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_file_change %} + +## Editing files in another user's repository + +When you edit a file in another user's repository, we'll automatically [fork the repository](/articles/fork-a-repo) and [open a pull request](/articles/creating-a-pull-request) for you. + +1. In another user's repository, browse to the folder that contains the file you want to edit. Click the name of the file you want to edit. +2. Above the file content, click {% octicon "pencil" aria-label="The edit icon" %}. At this point, GitHub forks the repository for you. +3. Make any changes you need to the file. +![New content in file](/assets/images/help/repository/edit-readme-light.png) +{% data reusables.files.preview_change %} +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose-commit-email %} +6. Click **Propose file change**. +![Commit Changes button](/assets/images/help/repository/propose_file_change_button.png) +7. Type a title and description for your pull request. +![Pull Request description page](/assets/images/help/pull_requests/pullrequest-description.png) +8. Click **Create pull request**. +![Pull Request button](/assets/images/help/pull_requests/pullrequest-send.png) \ No newline at end of file diff --git a/content/repositories/working-with-files/managing-files/index.md b/content/repositories/working-with-files/managing-files/index.md new file mode 100644 index 0000000000..c904a83ac7 --- /dev/null +++ b/content/repositories/working-with-files/managing-files/index.md @@ -0,0 +1,23 @@ +--- +title: Managing files +intro: 'You can create, edit, move, and delete files in a repository, directly on {% data variables.product.product_name %} or on the command line.' +redirect_from: + - /articles/managing-files-on-github + - /github/managing-files-in-a-repository/managing-files-on-github + - /github/managing-files-in-a-repository/managing-files-using-the-command-line +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /creating-new-files + - /adding-a-file-to-a-repository + - /moving-a-file-to-a-new-location + - /editing-files + - /renaming-a-file + - /deleting-files-in-a-repository + - /customizing-how-changed-files-appear-on-github +--- + diff --git a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md new file mode 100644 index 0000000000..6addae1bef --- /dev/null +++ b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md @@ -0,0 +1,93 @@ +--- +title: Moving a file to a new location +intro: 'You can move a file to a different directory on {% data variables.product.product_name %} or by using the command line.' +redirect_from: + - /articles/moving-a-file-to-a-new-location + - /github/managing-files-in-a-repository/moving-a-file-to-a-new-location + - /articles/moving-a-file-to-a-new-location-using-the-command-line + - /github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line + - /github/managing-files-in-a-repository/managing-files-on-github/moving-a-file-to-a-new-location + - /github/managing-files-in-a-repository/managing-files-using-the-command-line/moving-a-file-to-a-new-location-using-the-command-line +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Move a file +--- +In addition to changing the file location, you can also [update the contents of your file](/articles/editing-files-in-your-repository), or [give it a new name](/articles/renaming-a-file) in the same commit. + +## Moving a file to a new location on {% data variables.product.product_name %} + +{% tip %} + +**Tips**: + +- If you try to move a file in a repository that you don’t have access to, we'll fork the project to your user account and help you send [a pull request](/articles/about-pull-requests) to the original repository after you commit your change. +- Some files, such as images, require that you move them from the command line. For more information, see "[Moving a file to a new location using the command line](/articles/moving-a-file-to-a-new-location-using-the-command-line)". +- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} + +{% endtip %} + +1. In your repository, browse to the file you want to move. +2. In the upper right corner of the file view, click {% octicon "pencil" aria-label="The edit icon" %} to open the file editor. +![Edit file icon](/assets/images/help/repository/move-file-edit-file-icon.png) +3. In the filename field, change the name of the file using these guidelines: + ![Editing a file name](/assets/images/help/repository/moving_files.gif) + - To move the file **into a subfolder**, type the name of the folder you want, followed by `/`. Your new folder name becomes a new item in the navigation breadcrumbs. + - To move the file into a directory **above the file's current location**, place your cursor at the beginning of the filename field, then either type `../` to jump up one full directory level, or type the `backspace` key to edit the parent folder's name. +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_file_change %} + +## Moving a file to a new location using the command line + +You can use the command line to move files within a repository by removing the file from the old location and then adding it in the new location. + +Many files can be [moved directly on {% data variables.product.product_name %}](/articles/moving-a-file-to-a-new-location), but some files, such as images, require that you move them from the command line. + +{% data reusables.command_line.manipulating_file_prereqs %} + +1. On your computer, move the file to a new location within the directory that was created locally on your computer when you cloned the repository. +{% data reusables.command_line.open_the_multi_os_terminal %} +3. Use `git status` to check the old and new file locations. + ```shell + $ git status + > # On branch your-branch + > # Changes not staged for commit: + > # (use "git add/rm ..." to update what will be committed) + > # (use "git checkout -- ..." to discard changes in working directory) + > # + > # deleted: /old-folder/image.png + > # + > # Untracked files: + > # (use "git add ..." to include in what will be committed) + > # + > # /new-folder/image.png + > # + > # no changes added to commit (use "git add" and/or "git commit -a") + ``` +{% data reusables.git.stage_for_commit %} This will delete, or `git rm`, the file from the old location and add, or `git add`, the file to the new location. + ```shell + $ git add . + # Adds the file to your local repository and stages it for commit. + # {% data reusables.git.unstage-codeblock %} + ``` +5. Use `git status` to check the changes staged for commit. + ```shell + $ git status + > # On branch your-branch + > # Changes to be committed: + > # (use "git reset HEAD ..." to unstage) + > # + > # renamed: /old-folder/image.png -> /new-folder/image.png + # Displays the changes staged for commit + ``` +{% data reusables.git.commit-file %} + ```shell + $ git commit -m "Move file to new directory" + # Commits the tracked changes and prepares them to be pushed to a remote repository. + # {% data reusables.git.reset-head-to-previous-commit-codeblock %} + ``` +{% data reusables.git.git-push %} diff --git a/content/repositories/working-with-files/managing-files/renaming-a-file.md b/content/repositories/working-with-files/managing-files/renaming-a-file.md new file mode 100644 index 0000000000..1188d84ece --- /dev/null +++ b/content/repositories/working-with-files/managing-files/renaming-a-file.md @@ -0,0 +1,73 @@ +--- +title: Renaming a file +intro: 'You can rename any file in your repository directly in {% data variables.product.product_name %} or by using the command line.' +redirect_from: + - /articles/renaming-a-file + - /github/managing-files-in-a-repository/renaming-a-file + - /articles/renaming-a-file-using-the-command-line + - /github/managing-files-in-a-repository/renaming-a-file-using-the-command-line + - /github/managing-files-in-a-repository/managing-files-on-github/renaming-a-file + - /github/managing-files-in-a-repository/managing-files-using-the-command-line/renaming-a-file-using-the-command-line +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +--- + +## Renaming a file on {% data variables.product.product_name %} + +Renaming a file also gives you the opportunity to [move the file to a new location](/articles/moving-a-file-to-a-new-location) + +{% tip %} + +**Tips**: + +- If you try to rename a file in a repository that you don’t have access to, we will fork the project to your user account and help you send [a pull request](/articles/about-pull-requests) to the original repository after you commit your change. +- File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. +- Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](/articles/renaming-a-file-using-the-command-line)." + +{% endtip %} + +1. In your repository, browse to the file you want to rename. +2. In the upper right corner of the file view, click {% octicon "pencil" aria-label="The edit icon" %} to open the file editor. +![Edit file icon](/assets/images/help/repository/edit-file-icon.png) +3. In the filename field, change the name of the file to the new filename you want. You can also update the contents of your file at the same time. +![Editing a file name](/assets/images/help/repository/changing-file-name.png) +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_file_change %} + +## Renaming a file using the command line + +You can use the command line to rename any file in your repository. + +Many files can be [renamed directly on {% data variables.product.product_name %}](/articles/renaming-a-file), but some files, such as images, require that you rename them from the command line. + +{% data reusables.command_line.manipulating_file_prereqs %} + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +3. Rename the file, specifying the old file name and the new name you'd like to give the file. This will stage your change for commit. + ```shell + $ git mv old_filename new_filename + ``` +4. Use `git status` to check the old and new file names. + ```shell + $ git status + > # On branch your-branch + > # Changes to be committed: + > # (use "git reset HEAD ..." to unstage) + > # + > # renamed: old_filename -> new_filename + > # + ``` +{% data reusables.git.commit-file %} + ```shell + $ git commit -m "Rename file" + # Commits the tracked changes and prepares them to be pushed to a remote repository. + # {% data reusables.git.reset-head-to-previous-commit-codeblock %} + ``` +{% data reusables.git.git-push %} + diff --git a/content/github/managing-large-files/versioning-large-files/about-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md similarity index 88% rename from content/github/managing-large-files/versioning-large-files/about-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md index a3d3fa1f49..91bafc7d23 100644 --- a/content/github/managing-large-files/versioning-large-files/about-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md @@ -1,16 +1,20 @@ --- title: About Git Large File Storage -intro: '{% data variables.large_files.product_name_short %} lets you push files to {% data variables.product.product_name %} that are larger than the Git push limit.' +intro: '{% data variables.product.product_name %} limits the size of files allowed in repositories. To track files beyond this limit, you can use {% data variables.large_files.product_name_long %}.' redirect_from: - /articles/about-large-file-storage/ - /articles/about-git-large-file-storage - /github/managing-large-files/about-git-large-file-storage + - /github/managing-large-files/versioning-large-files/about-git-large-file-storage versions: fpt: '*' ghes: '*' ghae: '*' shortTitle: Git Large File Storage --- + +## About {% data variables.large_files.product_name_long %} + {% data variables.large_files.product_name_short %} handles large files by storing references to the file in the repository, but not the actual file itself. To work around Git's architecture, {% data variables.large_files.product_name_short %} creates a pointer file which acts as a reference to the actual file (which is stored somewhere else). {% data variables.product.product_name %} manages this pointer file in your repository. When you clone the repository down, {% data variables.product.product_name %} uses the pointer file as a map to go and find the large file for you. {% ifversion fpt %} diff --git a/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md new file mode 100644 index 0000000000..ef5b48cc28 --- /dev/null +++ b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md @@ -0,0 +1,105 @@ +--- +title: About large files on GitHub +intro: '{% data variables.product.product_name %} limits the size of files you can track in regular Git repositories. Learn how to track or remove files that are beyond the limit.' +redirect_from: + - /articles/distributing-large-binaries + - /github/managing-large-files/distributing-large-binaries + - /github/managing-large-files/working-with-large-files/distributing-large-binaries + - /articles/removing-files-from-a-repository-s-history + - /articles/removing-files-from-a-repositorys-history + - /github/managing-large-files/removing-files-from-a-repositorys-history + - /github/managing-large-files/working-with-large-files/removing-files-from-a-repositorys-history + - /articles/conditions-for-large-files + - /github/managing-large-files/conditions-for-large-files + - /github/managing-large-files/working-with-large-files/conditions-for-large-files + - /articles/what-is-the-size-limit-for-a-repository/ + - /articles/what-is-my-disk-quota + - /github/managing-large-files/what-is-my-disk-quota + - /github/managing-large-files/working-with-large-files/what-is-my-disk-quota +versions: + fpt: '*' + ghes: '*' + ghae: '*' +shortTitle: Large files +--- + +## About size limits on {% data variables.product.product_name %} + +{% ifversion fpt %} +{% data variables.product.product_name %} tries to provide abundant storage for all Git repositories, although there are hard limits for file and repository sizes. To ensure performance and reliability for our users, we actively monitor signals of overall repository health. Repository health is a function of various interacting factors, including size, commit frequency, contents, and structure. + +### File size limits +{% endif %} + +{% data variables.product.product_name %} limits the size of files allowed in repositories. If you attempt to add or update a file that is larger than {% data variables.large_files.warning_size %}, you will receive a warning from Git. The changes will still successfully push to your repository, but you can consider removing the commit to minimize performance impact. For more information, see "[Removing files from a repository's history](#removing-files-from-a-repositorys-history)." + +{% note %} + +**Note:** If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." + +{% endnote %} + +{% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} blocks pushes that exceed {% data variables.large_files.max_github_size %}. {% ifversion ghes %}However, a site administrator can configure a different limit for {% data variables.product.product_location %}. For more information, see "[Setting Git push limits](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-git-push-limits)."{% endif %} + +To track files beyond this limit, you must use {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}). For more information, see "[About {% data variables.large_files.product_name_long %}](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)." + +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %} instead of tracking the files. For more information, see "[Distributing large binaries](#distributing-large-binaries)." + +Git is not designed to handle large SQL files. To share large databases with other developers, we recommend using [Dropbox](https://www.dropbox.com/). + +{% ifversion fpt %} +### Repository size limits + +We recommend repositories remain small, ideally less than 1 GB, and less than 5 GB is strongly recommended. Smaller repositories are faster to clone and easier to work with and maintain. If your repository excessively impacts our infrastructure, you might receive an email from {% data variables.contact.github_support %} asking you to take corrective action. We try to be flexible, especially with large projects that have many collaborators, and will work with you to find a resolution whenever possible. You can prevent your repository from impacting our infrastructure by effectively managing your repository's size and overall health. You can find advice and a tool for repository analysis in the [`github/git-sizer`](https://github.com/github/git-sizer) repository. + +External dependencies can cause Git repositories to become very large. To avoid filling a repository with external dependencies, we recommend you use a package manager. Popular package managers for common languages include [Bundler](http://bundler.io/), [Node's Package Manager](http://npmjs.org/), and [Maven](http://maven.apache.org/). These package managers support using Git repositories directly, so you don't need pre-packaged sources. + +Git is not designed to serve as a backup tool. However, there are many solutions specifically designed for performing backups, such as [Arq](https://www.arqbackup.com/), [Carbonite](http://www.carbonite.com/), and [CrashPlan](https://www.crashplan.com/en-us/). +{% endif %} + +## Removing files from a repository's history + +{% warning %} + +**Warning**: These procedures will permanently remove files from the repository on your computer and {% data variables.product.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. + +{% endwarning %} + +### Removing a file added in the most recent unpushed commit + +If the file was added with your most recent commit, and you have not pushed to {% data variables.product.product_location %}, you can delete the file and amend the commit: + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +3. To remove the file, enter `git rm --cached`: + ```shell + $ git rm --cached giant_file + # Stage our giant file for removal, but leave it on disk + ``` +4. Commit this change using `--amend -CHEAD`: + ```shell + $ git commit --amend -CHEAD + # Amend the previous commit with your change + # Simply making a new commit won't work, as you need + # to remove the file from the unpushed history as well + ``` +5. Push your commits to {% data variables.product.product_location %}: + ```shell + $ git push + # Push our rewritten, smaller commit + ``` + +### Removing a file that was added in an earlier commit + +If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)." + +## Distributing large binaries + +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %}. Releases allow you to package software, release notes, and links to binary files, for other people to use. For more information, visit "[About releases](/github/administering-a-repository/about-releases)." + +{% ifversion fpt %} + +We don't limit the total size of the binary files in the release or the bandwidth used to deliver them. However, each individual file must be smaller than {% data variables.large_files.max_lfs_size %}. + +{% endif %} + diff --git a/content/github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage.md b/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md similarity index 97% rename from content/github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage.md rename to content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md index 8ed3d6c19d..afc63d8584 100644 --- a/content/github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage.md +++ b/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md @@ -6,6 +6,7 @@ redirect_from: - /articles/billing-plans-for-git-large-file-storage/ - /articles/about-storage-and-bandwidth-usage - /github/managing-large-files/about-storage-and-bandwidth-usage + - /github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage versions: fpt: '*' shortTitle: Storage & bandwidth diff --git a/content/github/managing-large-files/versioning-large-files/collaboration-with-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md similarity index 96% rename from content/github/managing-large-files/versioning-large-files/collaboration-with-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md index af6170b9cb..ac3c34c65c 100644 --- a/content/github/managing-large-files/versioning-large-files/collaboration-with-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md @@ -5,6 +5,7 @@ redirect_from: - /articles/collaboration-with-large-file-storage/ - /articles/collaboration-with-git-large-file-storage - /github/managing-large-files/collaboration-with-git-large-file-storage + - /github/managing-large-files/versioning-large-files/collaboration-with-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/configuring-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md similarity index 97% rename from content/github/managing-large-files/versioning-large-files/configuring-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md index 69ed09e4cc..a707424d0d 100644 --- a/content/github/managing-large-files/versioning-large-files/configuring-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md @@ -5,6 +5,7 @@ redirect_from: - /articles/configuring-large-file-storage/ - /articles/configuring-git-large-file-storage - /github/managing-large-files/configuring-git-large-file-storage + - /github/managing-large-files/versioning-large-files/configuring-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/index.md b/content/repositories/working-with-files/managing-large-files/index.md similarity index 58% rename from content/github/managing-large-files/versioning-large-files/index.md rename to content/repositories/working-with-files/managing-large-files/index.md index 04fcefad9c..f69698f46d 100644 --- a/content/github/managing-large-files/versioning-large-files/index.md +++ b/content/repositories/working-with-files/managing-large-files/index.md @@ -1,13 +1,19 @@ --- -title: Versioning large files -intro: '{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %}' +title: Managing large files +intro: You can manage large files with Git Large File Storage. redirect_from: + - /categories/managing-large-files + - /github/managing-large-files - /articles/versioning-large-files + - /github/managing-large-files/versioning-large-files + - /articles/working-with-large-files + - /github/managing-large-files/working-with-large-files versions: fpt: '*' ghes: '*' ghae: '*' children: + - /about-large-files-on-github - /about-git-large-file-storage - /installing-git-large-file-storage - /configuring-git-large-file-storage diff --git a/content/github/managing-large-files/versioning-large-files/installing-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md similarity index 98% rename from content/github/managing-large-files/versioning-large-files/installing-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md index ec4387650c..4a2a42e486 100644 --- a/content/github/managing-large-files/versioning-large-files/installing-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md @@ -5,6 +5,7 @@ redirect_from: - /articles/installing-large-file-storage/ - /articles/installing-git-large-file-storage - /github/managing-large-files/installing-git-large-file-storage + - /github/managing-large-files/versioning-large-files/installing-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md similarity index 95% rename from content/github/managing-large-files/versioning-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md index 61272a0a86..208fb7b8d7 100644 --- a/content/github/managing-large-files/versioning-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md @@ -4,6 +4,7 @@ intro: 'If you''ve set up {% data variables.large_files.product_name_short %}, a redirect_from: - /articles/moving-a-file-in-your-repository-to-git-large-file-storage - /github/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage + - /github/managing-large-files/versioning-large-files/moving-a-file-in-your-repository-to-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md similarity index 97% rename from content/github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md index acc4030658..0988bb52cf 100644 --- a/content/github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md @@ -4,6 +4,7 @@ intro: 'If you''ve set up {% data variables.large_files.product_name_short %} fo redirect_from: - /articles/removing-files-from-git-large-file-storage - /github/managing-large-files/removing-files-from-git-large-file-storage + - /github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/resolving-git-large-file-storage-upload-failures.md b/content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md similarity index 92% rename from content/github/managing-large-files/versioning-large-files/resolving-git-large-file-storage-upload-failures.md rename to content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md index 68a77bef8e..88a9424667 100644 --- a/content/github/managing-large-files/versioning-large-files/resolving-git-large-file-storage-upload-failures.md +++ b/content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md @@ -4,6 +4,7 @@ intro: 'If your {% data variables.large_files.product_name_short %} files didn'' redirect_from: - /articles/resolving-git-large-file-storage-upload-failures - /github/managing-large-files/resolving-git-large-file-storage-upload-failures + - /github/managing-large-files/versioning-large-files/resolving-git-large-file-storage-upload-failures versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/getting-permanent-links-to-files.md b/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md similarity index 96% rename from content/github/managing-files-in-a-repository/managing-files-on-github/getting-permanent-links-to-files.md rename to content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md index 6678a753ff..fddb90da2b 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/getting-permanent-links-to-files.md +++ b/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md @@ -6,6 +6,7 @@ redirect_from: - /articles/how-do-i-get-a-permanent-link-from-file-view-to-permanent-blob-url/ - /articles/getting-permanent-links-to-files - /github/managing-files-in-a-repository/getting-permanent-links-to-files + - /github/managing-files-in-a-repository/managing-files-on-github/getting-permanent-links-to-files versions: fpt: '*' ghes: '*' diff --git a/content/repositories/working-with-files/using-files/index.md b/content/repositories/working-with-files/using-files/index.md new file mode 100644 index 0000000000..896fefe26c --- /dev/null +++ b/content/repositories/working-with-files/using-files/index.md @@ -0,0 +1,14 @@ +--- +title: Using files +intro: 'You can navigate and track changes in the code in your files.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +children: + - /navigating-code-on-github + - /tracking-changes-in-a-file + - /getting-permanent-links-to-files + - /working-with-non-code-files +--- + diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/navigating-code-on-github.md b/content/repositories/working-with-files/using-files/navigating-code-on-github.md similarity index 94% rename from content/github/managing-files-in-a-repository/managing-files-on-github/navigating-code-on-github.md rename to content/repositories/working-with-files/using-files/navigating-code-on-github.md index b07569d022..0e323ed39a 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/navigating-code-on-github.md +++ b/content/repositories/working-with-files/using-files/navigating-code-on-github.md @@ -4,6 +4,7 @@ intro: 'You can understand the relationships within and across repositories by n redirect_from: - /articles/navigating-code-on-github - /github/managing-files-in-a-repository/navigating-code-on-github + - /github/managing-files-in-a-repository/managing-files-on-github/navigating-code-on-github versions: fpt: '*' topics: diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/tracking-changes-in-a-file.md b/content/repositories/working-with-files/using-files/tracking-changes-in-a-file.md similarity index 95% rename from content/github/managing-files-in-a-repository/managing-files-on-github/tracking-changes-in-a-file.md rename to content/repositories/working-with-files/using-files/tracking-changes-in-a-file.md index b6f48c504e..19fc9542ef 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/tracking-changes-in-a-file.md +++ b/content/repositories/working-with-files/using-files/tracking-changes-in-a-file.md @@ -6,6 +6,7 @@ redirect_from: - /articles/tracing-changes-in-a-file/ - /articles/tracking-changes-in-a-file - /github/managing-files-in-a-repository/tracking-changes-in-a-file + - /github/managing-files-in-a-repository/managing-files-on-github/tracking-changes-in-a-file versions: fpt: '*' ghes: '*' diff --git a/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/content/repositories/working-with-files/using-files/working-with-non-code-files.md new file mode 100644 index 0000000000..c669e2349a --- /dev/null +++ b/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -0,0 +1,320 @@ +--- +title: Working with non-code files +intro: "{% data variables.product.product_name %} supports rendering and diffing in a number of non-code file formats." +redirect_from: + - /articles/rendering-and-diffing-images + - /github/managing-files-in-a-repository/rendering-and-diffing-images + - /github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images + - /articles/stl-file-viewer + - /articles/3d-file-viewer + - /github/managing-files-in-a-repository/3d-file-viewer + - /github/managing-files-in-a-repository/working-with-non-code-files/3d-file-viewer + - /articles/rendering-csv-and-tsv-data + - /github/managing-files-in-a-repository/rendering-csv-and-tsv-data + - /github/managing-files-in-a-repository/working-with-non-code-files/rendering-csv-and-tsv-data + - /articles/rendering-pdf-documents + - /github/managing-files-in-a-repository/rendering-pdf-documents + - /github/managing-files-in-a-repository/working-with-non-code-files/rendering-pdf-documents + - /articles/rendering-differences-in-prose-documents + - /github/managing-files-in-a-repository/rendering-differences-in-prose-documents + - /github/managing-files-in-a-repository/working-with-non-code-files/rendering-differences-in-prose-documents + - /articles/mapping-geojson-files-on-github + - /github/managing-files-in-a-repository/mapping-geojson-files-on-github + - /github/managing-files-in-a-repository/working-with-non-code-files/mapping-geojson-files-on-github + - /articles/working-with-jupyter-notebook-files-on-github + - /github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github + - /github/managing-files-in-a-repository/working-with-non-code-files/working-with-jupyter-notebook-files-on-github + - /github/managing-files-in-a-repository/working-with-non-code-files +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Working with non-code files +--- + +## Rendering and diffing images + +{% data variables.product.product_name %} can display several common image formats, including PNG, JPG, GIF, PSD, and SVG. In addition to simply displaying them, there are several ways to compare differences between versions of those image formats.' + +{% note %} + +**Note:** If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render. + +{% endnote %} + +### Viewing images + +You can directly browse and view images in your {% data variables.product.product_name %} repository: + +![inline image](/assets/images/help/images/view.png) + +SVGs don't currently support inline scripting or animation. + +### Viewing differences + +You can visually compare images in three different modes: [2-up](#2-up), [swipe](#swipe), and [onion skin](#onion-skin). + +#### 2-up + +**2-up** is the default mode; it gives you a quick glimpse of both images. In addition, if the image has changed size between versions, the actual dimension change is displayed. This should make it very apparent when things are resized, such as when assets are upgraded to higher resolutions. + +![2-up](/assets/images/help/repository/images-2up-view.png) + +#### Swipe + +**Swipe** lets you view portions of your image side by side. Not sure if colors shifted between different versions? Drag the swipe slider over the area in question and compare the pixels for yourself. + +![Swipe](/assets/images/help/repository/images-swipe-view.png) + +#### Onion skin + +**Onion Skin** really comes in handy when elements move around by small, hard to notice amounts. Did an icon shift two pixels to the left? Drag the opacity slider back a bit and notice if things move around. + +![Onion skin](/assets/images/help/repository/images-onion-view.gif) + +## 3D File Viewer + +{% data variables.product.product_name %} can host and render 3D files with the *.stl* extension. + +When looking directly at an STL file on {% data variables.product.product_name %} you can: + +* Click and drag to spin the model. +* Right click and drag to translate the view. +* Scroll to zoom in and out. +* Click the different view modes to change the view. + +### Diffs + +When looking at a commit or set of changes which includes an STL file, you'll be able to see a before and after diff of the file. + +By default, you'll get a view where everything unchanged is in wireframe. Additions are colored in green, and removed parts are colored in red. + +![wireframe](/assets/images/help/repository/stl_wireframe.png) + +You can also select the **Revision Slider** option, which lets you use a slider at the top of the file to transition between the current and previous revisions. + +### Fixing slow performance + +If you see this icon in the corner of the viewer, then the WebGL technology is not available on your browser: + +![WebGL pop error](/assets/images/help/repository/render_webgl_error.png) + +WebGL is necessary to take advantage of your computer's hardware to its fullest. We recommend you try browsers like [Chrome](https://www.google.com/intl/en/chrome/browser/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/), which ship with WebGL enabled. + +### Error: "Unable to display" + +If your model is invalid, GitHub may not be able to display the file. In addition, files that are larger than 10 MB are too big for GitHub to display. + +### Embedding your model elsewhere + +To display your 3D file elsewhere on the internet, modify this template and place it on any HTML page that supports JavaScript: + +```html + +``` + +For example, if your model's URL is [github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl](https://github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl), your embed code would be: + +```html + +``` + +By default, the embedded renderer is 420 pixels wide by 620 pixels high, but you can customize the output by passing height and width variables as parameters at the end of the URL, such as `?height=300&width=500`. + +{% tip %} + +**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). + +{% endtip %} + +## Rendering CSV and TSV data + +GitHub supports rendering tabular data in the form of *.csv* (comma-separated) and .*tsv* (tab-separated) files. + +![Rendered CSV sample](/assets/images/help/repository/rendered_csv.png) + +When viewed, any _.csv_ or _.tsv_ file committed to a {% data variables.product.product_name %} repository automatically renders as an interactive table, complete with headers and row numbering. By default, we'll always assume the first row is your header row. + +You can link to a particular row by clicking the row number, or select multiple rows by holding down the shift key. Just copy the URL and send it to a friend. + +### Searching data + +If you want to find a certain value in your dataset, you can start typing in the search bar directly above the file. The rows will filter automatically: + +![Searching for values](/assets/images/help/repository/searching_csvs.gif) + +### Handling errors + +Occasionally, you may discover that your CSV or TSV file isn't rendering. In those instances, an error box appears at the bottom of your raw text, suggesting what the error may be. + +![CSV render error message](/assets/images/help/repository/csv_render_error.png) + +Common errors include: + +* Mismatched column counts. You must have the same number of separators in each row, even if the cell is blank +* Exceeding the file size. Our rendering only works for files up to 512KB. Anything bigger than that slows down the browser. + +## Rendering PDF documents + +GitHub supports rendering of PDF documents. + +![Rendered PDF Document](/assets/images/help/repository/rendered-pdf.png) + +Currently, links within PDFs are ignored. + +## Rendering differences in prose documents + +Commits and pull requests that include prose documents have the ability to represent those documents with *source* and *rendered* views. + +The source view shows the raw text that has been typed, while the rendered +view shows how that text would look once it's rendered on {% data variables.product.product_name %}. For example, +this might be the difference between showing `**bold**` in Markdown, and **bold** in the rendered view. + +Prose rendering is supported for rendered documents supported by [github/markup](https://github.com/github/markup): + +* Markdown +* AsciiDoc +* Textile +* ReStructuredText +* Rdoc +* Org +* Creole +* MediaWiki +* Pod + +![Paper icon to view rendered prose document](/assets/images/help/repository/rendered_prose_diff.png) + +You can click {% octicon "file" aria-label="The paper icon" %} to see the changes made to the document as part of a commit. + +![Rendered Prose changes](/assets/images/help/repository/rendered_prose_changes.png) + +### Visualizing attribute changes + +We provide a tooltip +describing changes to attributes that, unlike words, would not otherwise be visible in the rendered document. For example, if a link URL changes from one website to +another, we'd show a tooltip like this: + +![Rendered Prose attribute changes](/assets/images/help/repository/prose_diff_attributes.png) + +### Commenting on changes + +[Commit comments](/articles/commenting-on-differences-between-files) can only +be added to files within the *source* view, on a line-by-line basis. + +### Linking to headers + +As with [other rendered prose documents](/articles/about-readmes), +hovering over a header in your document creates a link icon. You can link readers +of your rendered prose diff to specific sections. + +### Viewing complex diffs + +Some pull requests involve a large number of changes with large, complex documents. When the changes take too long to analyze, {% data variables.product.product_name %} can't always produce a rendered view of the changes. If this happens, you'll see an error message when you click the rendered button. + +![Message when view can't be rendered](/assets/images/help/repository/prose_diff_rendering.png) + +You can still use the source view to analyze and comment on changes. + +### Viewing HTML elements + +We don't directly support rendered views of commits to HTML documents. Some formats, such as Markdown, let you embed arbitrary HTML in a document. When these documents are shown on {% data variables.product.product_name %}, some of that embedded HTML can be shown in a preview, while some (like an embedded YouTube video) cannot. + +In general, rendered views of changes to a document containing embedded HTML will show changes to the elements that are supported in {% data variables.product.product_name %}'s view of the document. Changes to documents containing embedded HTML should always be reviewed in both the rendered and source views for completeness. + +## Mapping geoJSON files on {% data variables.product.prodname_dotcom %} + +{% data variables.product.product_name %} supports rendering geoJSON and topoJSON map files within {% data variables.product.product_name %} repositories. Simply commit the file as you would normally using a `.geojson` or `.topojson` extension. Files with a `.json` extension are also supported, but only if `type` is set to `FeatureCollection`, `GeometryCollection`, or `topology`. Then, navigate to the path of the geoJSON file on GitHub.com. + +When you click the paper icon on the right, you'll also see the changes made to that file as part of a commit. + +![Source Render toggle screenshot](/assets/images/help/repository/source-render-toggle-geojson.png) + +### Geometry Types + +Maps on {% data variables.product.product_name %} use [Leaflet.js](http://leafletjs.com) and support all the geometry types outlined in [the geoJSON spec](http://www.geojson.org/geojson-spec.html) (Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, and GeometryCollection). TopoJSON files should be type "Topology" and adhere to the [topoJSON spec](https://github.com/mbostock/topojson/wiki/Specification). + +### Styling features + +You can customize the way features are displayed, such as specifying a particular color or adding a descriptive icon, by passing additional metadata within the geoJSON object's properties. The options are: + +* `marker-size` - `small`, `medium`, or `large` +* `marker-color` - valid RGB hex color +* `marker-symbol` - an icon ID from [the Maki project](http://mapbox.com/maki/) or a single alphanumeric character (a-z or 0-9). +* `stroke` - color of a polygon edge or line (RGB) +* `stroke-opacity` - opacity of a polygon edge or line (0.0 - 1.0) +* `stroke-width` - width of a polygon edge or line +* `fill` - the color of the interior of a polygon (GRB) +* `fill-opacity` - the opacity of the interior of a polygon (0.0-1.0) + +See [version 1.1.0 of the open simplestyle spec](https://github.com/mapbox/simplestyle-spec/tree/master/1.1.0) for more information. + +### Embedding your map elsewhere + +Want to make your geoJSON map available someplace other than {% data variables.product.product_name %}? Simply modify this template, and place it in any HTML page that supports javascript (e.g., [{% data variables.product.prodname_pages %}](http://pages.github.com)): + +```html + +``` + +For example, if your map's URL is [github.com/benbalter/dc-wifi-social/blob/master/bars.geojson](https://github.com/benbalter/dc-wifi-social/blob/master/bars.geojson), your embed code would be: + +```html + +``` + +By default, the embedded map 420px x 620px, but you can customize the output by passing height and width variables as parameters at the end, such as `?height=300&width=500`. + +{% tip %} + +**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). + +{% endtip %} + +### Clustering + +If your map contains a large number of markers (roughly over 750), GitHub will automatically cluster nearby markers at higher zoom levels. Simply click the cluster or zoom in to see individual markers. + +### Something's up with the underlying map + +The underlying map data (street names, roads, etc.) are driven by [OpenStreetMap](http://www.openstreetmap.org/), a collaborative project to create a free editable map of the world. If you notice something's not quite right, since it's open source, simply [sign up](https://www.openstreetmap.org/user/new) and submit a fix. + +### Troubleshooting + +If you're having trouble rendering geoJSON files, ensure you have a valid geoJSON file by running it through a [geoJSON linter](http://geojsonlint.com/). If your points aren't appearing where you'd expect (e.g., in the middle of the ocean), it's likely that the data is in a projection which is currently unsupported. Currently, {% data variables.product.product_name %} only supports the `urn:ogc:def:crs:OGC:1.3:CRS84` projection. + +Additionally, if your `.geojson` file is especially large (over 10 MB), it is not possible to render within the browser. If that's the case, you'll generally see a message that looks something like this: + +![Large file](/assets/images/help/repository/view_raw.png) + +It may still be possible to render the data by converting the `.geojson` file to [TopoJSON](https://github.com/mbostock/topojson), a compression format that, in some cases, can reduce filesize by up to 80%. Of course, you can always break the file into smaller chunks (such as by state or by year), and store the data as multiple files within the repository. + +### Additional Resources + +* [Leaflet.js geojson documentation](http://leafletjs.com/examples/geojson.html) +* [MapBox marker-styling documentation](http://www.mapbox.com/developers/simplestyle/) +* [TopoJSON Wiki](https://github.com/mbostock/topojson/wiki) + +## Working with Jupyter Notebook files on {% data variables.product.prodname_dotcom %} + +When you add Jupyter Notebook or IPython Notebook files with a *.ipynb* extension on {% data variables.product.product_location %}, they will render as static HTML files in your repository. + +The interactive features of the notebook, such as custom JavaScript plots, will not work in your repository on {% data variables.product.product_location %}. For an example, see [*Linking and Interactions.ipynb*](https://github.com/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb). + +To view your Jupyter notebook with JavaScript content rendered or to share your notebook files with others you can use [nbviewer](https://nbviewer.jupyter.org/). For an example, see [*Linking and Interactions.ipynb*](https://nbviewer.jupyter.org/github/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb) rendered on nbviewer. + +To view a fully interactive version of your Jupyter Notebook, you can set up a notebook server locally. For more information, see [Jupyter's official documentation](http://jupyter.readthedocs.io/en/latest/index.html). + +### Troubleshooting + +If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert): + +```shell +$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb +``` + +### Further reading + +- [Jupyter Notebook's GitHub repository](https://github.com/jupyter/jupyter_notebook) +- [Gallery of Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki/A-gallery-of-interesting-Jupyter-Notebooks) diff --git a/content/rest/reference/repos.md b/content/rest/reference/repos.md index e18f1dc9e6..7ecb7153f8 100644 --- a/content/rest/reference/repos.md +++ b/content/rest/reference/repos.md @@ -313,7 +313,7 @@ If you are developing a GitHub App and want to provide more detailed information ## Traffic For repositories that you have push access to, the traffic API provides access -to the information provided in your repository graph. For more information, see "Viewing traffic to a repository." +to the information provided in your repository graph. For more information, see "Viewing traffic to a repository." {% for operation in currentRestOperations %} {% if operation.subcategory == 'traffic' %}{% include rest_operation %}{% endif %} diff --git a/data/reusables/classroom/assignments-guide-choose-visibility.md b/data/reusables/classroom/assignments-guide-choose-visibility.md index 303bb3669b..bed99de7e8 100644 --- a/data/reusables/classroom/assignments-guide-choose-visibility.md +++ b/data/reusables/classroom/assignments-guide-choose-visibility.md @@ -1,6 +1,6 @@ The repositories for an assignment can be public or private. If you use private repositories, only the student or team can see the feedback you provide. -You can also decide whether to grant students admin permissions to the repository for an assignment. Grant admin permissions if the student should be able to perform administrative tasks for the assignment repository. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)" and "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." +You can also decide whether to grant students admin permissions to the repository for an assignment. Grant admin permissions if the student should be able to perform administrative tasks for the assignment repository. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" and "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." Under "Repository visibility", select a visibility. Optionally, select **Grant students admin access to their repository**. diff --git a/data/reusables/github-actions/forked-write-permission.md b/data/reusables/github-actions/forked-write-permission.md index ecf77e3a35..d5300baa21 100644 --- a/data/reusables/github-actions/forked-write-permission.md +++ b/data/reusables/github-actions/forked-write-permission.md @@ -1 +1 @@ -You can use the `permissions` key to add and remove read permissions for forked repositories, but typically you can't grant write access. The exception to this behavior is where an admin user has selected the **Send write tokens to workflows from pull requests** option in the {% data variables.product.prodname_actions %} settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)." +You can use the `permissions` key to add and remove read permissions for forked repositories, but typically you can't grant write access. The exception to this behavior is where an admin user has selected the **Send write tokens to workflows from pull requests** option in the {% data variables.product.prodname_actions %} settings. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)." diff --git a/data/reusables/organizations/internal-repos-enterprise.md b/data/reusables/organizations/internal-repos-enterprise.md index 56325061ae..26dcecf629 100644 --- a/data/reusables/organizations/internal-repos-enterprise.md +++ b/data/reusables/organizations/internal-repos-enterprise.md @@ -1,7 +1,7 @@ {% ifversion fpt %} {% note %} -**Note:** Internal repositories are available for organizations that are part of an enterprise account. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +**Note:** Internal repositories are available for organizations that are part of an enterprise account. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." {% endnote %} {% endif %} diff --git a/data/reusables/organizations/repo-creation-constants.md b/data/reusables/organizations/repo-creation-constants.md index d32cded961..ee82635758 100644 --- a/data/reusables/organizations/repo-creation-constants.md +++ b/data/reusables/organizations/repo-creation-constants.md @@ -1 +1 @@ -Organization owners can always create any type of repository, and outside collaborators can never create any type of repository. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +Organization owners can always create any type of repository, and outside collaborators can never create any type of repository. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." diff --git a/data/reusables/package_registry/add-npmrc-to-repo-step.md b/data/reusables/package_registry/add-npmrc-to-repo-step.md index 751ad03fd5..8f94253e18 100644 --- a/data/reusables/package_registry/add-npmrc-to-repo-step.md +++ b/data/reusables/package_registry/add-npmrc-to-repo-step.md @@ -1 +1 @@ -3. Add the *.npmrc* file to the repository where {% data variables.product.prodname_registry %} can find your project. For more information, see "[Adding a file to a repository using the command line](/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line)." +3. Add the *.npmrc* file to the repository where {% data variables.product.prodname_registry %} can find your project. For more information, see "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." diff --git a/data/reusables/pages/private_pages_are_public_warning.md b/data/reusables/pages/private_pages_are_public_warning.md index 2e8d568bd6..0203c5447c 100644 --- a/data/reusables/pages/private_pages_are_public_warning.md +++ b/data/reusables/pages/private_pages_are_public_warning.md @@ -1,5 +1,5 @@ {% warning %} -**Warning**: {% ifversion ghes or ghae %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet{% ifversion fpt %} by default{% endif %}, even if the repository for the site is private or internal.{% ifversion fpt %} {% data reusables.pages.about-private-publishing %} Otherwise, if{% else %} If{% endif %} you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see{% ifversion ghes or ghae %} "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility){% ifversion fpt %}" and "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."{% else %}."{% endif %} +**Warning**: {% ifversion ghes or ghae %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet{% ifversion fpt %} by default{% endif %}, even if the repository for the site is private or internal.{% ifversion fpt %} {% data reusables.pages.about-private-publishing %} Otherwise, if{% else %} If{% endif %} you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see{% ifversion ghes or ghae %} "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and{% endif %} "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility){% ifversion fpt %}" and "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."{% else %}."{% endif %} {% endwarning %} diff --git a/data/reusables/pull_requests/required-checks-must-pass-to-merge.md b/data/reusables/pull_requests/required-checks-must-pass-to-merge.md index 345f7941ee..0eab90a8be 100644 --- a/data/reusables/pull_requests/required-checks-must-pass-to-merge.md +++ b/data/reusables/pull_requests/required-checks-must-pass-to-merge.md @@ -1 +1 @@ -If status checks are required for a repository, the required status checks must pass before you can merge your branch into the protected branch. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." +If status checks are required for a repository, the required status checks must pass before you can merge your branch into the protected branch. For more information, see "[About protected branches](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging)." diff --git a/data/reusables/repositories/autolink-references.md b/data/reusables/repositories/autolink-references.md index 70c67c9b29..bad4c31b94 100644 --- a/data/reusables/repositories/autolink-references.md +++ b/data/reusables/repositories/autolink-references.md @@ -1 +1 @@ -If custom autolink references are configured for a repository, then references to external resources, like a JIRA issue or Zendesk ticket, convert into shortened links. To know which autolinks are available in your repository, contact someone with admin permissions to the repository. For more information, see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)." +If custom autolink references are configured for a repository, then references to external resources, like a JIRA issue or Zendesk ticket, convert into shortened links. To know which autolinks are available in your repository, contact someone with admin permissions to the repository. For more information, see "[Configuring autolinks to reference external resources](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources)." diff --git a/data/reusables/repositories/choose-repo-visibility.md b/data/reusables/repositories/choose-repo-visibility.md index b3f4a2324f..fff8a68aa9 100644 --- a/data/reusables/repositories/choose-repo-visibility.md +++ b/data/reusables/repositories/choose-repo-visibility.md @@ -1,2 +1,2 @@ -1. Choose a repository visibility. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +1. Choose a repository visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." ![Radio buttons to select repository visibility](/assets/images/help/repository/create-repository-public-private.png) diff --git a/tests/rendering/header.js b/tests/rendering/header.js index 4eae1bbdec..bf2ec5dfdb 100644 --- a/tests/rendering/header.js +++ b/tests/rendering/header.js @@ -21,10 +21,12 @@ describe('header', () => { describe('language links', () => { test('lead to the same page in a different language', async () => { - const $ = await getDOM('/github/administering-a-repository/managing-a-branch-protection-rule') + const $ = await getDOM( + '/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule' + ) expect( $( - '[data-testid=language-picker] a[href="/ja/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule"]' + '[data-testid=language-picker] a[href="/ja/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule"]' ).length ).toBe(1) }) @@ -131,7 +133,9 @@ describe('header', () => { describe('mobile-only product dropdown links', () => { test('include github and admin, and emphasize the current product', async () => { - const $ = await getDOM('/en/articles/enabling-required-status-checks') + const $ = await getDOM( + '/en/github/importing-your-projects-to-github/importing-source-code-to-github/about-github-importer' + ) const github = $('#homepages a.active[href="/en/github"]') expect(github.length).toBe(1) expect(github.text().trim()).toBe('GitHub') diff --git a/tests/rendering/server.js b/tests/rendering/server.js index 341b51e8a5..605f764845 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -461,7 +461,7 @@ describe('server', () => { test('dotcom articles on dotcom have links that include "en"', async () => { const $ = await getDOM('/en/articles/set-up-git') - expect($('a[href="/en/articles/managing-files-on-github"]').length).toBe(1) + expect($('a[href="/en/repositories/working-with-files/managing-files"]').length).toBe(1) }) test('dotcom articles on dotcom have Enterprise Admin links with latest GHE version', async () => { @@ -477,16 +477,16 @@ describe('server', () => { const $ = await getDOM( `${latestEnterprisePath}/github/getting-started-with-github/set-up-git` ) - expect($(`a[href="${latestEnterprisePath}/articles/managing-files-on-github"]`).length).toBe( - 1 - ) + expect( + $(`a[href="${latestEnterprisePath}/repositories/working-with-files/managing-files"]`).length + ).toBe(1) }) test('dotcom categories on GHE have Enterprise user links', async () => { - const $ = await getDOM(`${latestEnterprisePath}/github/managing-large-files`) + const $ = await getDOM(`${latestEnterprisePath}/github/writing-on-github`) expect( $( - `ul.list-style-circle li a[href="${latestEnterprisePath}/github/managing-large-files/working-with-large-files/conditions-for-large-files"]` + `ul.list-style-circle li a[href="${latestEnterprisePath}/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github"]` ).length ).toBe(1) }) @@ -511,7 +511,7 @@ describe('server', () => { ) expect( $( - `a[href="${latestEnterprisePath}/github/creating-cloning-and-archiving-repositories/about-repository-visibility"]` + `a[href="${latestEnterprisePath}/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility"]` ).length ).toBeGreaterThan(0) }) @@ -644,8 +644,8 @@ describe('server', () => { describe('categories and map topics', () => { test('adds links to categories on the dotcom homepage', async () => { const $ = await getDOM('/en/github') - expect($('a[href="/en/github/managing-large-files"]').length).toBe(1) - expect($('a[href="#managing-large-files"]').length).toBe(0) + expect($('a[href="/en/github/customizing-your-github-workflow"]').length).toBe(1) + expect($('a[href="#customizing-your-github-workflow"]').length).toBe(0) }) test('adds links to map topics on a category homepage', async () => { @@ -658,7 +658,7 @@ describe('server', () => { }) test('category page renders with TOC', async () => { - const $ = await getDOM('/en/github/managing-large-files') + const $ = await getDOM('/en/github/writing-on-github') expect($('[data-testid=table-of-contents] ul li a').length).toBeGreaterThan(5) })