Skip to content

Commit

Permalink
Remove product_name from repositories directory (#54016)
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacmbrown authored Jan 21, 2025
1 parent c933e1e commit 80753fb
Show file tree
Hide file tree
Showing 43 changed files with 96 additions and 96 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: About archiving content and data on GitHub
intro: 'You can archive content and data on {% data variables.product.product_name %} for other people to view and reference.'
intro: 'You can archive content and data for other people to view and reference.'
redirect_from:
- /articles/about-archiving-content-and-data-on-github
- /github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github
Expand All @@ -14,7 +14,7 @@ shortTitle: Archive content & data
---
## Persistence of public repositories

{% data variables.product.product_name %} intends to keep your public repositories available unless you remove them. In some cases, we may make public content unavailable, for example if:
{% data variables.product.company_short %} intends to keep your public repositories available unless you remove them. In some cases, we may make public content unavailable, for example if:

* We receive a [DMCA Takedown Notice](/free-pro-team@latest/site-policy/content-removal-policies/dmca-takedown-policy) for content in a repository.
* We determine that a repository's content violates our [Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines) or [Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service).
Expand All @@ -33,4 +33,4 @@ You can opt out of the {% data variables.product.prodname_archive %} for your re

## Adding an open source license to increase archivability

Libraries and researchers may require legal protections to create archives of publicly available content. If you want third parties to consider your work on {% data variables.product.product_name %} for archiving, you can add an [open source license](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) to your projects. An open source license gives contributors explicit permissions to copy and distribute the material in your repositories.
Libraries and researchers may require legal protections to create archives of publicly available content. If you want third parties to consider your work on {% data variables.product.github %} for archiving, you can add an [open source license](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) to your projects. An open source license gives contributors explicit permissions to copy and distribute the material in your repositories.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Archiving a GitHub repository
intro: 'You can archive, back up, and cite your work using {% data variables.product.product_name %}, the API, or third-party tools and services.'
intro: 'You can archive, back up, and cite your work using the {% data variables.product.github %} UI, the API, or third-party tools and services.'
redirect_from:
- /articles/can-i-archive-a-repository
- /articles/archiving-a-github-repository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To make your repositories easier to reference in academic literature, you can cr
1. Navigate to the [Zenodo {% data variables.product.prodname_dotcom %} page](https://zenodo.org/account/settings/github/).
1. To the right of the name of the repository you want to archive, toggle the button to **On**.

Zenodo archives your repository and issues a new DOI each time you create a new {% data variables.product.product_name %} [release](/repositories/releasing-projects-on-github/about-releases). Follow the steps at [AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository) to create a new one.
Zenodo archives your repository and issues a new DOI each time you create a new {% data variables.product.github %} [release](/repositories/releasing-projects-on-github/about-releases). Follow the steps at [AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository) to create a new one.

## Publicizing and citing research material with Figshare

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Once you have enabled the "Require merge queue" setting, you can also access the

As pull requests are added to the merge queue, the merge queue ensures that they are merged in a first-in-first-out order where the required checks are always satisfied.

A merge queue creates temporary branches with a special prefix to validate pull request changes. When a pull request is added to the merge queue, the changes in the pull request are grouped into a `merge_group` with the latest version of the `base_branch` as well as changes from pull requests ahead of it in the queue. {% data variables.product.product_name %} will merge all these changes into the `base_branch` once the checks required by the branch protections of `base_branch` pass.
A merge queue creates temporary branches with a special prefix to validate pull request changes. When a pull request is added to the merge queue, the changes in the pull request are grouped into a `merge_group` with the latest version of the `base_branch` as well as changes from pull requests ahead of it in the queue. {% data variables.product.github %} will merge all these changes into the `base_branch` once the checks required by the branch protections of `base_branch` pass.

For information about merge methods, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges).

Expand All @@ -92,7 +92,7 @@ When multiple pull requests are added to the merge queue and when the temporary
1. The merge queue creates a temporary branch with the prefix of `main/pr-1` that contains code changes from the target branch and pull request #1. A `merge_group` webhook event of type `checks_requested` is dispatched and the merge queue will await a response from your CI provider.
1. User adds pull request #2 to the merge queue.
1. The merge queue creates a temporary branch with the prefix of `main/pr-2` that contains code changes from the target branch, pull request #1, and pull request #2, and dispatches webhooks.
1. When the {% data variables.product.product_name %} API receives successful CI responses for `merge_group` branches `main/pr-1` and `main/pr-2`, the temporary branch `main/pr-2` will be merged in to the target branch. The target branch now contains both changes from pull request #1 and #2.
1. When the {% data variables.product.github %} API receives successful CI responses for `merge_group` branches `main/pr-1` and `main/pr-2`, the temporary branch `main/pr-2` will be merged in to the target branch. The target branch now contains both changes from pull request #1 and #2.

### Failing CI

Expand All @@ -104,9 +104,9 @@ The following scenario outlines what happens when a CI reports a failing status
1. The merge queue creates a temporary branch with the prefix of `main/pr-1` that contains code changes from the target branch and pull request #1. A `merge_group` webhook event of type `checks_requested` is dispatched and the merge queue will await a response from your CI provider.
1. User adds pull request #2 to the merge queue.
1. The merge queue creates a temporary branch with the prefix of `main/pr-2` that contains code changes from the target branch, pull request #1, and pull request #2, and dispatches webhooks.
1. When the {% data variables.product.product_name %} API receives a failing status for `main/pr-1`, the merge queue automatically removes pull request #1 from the merge queue.
1. When the {% data variables.product.github %} API receives a failing status for `main/pr-1`, the merge queue automatically removes pull request #1 from the merge queue.
1. The merge queue recreates the temporary branch with the prefix of `main/pr-2` to only contain changes from the target branch and pull request #2.
1. When the {% data variables.product.product_name %} API receives successful CI responses for `merge_group` branch `main/pr-2`, the temporary branch `main/pr-2` will be merged in to the target branch without pull request #1 included.
1. When the {% data variables.product.github %} API receives successful CI responses for `merge_group` branch `main/pr-2`, the temporary branch `main/pr-2` will be merged in to the target branch without pull request #1 included.

{% data reusables.pull_requests.merge-queue-removal-reasons %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Organizational rulesets that apply to branches of a repository will no longer al

## Updating a local clone after a branch name changes

After you rename a branch in a repository on {% data variables.product.product_name %}, any collaborator with a local clone of the repository will need to update the clone.
After you rename a branch in a repository on {% data variables.product.github %}, any collaborator with a local clone of the repository will need to update the clone.

From the local clone of the repository on a computer, run the following commands to update the name of the default branch.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Viewing branches in your repository
intro: 'Branches are central to collaboration on {% data variables.product.product_name %}, and the best way to view them is the branches page.'
intro: 'Branches are central to collaboration on {% data variables.product.github %}, and the best way to view them is the branches page.'
redirect_from:
- /articles/viewing-branches-in-your-repository
- /github/administering-a-repository/viewing-branches-in-your-repository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ When you enable required commit signing on a branch, contributors {% ifversion f
> If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch.
{% endif %}

You can always push local commits to the branch if the commits are signed and verified. {% ifversion fpt or ghec %}You can also merge signed and verified commits into the branch using a pull request on {% data variables.product.product_name %}. However, you cannot squash and merge a pull request into the branch on {% data variables.product.product_name %} unless you are the author of the pull request.{% else %} However, you cannot merge pull requests into the branch on {% data variables.product.product_name %}.{% endif %} You can {% ifversion fpt or ghec %}squash and {% endif %}merge pull requests locally. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally).
You can always push local commits to the branch if the commits are signed and verified. {% ifversion fpt or ghec %}You can also merge signed and verified commits into the branch using a pull request. However, you cannot squash and merge a pull request into the branch on {% data variables.product.github %} unless you are the author of the pull request.{% else %} However, you cannot merge pull requests into the branch on {% data variables.product.github %}.{% endif %} You can {% ifversion fpt or ghec %}squash and {% endif %}merge pull requests locally. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally).

{% ifversion fpt or ghec %} For more information about merge methods, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github).{% endif %}

