Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update repository names to be consistent #24121

Merged
merged 2 commits into from
Mar 9, 2023

Conversation

adamcrews
Copy link
Contributor

@adamcrews adamcrews commented Feb 23, 2023

This updates the references to a repository name to be consistent throughout this document to avoid confusion. It makes it more clear that a repository has an owner that may not be a username (ie it could be an org name).

Why:

The urls referenced in the various examples were inconsistent. One of my end users was confused about wether they should use their github userid or the org name when updating a url. This change make all of the urls consistent, and used the specific word owner to that should help clarify the name of the repository.

What's being changed (if available, include any code snippets, screenshots, or gifs):

I simply updated user and username to be owner, and fix all repo.git to be repository.git

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

This updates the references to a repository name to be consistent throughout this document to avoid confusion.  It makes it more clear that a repository has an owner that may not be a username (ie it could be an org name).
@welcome
Copy link

welcome bot commented Feb 23, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 23, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 23, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
get-started/getting-started-with-git/managing-remote-repositories.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

@adamcrews Thanks so much for opening a PR! I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review get started Content related to "Getting Started" doc set repositories Content related to repositories and removed triage Do not begin working on this issue until triaged by the team labels Feb 24, 2023
Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adamcrews - thanks for making this suggestion and opening a pull request to make the change 💖

This seems like a good replacement, but I can see that we also use this pattern in some other articles. I'm going to check in with a few other people and get back to you on this.

Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adamcrews - thanks for your patience.

Your change looks great and I'll get it merged shortly.

We'll also open an issue to follow up by checking whether other USER or USERNAME placeholders are correct or whether any of them should also be replaced by OWNER.

@felicitymay felicitymay enabled auto-merge (squash) March 9, 2023 12:16
@felicitymay felicitymay merged commit 0727a6b into github:main Mar 9, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2023

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set repositories Content related to repositories waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants