meta:
default_description: Get started, troubleshoot, and make the most of GitHub. Documentation for new users, developers, administrators, and all of GitHub's products.
header:
github_docs: GitHub Docs
contact: Contact
notices:
release_candidate:
# The version name is rendered before the below text via includes/header-notification.html
' is currently available as a release candidate.'
early_access: 📣 Please do not share this URL publicly. This page contains content about a private preview feature.
release_notes_use_latest: Please use the latest release for the latest security, performance, and bug fixes.
# GHES release notes
ghes_release_notes_upgrade_patch_only: 📣 This is not the latest patch release of Enterprise Server.
ghes_release_notes_upgrade_release_only: 📣 This is not the latest release of Enterprise Server.
ghes_release_notes_upgrade_patch_and_release: 📣 This is not the latest patch release of this release series, and this is not the latest release of Enterprise Server.
sign_up_cta: Sign up
menu: Menu
open_menu_label: Open menu
go_home: Home
picker:
language_picker_label: Language
product_picker_default_text: All products
version_picker_default_text: Choose a version
release_notes:
banner_text: GitHub began rolling these changes out to enterprises on
search:
input:
placeholder: Search or ask {{icon}} Copilot
placeholder_no_icon: Search or ask Copilot
shortcut: Type {{icon}} to search
overlay:
aria_label: Search overlay
input_aria_label: Search or ask Copilot
suggestions_list_aria_label: Search suggestions
ai_suggestions_list_aria_label: Copilot search suggestions
general_suggestions_list_aria_label: Docs search suggestions
general_suggestions_list_heading: Search docs
ai_autocomplete_list_heading: Ask Copilot
give_feedback: Give feedback
beta_tag: Beta
return_to_search: Return to search
clear_search_query: Clear
view_all_search_results: View more results
no_results_found: No results found
no_results_found_announcement: 'Search Docs: No results found'
search_docs_with_query: Search docs for "{{query}}"
privacy_disclaimer: For product and service improvement purposes, the GitHub Docs team will retain questions and answers generated in the Docs search function. Please see the GitHub Privacy Statement to review how GitHub collects and uses your data.
ai:
disclaimer: Copilot uses AI. Check for mistakes.
references: Copilot Sources
loading_status_message: Loading Copilot response...
done_loading_status_message: Done loading Copilot response
share_answer: Copy answer URL
share_copied_announcement: Copied share URL!
thumbs_up: This answer was helpful
thumbs_down: This answer was not helpful
thumbs_announcement: Thank you for your feedback!
back_to_search: Back to search
responses:
unable_to_answer: Sorry, I'm unable to answer that question. Check that you selected the correct GitHub version or try a different question.
query_too_large: Sorry, your question is too long. Please try shortening it and asking again.
asked_too_many_times: Sorry, you've asked too many questions in a short time period. Please wait a few minutes and try again.
invalid_query: Sorry, I'm unable to answer that question. Please try asking a different question.
response:
copy_code: Copy code to clipboard
copy_code_lang: Copy {language} code to clipboard
copied_code: Copied!
failure:
general_title: There was an error loading search results.
ai_title: There was an error loading Copilot.
description: You can still use this field to search our docs.
old_search:
description: Enter a search term to find it in the GitHub Docs.
placeholder: Search GitHub Docs
label: Search GitHub Docs
search_results:
search_results_for: Search results for
matches_displayed: Matches displayed
n_results: '{n} results'
search_validation_error: Validation error with search query
filter: Filter
clear_filter: Clear
homepage:
explore_by_product: Explore by product
version_picker: Version
description: Help for wherever you are on your GitHub journey.
toc:
getting_started: Getting started
popular: Popular
startHere: Start here
whats_new: What's new
videos: Videos
all_changelogs: All changelog posts
pages:
article_version: 'Article version'
miniToc: In this article
all_enterprise_releases: All Enterprise Server releases
about_versions: About versions
permissions_callout_title: Who can use this feature?
video_from_transcript: See video for this transcript
support:
still_need_help: Still need help?
contact_support: Contact support
ask_community: Ask the GitHub community
survey:
able_to_find: Did you find what you needed?
yes: Yes
no: No
cancel: Cancel
additional_feedback: Can you tell us more about your rating? (Optional)
optional: Optional
required: Required
email_label: Leave your email if we can contact you. (Optional)
email_validation: Please enter a valid email address
send: Send
feedback: Thank you! We received your feedback.
not_support: If you need a reply, please contact support.
privacy_policy: Privacy policy
server_error: Unable to process comment at the moment. Please try again.
contribution_cta:
title: Help us make these docs great!
body: All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.
button: Make a contribution
to_guidelines: Learn how to contribute
parameter_table:
body: Body parameters
webhook-body: Webhook request body parameters
default: Default
description: Description
enum_description_title: Can be one of
headers: Headers
name: Name
path: Path parameters
query: Query parameters
required: Required
see_preview_notice: See preview notice
see_preview_notices: See preview notices
type: Type
single_enum_description: Value
audit_logs:
action: Action
description: Description
fields: Fields
reference: Reference
graphql:
reference:
implements: {{ GraphQLItemTitle }} Implements
fields: Fields for {{ GraphQLItemTitle }}
arguments: Arguments for {{ GraphQLItemTitle }}
name: Name
type: Type
description: Description
input_fields: Input fields for {{ GraphQLItemTitle }}
return_fields: Return fields for {{ GraphQLItemTitle }}
implemented_by: |
{{ GraphQLItemTitle }} is implemented by
values: Values for {{ GraphQLItemTitle }}
possible_types: Possible types for {{ GraphQLItemTitle }}
preview_notice: Preview notice
deprecation_notice: Deprecation notice
preview_period: During the preview period, the API may change without notice.
overview:
preview_header: 'To toggle this preview and access the following schema members, you must provide a custom media type in the `Accept` header:'
preview_schema_members: 'Previewed schema members'
announced: Announced
updates: Updates
rest:
banner:
api_versioned: The REST API is now versioned.
api_version_info: For more information, see "About API versioning."
ghes_api_versioned: After a site administrator upgrades your Enterprise Server instance to {{ firstGhesReleaseWithApiVersions.versionTitle }} or later, the REST API will be versioned. To learn how to find your instance's version, see "About versions of GitHub Docs".
redirect_notice: We've recently moved some of the REST API documentation.
redirect_repo: If you can't find what you're looking for, you might try the new {{ newRestPagesLinks }} REST API pages.
redirect_enterprise: If you can't find what you're looking for, you might try the {{ actionsPageLink }} REST API page.
actions_api_title: Actions
versioning:
about_versions: About REST API versions
overview:
permissions:
access: Access
endpoints: Endpoint
tokens: Token types
additionalPermissions: Additional permissions
uat: UAT
iat: IAT
screen_reader_text_checkmark_icon: Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.
rest_reference:
in: In
description: Description
notes: Notes
parameters: Parameters for "{{ RESTOperationTitle }}"
response: Response
request_example: Request example
request_examples: Request examples
example_response: Example response
status_code: Status code
http_status_code: HTTP response status codes for "{{ RESTOperationTitle }}"
code_sample: Code sample
code_samples: Code samples for "{{ RESTOperationTitle }}"
data_residency_notice: If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.
preview_notice: Preview notice for "{{ RESTOperationTitle }}"
preview_notices: Preview notices for "{{ RESTOperationTitle }}"
fine_grained_access: Fine-grained access tokens for "{{ RESTOperationTitle }}"
preview_header_is_required: This header is required
preview_notice_to_change: This API is under preview and subject to change
api_reference: REST API reference
enum_description_title: Can be one of
required: Required
headers: Headers
query: Query parameters
path: Path parameters
body: Body parameters
response_options:
example: Example response
schema: Response schema
code_sample_options:
ghcli: GitHub CLI
javascript: JavaScript
curl: cURL
button_text:
copy_to_clipboard: Copy to clipboard
copied: Copied!
works_with_fine_grained_tokens: 'This endpoint works with the following fine-grained token types'
permission_sets: 'The fine-grained token must have at least one of the following permission sets'
permission_set: 'The fine-grained token must have the following permission set'
no_permission_sets: 'The fine-grained token does not require any permissions.'
allows_public_read_access: This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.
allows_public_read_access_no_permissions: This endpoint can be used without authentication if only public resources are requested.
user_access_token_name: GitHub App user access tokens
installation_access_token_name: GitHub App installation access tokens
fine_grained_access_token_name: Fine-grained personal access tokens
no_fine_grained_access: This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
basic_auth_heading: Basic authentication for "{{ RESTOperationTitle }}"
basic_auth: You must use Basic Authentication to use this endpoint. Use the application's client_id as the username and the client_secret as the password.
webhooks:
action_type_switch_error: There was an error switching webhook action types.
action_type: Action type
availability: Availability for {{ WebhookName }}
webhook_payload_object: Webhook payload object for {{ WebhookName }}
webhook_payload_example: Webhook payload example
rephrase_availability:
repository: Repositories
organization: Organizations
app: GitHub Apps
business: Enterprises
marketplace: GitHub Marketplace
sponsors_listing: Sponsored accounts
footer:
support_heading: Help and support
legal_heading: Legal
imprint: Imprint
terms: Terms
privacy: Privacy
status: Status
pricing: Pricing
expert_services: Expert services
blog: Blog
machine: Some of this content may be machine- or AI-translated.
journey_landing:
articles: '{{ number }} Articles'
articles_heading: Articles
product_landing:
article_grid:
heading: Articles
all_categories: All categories
search_articles: Search articles
no_articles_found: No articles found matching your criteria.
showing_results: Showing {start}-{end} of {total}
carousel:
recommended: Recommended
quickstart: Quickstart
reference: Reference
overview: Overview
try_ghec_for_free: Try GitHub's enterprise features
try_ghas_for_free: Try GitHub Advanced Security for free
generate_secret_risk_assessment_report_for_free: Find out how to run a free secret risk assessment
plan_your_migration: Plan your migration
releases: Releases
guides: Guides
explore_guides: Explore guides
explore_people_and_projects: Explore people and projects
sorry: Sorry, there is no result for
no_example: It looks like we don't have an example that fits your filter.
try_another: Try another filter or add your code example.
no_result: Sorry, there are no guides that match your filter.
learn: Learn how to add a code example
communities_using_discussions: Communities on GitHub.com using discussions
add_your_community: Add your community
sponsor_community: GitHub Sponsors community
supported_releases: Supported releases
release_notes_for: Release notes for
upgrade_from: Upgrade from
browse_all_docs: Browse all docs
browse_all: Browse all
docs: docs
explore_release_notes: Explore release notes
view: View all
view_transcript: View video transcript
all_docs: 'All {{ title }} docs'
all_content: 'View all {{ title }} content'
product_guides:
learning_paths_title: '{{ name }} learning paths'
start_path: Start learning path
learning_paths_desc: Learning paths are a collection of guides that help you master a particular subject.
more_guides: more guides
load_more: Load more guides
all_guides_title: 'All {{ name }} guides'
filter_instructions: Filter the guide list using these controls
guides_found:
multiple: '{n} guides found'
one: 1 guide found
none: No guides found
guide_types:
overview: Overview
quick_start: Quickstart
tutorial: Tutorial
how_to: How-to guide
reference: Reference
learning_track_nav:
prev_guide: Previous
next_guide: Next
more_guides: More guides →
current_progress: '{i} of {n} in learning path'
journey_track_nav:
prev_article: Previous
next_article: Next
more_articles: More articles →
current_progress: 'Article {i} of {n}'
scroll_button:
scroll_to_top: Scroll to top
popovers:
role_description: hovercard link
alerts:
NOTE: Note
IMPORTANT: Important
WARNING: Warning
TIP: Tip
CAUTION: Caution
cookbook_landing:
spotlight: Spotlight
explore_articles: Explore {{ number }} examples
reset_filters: Reset filters
search_articles: Search examples
category: Category
complexity: Complexity
not_found:
title: Ooops!
message: It looks like this page doesn't exist.
contact: We track these errors automatically, but if the problem persists please feel free to contact us.
contact_cta: Contact support