Expand Down Expand Up @@ -180,7 +180,7 @@ You can only give push access to a protected branch, or give permission to creat

### Allow force pushes

By default, {% data variables.product.product_name %} blocks force pushes on all protected branches. When you enable force pushes to a protected branch, you can choose one of two groups who can force push:
By default, {% data variables.product.github %} blocks force pushes on all protected branches. When you enable force pushes to a protected branch, you can choose one of two groups who can force push:

1. Allow everyone with at least write permissions to the repository to force push to the branch, including those with admin permissions.
1. Allow only specific people or teams to force push to the branch.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ With both methods, we use the `verified_signature?` to confirm if a commit has a
{% endif %}

You can always push local commits to the branch if the commits are signed and verified. {% ifversion fpt or ghec %}You can also merge signed and verified commits into the branch using a pull request on {% data variables.product.product_name %}. However, you cannot squash and merge a pull request into the branch on {% data variables.product.product_name %} unless you are the author of the pull request.{% else %} However, you cannot merge pull requests into the branch on {% data variables.product.product_name %}.{% endif %} You can {% ifversion fpt or ghec %}squash and {% endif %}merge pull requests locally. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally).
You can always push local commits to the branch if the commits are signed and verified. {% ifversion fpt or ghec %}You can also merge signed and verified commits into the branch using a pull request. However, you cannot squash and merge a pull request into the branch on {% data variables.product.github %} unless you are the author of the pull request.{% else %} However, you cannot merge pull requests into the branch on {% data variables.product.github %}.{% endif %} You can {% ifversion fpt or ghec %}squash and {% endif %}merge pull requests locally. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally).

