jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 09:57:42 -05:00
Code Issues Projects Releases Wiki Activity
Files
main
docs/data/variables/product.yml
Felix Guntrip edeee8ecb6 GitHub Enterprise Server 3.19 RC (#58358) 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Usha N <n-usha@github.com>
Co-authored-by: Erin Havens <erinhav@github.com>
Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com>
Co-authored-by: Steve Ward <steveward@github.com>
2025-12-02 16:06:38 +00:00

381 lines
16 KiB
YAML
Raw Permalink Blame History

# Contains versioned and unversioned variables for all of our product names
## WARNING: Versioned variables don't work as expected in articles under "content/enterprise/admin/". Use unversioned variables instead.
# Company
# Use this variable when referring to the company in the context of its business. For example, in licensing agreements
company_short: 'GitHub'
# GitHub's flagship products
## Use this variable to refer generically to the "GitHub" platform or website (for example, when referring to GitHub.com, GHEC, or GHES as simply "GitHub").
## Use another variable if it is important to specify the environment (e.g. GHES)
github: 'GitHub'
## DO NOT USE. Use the `github` variable instead. (Writers found the name of this variable to be misleading.)
prodname_dotcom: 'GitHub'
## Use this variable when the output should always be GitHub Enterprise, regardless of the product the user is using
prodname_enterprise: 'GitHub Enterprise'
## Use this variable only when the output should specifically be GitHub.com, to distinguish from GitHub the company or other GitHub products (e.g. connecting GHE to GitHub.com)
## Note that many users access GitHub through a different URL
## Do NOT use as a synonym for "The GitHub web interface" (for example, if you want to distinguish something from the GitHub Mobile interface), or in cases where the .com top-level domain is not relevant.
prodname_dotcom_the_website: 'GitHub.com'
## Use these variables when the output should reflect one of our two specific GitHub Enterprise offerings
prodname_ghe_server: 'GitHub Enterprise Server'
prodname_ghe_cloud: 'GitHub Enterprise Cloud'
prodname_ghe_one: 'GitHub One'
prodname_docs: 'GitHub Docs'
prodname_free_user: 'GitHub Free'
prodname_pro: 'GitHub Pro'
prodname_team: 'GitHub Team'
prodname_free_team: 'GitHub Free'
prodname_enterprise_backup_utilities: 'GitHub Enterprise Server Backup Utilities'
prodname_enterprise_backup_service: 'GitHub Enterprise Server Backup Service'
# GitHub Connect (enterprise accounts, other unified features)
prodname_github_connect: 'GitHub Connect'
# GitHub Enterprise Importer
prodname_importer_proper_name: 'GitHub Enterprise Importer'
prodname_importer_secondary_name: Importer
prodname_gei: GEI
prodname_gei_cli_short: GEI extension
prodname_gei_cli: GEI extension of the GitHub CLI
prodname_ado2gh: ADO2GH
prodname_ado2gh_cli: ADO2GH extension of the GitHub CLI
prodname_ado2gh_cli_short: ADO2GH extension
prodname_bbs2gh: BBS2GH
prodname_bbs2gh_cli: BBS2GH extension of the GitHub CLI
prodname_bbs2gh_cli_short: BBS2GH extension
prodname_ghos: GitHub-owned blob storage
# GitHub Education
prodname_education: 'GitHub Education'
prodname_education_community: 'Education Community'
prodname_education_community_with_url: 'the [GitHub Education Community](https://github.com/orgs/community/discussions/categories/github-education)'
prodname_education_forum_link: 'https://github.com/orgs/community/discussions/categories/github-education'
prodname_classroom: 'GitHub Classroom'
prodname_classroom_with_url: '[GitHub Classroom](https://classroom.github.com/login)'
prodname_campus_program: 'GitHub Campus Program'
prodname_student_pack: 'GitHub Student Developer Pack'
prodname_global_campus: 'GitHub Education'
prodname_community_exchange: 'GitHub Community Exchange'
prodname_student_leader_program: 'GitHub Campus Experts'
prodname_student_leader_program_singular: 'GitHub Campus Expert'
prodname_octernships: 'GitHub Octernships'
prodname_octernship_singular: 'GitHub Octernship'
prodname_certifications: 'GitHub Certifications'
prodname_certifications_singular: 'GitHub Certification'
# GitHub Expert Services
prodname_expert_services: 'GitHub Expert Services'
# GitHub CLI
prodname_cli: 'GitHub CLI'
# GitHub Desktop
prodname_desktop: 'GitHub Desktop'
desktop_link: 'https://desktop.github.com/'
# GitHub Mobile
prodname_mobile: 'GitHub Mobile'
prodname_ios: 'GitHub for iOS'
prodname_android: 'GitHub for Android'
# GitHub Pages
prodname_pages: 'GitHub Pages'
# CodeQL
prodname_codeql: 'CodeQL'
prodname_codeql_cli: 'CodeQL CLI'
# The CodeQL CLI version recommended for each GHES version.
# CodeQL usually bumps its minor version for each minor version of GHES.
# Update this whenever a new enterprise version of CodeQL is being prepared.
codeql_cli_ghes_recommended_version: >-
{% ifversion ghes < 3.15 %}2.17.6{% elsif ghes < 3.16 %}2.18.4{% elsif ghes < 3.17 %}2.20.3{% elsif ghes < 3.18 %}2.20.7{% elsif ghes < 3.19 %}2.21.4{% elsif ghes < 3.20 %}2.22.4{% endif %}
codeql_cli_version_min_version_create_bundle: '2.17.6'
# Projects v2
prodname_projects_v2: 'Projects'
prodname_projects_v1: >-
projects (classic)
prodname_projects_v1_caps: >-
Projects (classic)
prodname_project_v1: >-
project (classic)
prodname_project_v1_caps: >-
Project (classic)
# Personal access tokens
pat_generic: 'personal access token'
pat_generic_plural: 'personal access tokens'
pat_generic_caps: 'Personal access token'
pat_generic_caps_plural: 'Personal access tokens'
pat_generic_title_case: 'Personal Access Token'
pat_generic_title_case_plural: 'Personal Access Tokens'
pat_v2: 'fine-grained personal access token'
pat_v2_plural: 'fine-grained personal access tokens'
pat_v2_caps: 'Fine-grained personal access token'
pat_v2_caps_plural: 'Fine-grained personal access tokens'
pat_v1: >-
personal access token (classic)
pat_v1_plural: >-
personal access tokens (classic)
pat_v1_caps: >-
Personal access token (classic)
pat_v1_caps_plural: >-
Personal access tokens (classic)
pat_classic: 'token (classic)'
pat_classic_plural: 'tokens (classic)'
pat_classic_caps: 'Token (classic)'
# Apps, GitHub Marketplace, and integrations
prodname_marketplace: 'GitHub Marketplace'
prodname_github_app: 'GitHub App'
prodname_github_apps: 'GitHub Apps'
prodname_oauth_app: 'OAuth app'
prodname_oauth_apps: 'OAuth apps'
prodname_github_models: 'GitHub Models'
# API and developer docs
prodname_enterprise_api: 'GitHub Enterprise Server APIs'
prodname_unfurls: 'Content Attachments'
# GitHub Actions
## Use this variable only when referring to GitHub Actions the product. When referring to the thing that someone creates using the product, call it an action (small a). See the terminology page of the Brand Guide for more.
prodname_actions: 'GitHub Actions'
prodname_actions_runner_controller: 'Actions Runner Controller'
runner_required_version: >-
{% ifversion ghes < 3.15 %}2.317.0{% elsif ghes < 3.16 %}2.319.1{% elsif ghes < 3.17 %}2.321.0{% elsif ghes < 3.18 %}2.322.0{% elsif ghes < 3.19 %}2.324.0{% elsif ghes < 3.20 %}2.328.0{% endif %}
# GitHub Debug
prodname_debug: 'GitHub Debug'
# GitHub Discussions
prodname_discussions: 'GitHub Discussions'
# GitHub Enterprise Managed Users
prodname_emu_idp_application: 'GitHub Enterprise Managed User'
prodname_emu_idp_oidc_application: 'GitHub Enterprise Managed User (OIDC)'
prodname_emus: 'Enterprise Managed Users'
prodname_emu: 'Enterprise Managed User'
# GitHub Issues
prodname_github_issues: 'GitHub Issues'
# GitHub Packages
prodname_registry: 'GitHub Packages'
prodname_container_registry: 'Container registry'
prodname_container_registries: 'Container registries'
prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes %}<code>docker.<em>HOSTNAME</em></code>{% endif %}'
prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes %}<code>containers.<em>HOSTNAME</em></code>{% endif %}'
prodname_npm_registry: 'npm registry'
# GitHub Insights
prodname_insights: 'GitHub Insights'
# GitHub Sponsors
prodname_sponsors: 'GitHub Sponsors'
prodname_matching_fund: 'GitHub Sponsors Matching Fund'
# GitHub Advanced Security
# ------------------------
## Full product names
prodname_GHAS: 'GitHub Advanced Security'
prodname_GH_code_security: '{% ifversion ghas-products %}GitHub Code Security{% else %}GitHub Advanced Security{% endif %}'
prodname_GH_secret_protection: '{% ifversion ghas-products %}GitHub Secret Protection{% else %}GitHub Advanced Security{% endif %}'
### Useful in unversioned docs
prodname_GH_code_security_always: 'GitHub Code Security'
prodname_GH_secret_protection_always: 'GitHub Secret Protection'
## GHAS or GHAS products
prodname_GHAS_or_code_security: '{% ifversion ghas-products %}GitHub Code Security or {% endif %}GitHub Advanced Security'
prodname_GHAS_or_secret_protection: '{% ifversion ghas-products %}GitHub Secret Protection or {% endif %}GitHub Advanced Security'
prodname_GHAS_cs_or_sp: '{% ifversion ghas-products %}GitHub Secret Protection, GitHub Code Security, or {% endif %}GitHub Advanced Security'
prodname_GH_cs_or_sp: '{% ifversion ghas-products %}GitHub Secret Protection or GitHub Code Security{% else %}GitHub Advanced Security{% endif %}'
## GitHub Code Quality preview only
prodname_GH_sp_cs_and_cq_or_as: '{% data variables.product.prodname_GH_secret_protection %}, {% data variables.product.prodname_GH_code_security %}{% ifversion code-quality %} and {% data variables.product.prodname_code_quality %} ({% data variables.release-phases.public_preview %}){% endif %}, or {% data variables.product.prodname_GHAS %}'
## GHAS and GHAS products
prodname_GHAS_cs_and_sp: '{% ifversion ghas-products %}GitHub Secret Protection, GitHub Code Security, and {% endif %}GitHub Advanced Security'
prodname_GH_cs_and_sp: '{% ifversion ghas-products %}GitHub Secret Protection and GitHub Code Security{% else %}GitHub Advanced Security{% endif %}'
## Short or UI names
prodname_AS: 'Advanced Security'
prodname_code_security: '{% ifversion ghas-products %}Code Security{% else %}Advanced Security{% endif %}'
prodname_secret_protection: '{% ifversion ghas-products %}Secret Protection{% else %}Advanced Security{% endif %}'
prodname_cs_or_sp: '{% ifversion ghas-products %}Secret Protection or Code Security{% else %}Advanced Security{% endif %}'
prodname_cs_and_sp: '{% ifversion ghas-products %}Secret Protection and Code Security{% else %}Advanced Security{% endif %}'
UI_advanced_security: '{% ifversion ghas-products %}{% data variables.product.prodname_AS %}{% elsif ghes > 3.15 %}Code security{% else %}Code security and analysis{% endif %}'
UI_advanced_security_ent: '{% ifversion ghas-products %}{% data variables.product.prodname_AS %}{% elsif ghes > 3.14 %}Code security{% else %}Code security and analysis{% endif %}'
UI_code_security_scanning: '{% ifversion ghas-products %}Code Security{% else %}Code scanning{% endif %}'
UI_secret_protection_scanning: '{% ifversion ghas-products %}Secret Protection{% else %}Secret scanning{% endif %}'
## OLD variables, DO NOT USE
prodname_GH_advanced_security: 'GitHub Advanced Security'
prodname_advanced_security: 'Advanced Security'
## Secret risk assessment
prodname_secret_risk_assessment: 'secret risk assessment'
prodname_secret_risk_assessment_caps: 'Secret risk assessment'
## Azure DevOps
prodname_ghas_azdo: 'GitHub Advanced Security for Azure DevOps'
## Microsoft Defender for Cloud integration with GitHub Code Security
prodname_microsoft_defender: 'Microsoft Defender for Cloud'
prodname_mdc_definition: 'Microsoft Defender for Cloud (MDC)'
prodname_mdc: 'MDC'
# Codespaces
prodname_codespaces: 'Codespaces'
prodname_github_codespaces: 'GitHub Codespaces'
# GitHub resources: blog, jobs, skills
prodname_gcf: 'GitHub Community Support'
prodname_github_community: 'GitHub Community'
prodname_blog: 'the GitHub Blog'
prodname_jobs: 'GitHub Jobs'
prodname_learning: 'GitHub Skills'
prodname_learning_link: 'https://skills.github.com/'
prodname_roadmap: 'GitHub public roadmap'
prodname_roadmap_link: 'https://github.com/github/roadmap#github-public-roadmap'
# GitHub Support plans
standard_support_plan: 'Standard plan'
premium_support_plan: 'Premium plan'
premium_plus_support_plan: 'Premium Plus plan'
microsoft_premium_plus_support_plan: 'Mission Critical Services for GitHub plan'
support_ticket_priority_urgent: 'Urgent'
support_ticket_priority_high: 'High'
support_ticket_priority_normal: 'Normal'
support_ticket_priority_low: 'Low'
# GitHub Professional Services
prodname_professional_services: 'GitHub Professional Services'
prodname_professional_services_team: 'Expert Services'
# GitHub Security Lab
prodname_security: 'GitHub Security Lab'
prodname_security_link: 'https://securitylab.github.com/'
# GitHub Security Advisories
prodname_security_advisories: 'GitHub Security Advisories'
prodname_advisory_database: 'GitHub Advisory Database'
# Security configurations and organization-level security settings
prodname_security_configurations: 'security configurations'
prodname_security_configurations_caps: 'Security configurations'
prodname_security_configuration: 'security configuration'
prodname_github_security_configuration: 'GitHub-recommended security configuration'
prodname_custom_security_configurations: 'custom security configurations'
prodname_custom_security_configuration: 'custom security configuration'
prodname_custom_security_configurations_caps: 'Custom security configurations'
prodname_custom_security_configuration_caps: 'Custom security configuration'
prodname_global_settings: 'global settings'
prodname_global_settings_caps: 'Global settings'
# Secret scanning
prodname_secret_scanning: 'secret scanning' # Overall feature name and name for GHES
prodname_secret_scanning_caps: 'Secret scanning'
# Code scanning
prodname_code_scanning: 'code scanning'
prodname_code_scanning_caps: 'Code scanning'
# Visual Studio
prodname_vs: 'Visual Studio'
# Visual Studio Code
prodname_vscode_shortname: 'VS Code'
prodname_vscode: 'Visual Studio Code'
prodname_vscode_command_palette_shortname: 'VS Code Command Palette'
prodname_vscode_command_palette: 'Visual Studio Code Command Palette'
prodname_vscode_marketplace: 'Visual Studio Code Marketplace'
prodname_vs_marketplace_shortname: 'VS Code Marketplace'
# GitHub Dependabot
prodname_dependabot: 'Dependabot'
prodname_dependabot_alerts: 'Dependabot alerts'
prodname_dependabot_security_updates: 'Dependabot security updates'
prodname_dependabot_version_updates: 'Dependabot version updates'
prodname_dependabot_updates: 'Dependabot updates'
# GitHub Archive Program
prodname_archive: 'GitHub Archive Program'
prodname_arctic_vault: 'Arctic Code Vault'
# GitHub Copilot (product)
prodname_copilot: 'GitHub Copilot'
prodname_copilot_short: 'Copilot'
# Premium requests (used to bill products like Copilot, Spark)
prodname_pru: 'premium request'
prodname_prus: 'premium requests'
prodname_prus_caps: 'Premium requests'
# GitHub Spark
prodname_spark: 'GitHub Spark'
prodname_spark_short: 'Spark'
# GitHub Code Quality
prodname_code_quality: 'GitHub Code Quality'
prodname_code_quality_short: 'Code Quality'
# Windows
prodname_windows_terminal: 'Windows Terminal'
# Command Palette
prodname_command_palette: 'GitHub Command Palette'
# Server Statistics
prodname_server_statistics: 'Server Statistics'
# GitHub Importer
prodname_importer: 'GitHub Importer'
# GitHub Actions Importer
prodname_actions_importer: 'GitHub Actions Importer'
# Node Eligibility Service
prodname_nes: Node Eligibility Service
# Links
product_url: >-
{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}
pricing_url: 'https://github.com/pricing'
pricing_link: '[GitHub Pricing](https://github.com/pricing)'
raw_github_com: >-
{% ifversion fpt or ghec %}raw.githubusercontent.com{% else %}HOSTNAME/user/repo/raw{% endif %}
login_url: >-
{%- ifversion fpt or ghec %}
[`https://github.com/login`](https://github.com/login)
{%- elsif ghes %}
`http(s)://HOSTNAME/login`
{%- endif %}
# GitHub Enterprise Server past versions
current-340-version: '11.10.354'
# Developer site product variables
rest_url: >-
{% ifversion fpt or ghec %}https://api.github.com{% elsif ghes %}http(s)://HOSTNAME/api/v3{% endif %}
# Use this inside command-line code blocks
# Enterprise OAuth paths that don't include "/graphql" or "/api/v3"
oauth_host_code: >-
{% ifversion fpt or ghec %}https://github.com{% else %}http(s)://HOSTNAME{% endif %}
device_authorization_url: >-
{%- ifversion fpt or ghec %}
[`https://github.com/login/device`](https://github.com/login/device)
{%- elsif ghes %}
`http(s)://HOSTNAME/login/device`
{%- endif %}
graphql_url: >-
{% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://HOSTNAME/api/graphql{% endif %}
# OpenAI Codex
prodname_openai_codex: 'OpenAI Codex'
Reference in New Issue View Git Blame Copy Permalink