{% ifversion fpt or ghec %} For more information about merge methods, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github).{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Clone | To download a full copy of a repository's data from {% data variables.lo
Fork | A new repository that shares code and visibility settings with the original "upstream" repository.
Merge | To take the changes from one branch and apply them to another.
Pull request | A request to merge changes from one branch into another.
Remote | A repository stored on {% data variables.product.product_name %}, not on your computer.
Remote | A repository stored on {% data variables.product.github %}, not on your computer.
Upstream | The branch on an original repository that has been forked or cloned. The corresponding branch on the cloned or forked repository is called the "downstream."

{% endrowheaders %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ topics:
{% data reusables.repositories.owner-drop-down %}
{% data reusables.repositories.repo-name %}
{% data reusables.repositories.choose-repo-visibility %}
1. 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 [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line), [AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line), and [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts).
1. 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.github %}, 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 [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line), [AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line), and [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts).
* You can create a README, which is a document describing your project. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes).
* You can create a _.gitignore_ file, which is a set of ignore rules. For more information, see [AUTOTITLE](/get-started/getting-started-with-git/ignoring-files).{% ifversion fpt or ghec %}
* You can choose to add a software license for your project. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).{% endif %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Creating an issues-only repository
intro: '{% data variables.product.product_name %} does not provide issues-only access permissions, but you can accomplish this using a second repository which contains only the issues.'
intro: '{% data variables.product.github %} does not provide issues-only access permissions, but you can accomplish this using a second repository which contains only the issues.'
redirect_from:
- /articles/issues-only-access-permissions
- /articles/is-there-issues-only-access-to-organization-repositories
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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.'
intro: 'You can create a repository on {% data variables.product.github %} 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ topics:
---
## Create a repository

{% data variables.product.product_name %} repositories store a variety of projects. In this guide, you'll create a repository and commit your first change.
{% data variables.product.github %} repositories store a variety of projects. In this guide, you'll create a repository and commit your first change.

{% webui %}

{% data reusables.repositories.create_new %}
1. Type a short, memorable name for your repository. For example, "hello-world".

![Screenshot of the first step in creating a repository. The "Repository name" field contains the text "hello-world" and is outlined in dark orange.](/assets/images/help/repository/create-repository-name.png)
1. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.product_name %}."
1. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.github %}."
{% data reusables.repositories.choose-repo-visibility %}
{% data reusables.repositories.initialize-with-readme %}
{% data reusables.repositories.create-repo %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ topics:
- Repositories
---

Certain types of repository 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.
Certain types of repository resources can be quite large, requiring excessive processing on {% data variables.product.github %}. 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.
Most of the limits below affect both {% data variables.product.github %} and the API.

## Text limits

Expand Down
Loading

0 comments on commit 80753fb

Please sign in to comment.