diff --git a/content/admin/advanced-security/about-licensing-for-github-advanced-security.md b/content/admin/advanced-security/about-licensing-for-github-advanced-security.md index ff95e75ad2..9793d2f7e2 100644 --- a/content/admin/advanced-security/about-licensing-for-github-advanced-security.md +++ b/content/admin/advanced-security/about-licensing-for-github-advanced-security.md @@ -4,8 +4,12 @@ intro: 'You need a license to use {% data variables.product.prodname_GH_advanced product: '{% data reusables.gated-features.ghas %}' versions: enterprise-server: '>=3.1' +type: overview topics: + - Advanced Security - Enterprise + - Licensing + - Security --- ### About licensing for {% data variables.product.prodname_GH_advanced_security %} diff --git a/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md b/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md index 03148b0821..46e15abe8f 100644 --- a/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md +++ b/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md @@ -9,8 +9,12 @@ redirect_from: - /admin/configuration/configuring-code-scanning-for-your-appliance versions: enterprise-server: '>=2.22' +type: how_to topics: + - Advanced Security + - Code scanning - Enterprise + - Security --- {% data reusables.code-scanning.beta %} diff --git a/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md b/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md index 006dfb90a1..c6f266be2c 100644 --- a/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md +++ b/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md @@ -8,8 +8,12 @@ redirect_from: - /admin/configuration/configuring-secret-scanning-for-your-appliance versions: enterprise-server: '>=3.0' +type: how_to topics: + - Advanced Security - Enterprise + - Secret scanning + - Security --- {% data reusables.secret-scanning.beta %} diff --git a/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md b/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md index 1cd545e1e6..99c85263fa 100644 --- a/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md +++ b/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md @@ -5,8 +5,13 @@ intro: 'You can configure {% data variables.product.product_name %} to include { product: '{% data reusables.gated-features.ghas %}' versions: enterprise-server: '>=2.22' +type: how_to topics: + - Advanced Security + - Code scanning - Enterprise + - Secret scanning + - Security --- ### About enabling {% data variables.product.prodname_GH_advanced_security %} diff --git a/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md b/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md index b6075d5322..0daee7c3a1 100644 --- a/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md +++ b/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md @@ -5,6 +5,13 @@ intro: 'You can use {% if enterpriseServerVersions contains currentVersion %}{% product: '{% data reusables.gated-features.saml-sso %}' versions: github-ae: '*' +type: overview +topics: + - Accounts + - Access management + - Authentication + - Enterprise + - Identity --- ### About identity and access management for your enterprise diff --git a/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md b/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md index 2773c0c703..a6291aba22 100644 --- a/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md +++ b/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider versions: enterprise-server: '*' +type: how_to topics: + - Accounts + - Authentication - Enterprise + - Identity --- ### About built-in authentication for users outside your identity provider diff --git a/content/admin/authentication/changing-authentication-methods.md b/content/admin/authentication/changing-authentication-methods.md index 3335085752..07713148e6 100644 --- a/content/admin/authentication/changing-authentication-methods.md +++ b/content/admin/authentication/changing-authentication-methods.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/authentication/changing-authentication-methods versions: enterprise-server: '*' +type: overview topics: + - Accounts + - Authentication - Enterprise + - Identity --- User accounts on {% data variables.product.product_location %} are preserved when you change the authentication method and users will continue to log into the same account as long as their username doesn't change. diff --git a/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 043e79414a..d82daa3613 100644 --- a/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -1,11 +1,18 @@ --- title: Configuring authentication and provisioning for your enterprise using Azure AD shortTitle: Configuring with Azure AD -intro: You can use a tenant in Azure Active Directory (Azure AD) as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.product.product_location %}. -permissions: Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}. +intro: 'You can use a tenant in Azure Active Directory (Azure AD) as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.product.product_location %}.' +permissions: 'Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.saml-sso %}' versions: github-ae: '*' +type: how_to +topics: + - Accounts + - Authentication + - Enterprise + - Identity + - SSO --- ### About authentication and user provisioning with Azure AD diff --git a/content/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise.md b/content/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise.md index 69e0358289..df48882a6e 100644 --- a/content/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise.md +++ b/content/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise.md @@ -1,11 +1,18 @@ --- title: Configuring SAML single sign-on for your enterprise shortTitle: Configuring SAML SSO -intro: You can configure SAML single sign-on (SSO) for your enterprise, which allows you to centrally control authentication for {% data variables.product.product_location %} using your identity provider (IdP). +intro: 'You can configure SAML single sign-on (SSO) for your enterprise, which allows you to centrally control authentication for {% data variables.product.product_location %} using your identity provider (IdP).' product: '{% data reusables.gated-features.saml-sso %}' -permissions: Enterprise owners can configure SAML SSO for an enterprise on {% data variables.product.product_name %}. +permissions: 'Enterprise owners can configure SAML SSO for an enterprise on {% data variables.product.product_name %}.' versions: github-ae: '*' +type: how_to +topics: + - Accounts + - Authentication + - Enterprise + - Identity + - SSO --- ### About SAML SSO diff --git a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md index 6e936006e1..9323828213 100644 --- a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md +++ b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md @@ -1,11 +1,18 @@ --- title: Configuring user provisioning for your enterprise shortTitle: Configuring user provisioning -intro: You can configure System for Cross-domain Identity Management (SCIM) for your enterprise, which automatically provisions user accounts on {% data variables.product.product_location %} when you assign the application for {% data variables.product.product_location %} to a user on your identity provider (IdP). -permissions: Enterprise owners can configure user provisioning for an enterprise on {% data variables.product.product_name %}. +intro: 'You can configure System for Cross-domain Identity Management (SCIM) for your enterprise, which automatically provisions user accounts on {% data variables.product.product_location %} when you assign the application for {% data variables.product.product_location %} to a user on your identity provider (IdP).' +permissions: 'Enterprise owners can configure user provisioning for an enterprise on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.saml-sso %}' versions: github-ae: '*' +type: how_to +topics: + - Accounts + - Authentication + - Enterprise + - Identity + - SSO --- ### About user provisioning for your enterprise diff --git a/content/admin/authentication/disabling-unauthenticated-sign-ups.md b/content/admin/authentication/disabling-unauthenticated-sign-ups.md index 3a2eebc166..417bc2996e 100644 --- a/content/admin/authentication/disabling-unauthenticated-sign-ups.md +++ b/content/admin/authentication/disabling-unauthenticated-sign-ups.md @@ -7,7 +7,10 @@ redirect_from: intro: 'If you''re using built-in authentication, you can block unauthenticated people from being able to create an account.' versions: enterprise-server: '*' +type: how_to topics: + - Accounts + - Authentication - Enterprise --- diff --git a/content/admin/authentication/using-built-in-authentication.md b/content/admin/authentication/using-built-in-authentication.md index fd7d4d1ccb..f3d9e5ad07 100644 --- a/content/admin/authentication/using-built-in-authentication.md +++ b/content/admin/authentication/using-built-in-authentication.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/authentication/using-built-in-authentication versions: enterprise-server: '*' +type: how_to topics: + - Accounts + - Authentication - Enterprise + - Identity --- You can create custom messages that users will see on the sign in and sign out pages. For more information, see "[Customizing user messages on your instance](/enterprise/admin/user-management/customizing-user-messages-on-your-instance)." diff --git a/content/admin/authentication/using-cas.md b/content/admin/authentication/using-cas.md index 44bdfddef2..4b9e0bad66 100644 --- a/content/admin/authentication/using-cas.md +++ b/content/admin/authentication/using-cas.md @@ -8,8 +8,13 @@ redirect_from: intro: 'CAS is a single sign-on (SSO) protocol for multiple web applications. A CAS user account does not take up a {% if currentVersion ver_gt "enterprise-server@2.16" %}user license{% else %}seat{% endif %} until the user signs in.' versions: enterprise-server: '*' +type: how_to topics: + - Accounts + - Authentication - Enterprise + - Identity + - SSO --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/authentication/using-ldap.md b/content/admin/authentication/using-ldap.md index 357e4f96fb..a2ae58eacc 100644 --- a/content/admin/authentication/using-ldap.md +++ b/content/admin/authentication/using-ldap.md @@ -11,8 +11,12 @@ redirect_from: intro: 'LDAP lets you authenticate {% data variables.product.prodname_ghe_server %} against your existing accounts and centrally manage repository access. LDAP is a popular application protocol for accessing and maintaining directory information services, and is one of the most common protocols used to integrate third-party software with large company user directories.' versions: enterprise-server: '*' +type: how_to topics: + - Accounts + - Authentication - Enterprise + - Identity --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/authentication/using-saml.md b/content/admin/authentication/using-saml.md index 0499a38feb..de9a555f42 100644 --- a/content/admin/authentication/using-saml.md +++ b/content/admin/authentication/using-saml.md @@ -8,8 +8,13 @@ redirect_from: intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).' versions: enterprise-server: '*' +type: how_to topics: + - Accounts + - Authentication - Enterprise + - Identity + - SSO --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/configuration/about-enterprise-configuration.md b/content/admin/configuration/about-enterprise-configuration.md index 4ec9e94458..d61f4cb551 100644 --- a/content/admin/configuration/about-enterprise-configuration.md +++ b/content/admin/configuration/about-enterprise-configuration.md @@ -4,8 +4,11 @@ intro: 'You can use the site admin dashboard{% if enterpriseServerVersions conta versions: enterprise-server: '*' github-ae: '*' +type: overview topics: - Enterprise + - Fundamentals + - SSH --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/configuration/accessing-the-administrative-shell-ssh.md b/content/admin/configuration/accessing-the-administrative-shell-ssh.md index 3e206b35db..ee2f964ce6 100644 --- a/content/admin/configuration/accessing-the-administrative-shell-ssh.md +++ b/content/admin/configuration/accessing-the-administrative-shell-ssh.md @@ -13,8 +13,11 @@ redirect_from: intro: '{% data reusables.enterprise_site_admin_settings.about-ssh-access %}' versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - SSH --- ### About administrative shell access diff --git a/content/admin/configuration/accessing-the-management-console.md b/content/admin/configuration/accessing-the-management-console.md index f0adf005d9..5b2b4d0ca8 100644 --- a/content/admin/configuration/accessing-the-management-console.md +++ b/content/admin/configuration/accessing-the-management-console.md @@ -12,8 +12,10 @@ redirect_from: - /enterprise/admin/configuration/accessing-the-management-console versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals --- ### About the {% data variables.enterprise.management_console %} diff --git a/content/admin/configuration/command-line-utilities.md b/content/admin/configuration/command-line-utilities.md index b02ef9b094..7f64cb200c 100644 --- a/content/admin/configuration/command-line-utilities.md +++ b/content/admin/configuration/command-line-utilities.md @@ -9,8 +9,10 @@ redirect_from: miniTocMaxHeadingLevel: 4 versions: enterprise-server: '*' +type: reference topics: - Enterprise + - SSH --- You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." diff --git a/content/admin/configuration/configuring-a-hostname.md b/content/admin/configuration/configuring-a-hostname.md index 391d52b45d..370f999458 100644 --- a/content/admin/configuration/configuring-a-hostname.md +++ b/content/admin/configuration/configuring-a-hostname.md @@ -7,8 +7,11 @@ redirect_from: - /enterprise/admin/configuration/configuring-a-hostname versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure --- If you configure a hostname instead of a hard-coded IP address, you will be able to change the physical hardware that {% data variables.product.product_location %} runs on without affecting users or client software. diff --git a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md index 34bb68ff05..5a83a18c7a 100644 --- a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md +++ b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md @@ -7,8 +7,12 @@ redirect_from: - /enterprise/admin/configuration/configuring-an-outbound-web-proxy-server versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Networking --- When a proxy server is enabled for {% data variables.product.product_location %}, outbound messages sent by {% data variables.product.prodname_ghe_server %} are first sent through the proxy server, unless the destination host is added as an HTTP proxy exclusion. Types of outbound messages include outgoing webhooks, uploading bundles, and fetching legacy avatars. The proxy server's URL is the protocol, domain or IP address, plus the port number, for example `http://127.0.0.1:8123`. diff --git a/content/admin/configuration/configuring-applications.md b/content/admin/configuration/configuring-applications.md index f0110d71ce..55c1d964a0 100644 --- a/content/admin/configuration/configuring-applications.md +++ b/content/admin/configuration/configuring-applications.md @@ -6,8 +6,10 @@ redirect_from: - /enterprise/admin/configuration/configuring-applications versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals --- ### Adjusting image caching diff --git a/content/admin/configuration/configuring-backups-on-your-appliance.md b/content/admin/configuration/configuring-backups-on-your-appliance.md index 0ff74207a9..0e0b791943 100644 --- a/content/admin/configuration/configuring-backups-on-your-appliance.md +++ b/content/admin/configuration/configuring-backups-on-your-appliance.md @@ -1,5 +1,6 @@ --- title: Configuring backups on your appliance +shortTitle: Configuring backups redirect_from: - /enterprise/admin/categories/backups-and-restores/ - /enterprise/admin/articles/backup-and-recovery/ @@ -15,8 +16,12 @@ redirect_from: intro: 'As part of a disaster recovery plan, you can protect production data on {% data variables.product.product_location %} by configuring automated backups.' versions: enterprise-server: '*' +type: how_to topics: + - Backups - Enterprise + - Fundamentals + - Infrastructure --- ### About {% data variables.product.prodname_enterprise_backup_utilities %} diff --git a/content/admin/configuration/configuring-built-in-firewall-rules.md b/content/admin/configuration/configuring-built-in-firewall-rules.md index 098709faab..bdb64f0a92 100644 --- a/content/admin/configuration/configuring-built-in-firewall-rules.md +++ b/content/admin/configuration/configuring-built-in-firewall-rules.md @@ -7,8 +7,12 @@ redirect_from: - /enterprise/admin/configuration/configuring-built-in-firewall-rules versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Networking --- ### About {% data variables.product.product_location %}'s firewall diff --git a/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md b/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md index 73bffb3cd1..111d8c7c9c 100644 --- a/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md +++ b/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md @@ -4,6 +4,11 @@ shortTitle: Configuring data encryption intro: 'For encryption at rest, you can provide your own encryption key to encrypt your data under your encryption policies.' versions: github-ae: '*' +type: how_to +topics: + - Enterprise + - Fundamentals + - Security --- {% note %} diff --git a/content/admin/configuration/configuring-dns-nameservers.md b/content/admin/configuration/configuring-dns-nameservers.md index b4179fd598..96a0e4954f 100644 --- a/content/admin/configuration/configuring-dns-nameservers.md +++ b/content/admin/configuration/configuring-dns-nameservers.md @@ -7,8 +7,12 @@ redirect_from: - /enterprise/admin/configuration/configuring-dns-nameservers versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Networking --- The nameservers you specify must resolve {% data variables.product.product_location %}'s hostname. diff --git a/content/admin/configuration/configuring-email-for-notifications.md b/content/admin/configuration/configuring-email-for-notifications.md index 765b9c6be1..67e724ba7b 100644 --- a/content/admin/configuration/configuring-email-for-notifications.md +++ b/content/admin/configuration/configuring-email-for-notifications.md @@ -10,8 +10,12 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Notifications --- {% if currentVersion == "github-ae@latest" %} diff --git a/content/admin/configuration/configuring-github-pages-for-your-enterprise.md b/content/admin/configuration/configuring-github-pages-for-your-enterprise.md index c50c5d8030..6f98590f51 100644 --- a/content/admin/configuration/configuring-github-pages-for-your-enterprise.md +++ b/content/admin/configuration/configuring-github-pages-for-your-enterprise.md @@ -11,8 +11,10 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Pages --- ### Enabling public sites for {% data variables.product.prodname_pages %} diff --git a/content/admin/configuration/configuring-rate-limits.md b/content/admin/configuration/configuring-rate-limits.md index 0cda1470c3..0788b12cef 100644 --- a/content/admin/configuration/configuring-rate-limits.md +++ b/content/admin/configuration/configuring-rate-limits.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/configuration/configuring-rate-limits versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Infrastructure + - Performance --- ### Enabling rate limits for {% data variables.product.prodname_enterprise_api %} diff --git a/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md b/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md index 22e305c9e5..2256b3de1b 100644 --- a/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md +++ b/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Networking --- {% note %} diff --git a/content/admin/configuration/configuring-time-synchronization.md b/content/admin/configuration/configuring-time-synchronization.md index 616b093bec..3d01f622e0 100644 --- a/content/admin/configuration/configuring-time-synchronization.md +++ b/content/admin/configuration/configuring-time-synchronization.md @@ -10,8 +10,12 @@ redirect_from: - /enterprise/admin/configuration/configuring-time-synchronization versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Networking --- ### Changing the default NTP servers diff --git a/content/admin/configuration/configuring-tls.md b/content/admin/configuration/configuring-tls.md index 5f7ad1bde5..2dff28c8be 100644 --- a/content/admin/configuration/configuring-tls.md +++ b/content/admin/configuration/configuring-tls.md @@ -8,8 +8,13 @@ redirect_from: - /enterprise/admin/configuration/configuring-tls versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Networking + - Security --- ### About Transport Layer Security diff --git a/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md b/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md index 29193560c5..3eb37e374e 100644 --- a/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md +++ b/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md @@ -10,8 +10,12 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.' versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - GitHub Connect + - Infrastructure + - Networking --- ### About {% data variables.product.prodname_github_connect %} diff --git a/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md b/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md index 23662bf006..ac36100591 100644 --- a/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md +++ b/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md @@ -8,8 +8,10 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}.' versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Security --- ### About alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md b/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md index d1c2902462..09c05b7607 100644 --- a/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md +++ b/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md @@ -12,8 +12,12 @@ redirect_from: - /enterprise/admin/configuration/enabling-and-scheduling-maintenance-mode versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Maintenance + - Upgrades --- ### About maintenance mode diff --git a/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md b/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md index 7939e2c6c8..4b2b1862a0 100644 --- a/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md +++ b/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md @@ -7,8 +7,11 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable automatic user license synchronization.' versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - GitHub Connect + - Licensing --- ### About license synchronization diff --git a/content/admin/configuration/enabling-private-mode.md b/content/admin/configuration/enabling-private-mode.md index 2b91f26e6b..20f8b742fb 100644 --- a/content/admin/configuration/enabling-private-mode.md +++ b/content/admin/configuration/enabling-private-mode.md @@ -9,8 +9,16 @@ redirect_from: - /enterprise/admin/configuration/enabling-private-mode versions: enterprise-server: '*' +type: how_to topics: + - Access management + - Authentication - Enterprise + - Fundamentals + - Infrastructure + - Networking + - Privacy + - Security --- You must enable private mode if {% data variables.product.product_location %} is publicly accessible over the Internet. In private mode, users cannot anonymously clone repositories over `git://`. If built-in authentication is also enabled, an administrator must invite new users to create an account on the instance. For more information, see "[Using built-in authentication](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-built-in-authentication)." diff --git a/content/admin/configuration/enabling-subdomain-isolation.md b/content/admin/configuration/enabling-subdomain-isolation.md index 5f031b6378..07f229df63 100644 --- a/content/admin/configuration/enabling-subdomain-isolation.md +++ b/content/admin/configuration/enabling-subdomain-isolation.md @@ -7,8 +7,13 @@ redirect_from: - /enterprise/admin/configuration/enabling-subdomain-isolation versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Networking + - Security --- ### About subdomain isolation diff --git a/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md b/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md index 3c896155cb..a9f79c9fef 100644 --- a/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md +++ b/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md @@ -10,8 +10,10 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified contributions between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.' versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - GitHub Connect --- As a site administrator, you can allow end users to send anonymized contribution counts for their work from {% data variables.product.prodname_ghe_server %} to their {% data variables.product.prodname_dotcom_the_website %} contribution graph. diff --git a/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md b/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md index bc3ae8ac91..e913067e07 100644 --- a/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md +++ b/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md @@ -12,6 +12,8 @@ versions: enterprise-server: '*' topics: - Enterprise + - GitHub Connect + - GitHub search --- When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location_enterprise %}. diff --git a/content/admin/configuration/initializing-github-ae.md b/content/admin/configuration/initializing-github-ae.md index 2b9276c0bc..faddc475ac 100644 --- a/content/admin/configuration/initializing-github-ae.md +++ b/content/admin/configuration/initializing-github-ae.md @@ -3,6 +3,9 @@ title: Initializing GitHub AE intro: 'To get your enterprise ready to use, you can complete the initial configuration of {% data variables.product.product_name %}.' versions: github-ae: '*' +type: how_to +topics: + - Enterprise --- ### About initialization diff --git a/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md b/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md index e0414606f7..dd82c56362 100644 --- a/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md +++ b/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md @@ -4,8 +4,10 @@ intro: 'You can decide whether authenticated users can connect to {% data variab permissions: 'Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}.' versions: enterprise-server: '>=3.0' +type: how_to topics: - Enterprise + - Mobile --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/configuration/network-ports.md b/content/admin/configuration/network-ports.md index 517babf597..bc373f921d 100644 --- a/content/admin/configuration/network-ports.md +++ b/content/admin/configuration/network-ports.md @@ -10,8 +10,12 @@ redirect_from: intro: 'Open network ports selectively based on the network services you need to expose for administrators, end users, and email support.' versions: enterprise-server: '*' +type: reference topics: - Enterprise + - Infrastructure + - Networking + - Security --- ### Administrative ports diff --git a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md index fb9bf6d64d..6316dedaee 100644 --- a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md +++ b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md @@ -1,9 +1,16 @@ --- title: Restricting network traffic to your enterprise shortTitle: Restricting network traffic -intro: 'You can use an IP allow list to restrict access to your enterprise to connections from specified IP addresses.' +intro: You can use an IP allow list to restrict access to your enterprise to connections from specified IP addresses. versions: github-ae: '*' +type: how_to +topics: + - Access management + - Enterprise + - Fundamentals + - Networking + - Security --- ### About IP allow lists diff --git a/content/admin/configuration/site-admin-dashboard.md b/content/admin/configuration/site-admin-dashboard.md index fcfe91ed0a..821f77e18b 100644 --- a/content/admin/configuration/site-admin-dashboard.md +++ b/content/admin/configuration/site-admin-dashboard.md @@ -7,8 +7,10 @@ redirect_from: - /enterprise/admin/configuration/site-admin-dashboard versions: enterprise-server: '*' +type: reference topics: - Enterprise + - Fundamentals --- To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. diff --git a/content/admin/configuration/troubleshooting-ssl-errors.md b/content/admin/configuration/troubleshooting-ssl-errors.md index f84c128894..dfb33ad5d2 100644 --- a/content/admin/configuration/troubleshooting-ssl-errors.md +++ b/content/admin/configuration/troubleshooting-ssl-errors.md @@ -8,8 +8,14 @@ redirect_from: - /enterprise/admin/configuration/troubleshooting-ssl-errors versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Errors + - Infrastructure + - Networking + - Security + - Troubleshooting --- ### Removing the passphrase from your key file diff --git a/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md b/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md index b4240898d2..7f7281ca5e 100644 --- a/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md +++ b/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md @@ -7,8 +7,12 @@ redirect_from: - /enterprise/admin/configuration/using-github-enterprise-server-with-a-load-balancer versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - High availability + - Infrastructure + - Networking --- {% data reusables.enterprise_clustering.load_balancer_intro %} diff --git a/content/admin/configuration/validating-your-domain-settings.md b/content/admin/configuration/validating-your-domain-settings.md index 5dbd867c09..98cd9abb0b 100644 --- a/content/admin/configuration/validating-your-domain-settings.md +++ b/content/admin/configuration/validating-your-domain-settings.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/configuration/validating-your-domain-settings versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Networking --- {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} diff --git a/content/admin/enterprise-management/about-cluster-nodes.md b/content/admin/enterprise-management/about-cluster-nodes.md index 4cab8bcf2f..3ab27e7df7 100644 --- a/content/admin/enterprise-management/about-cluster-nodes.md +++ b/content/admin/enterprise-management/about-cluster-nodes.md @@ -6,7 +6,9 @@ redirect_from: - /enterprise/admin/enterprise-management/about-cluster-nodes versions: enterprise-server: '*' +type: overview topics: + - Clustering - Enterprise --- diff --git a/content/admin/enterprise-management/about-clustering.md b/content/admin/enterprise-management/about-clustering.md index 6e92726533..b586ce8fb6 100644 --- a/content/admin/enterprise-management/about-clustering.md +++ b/content/admin/enterprise-management/about-clustering.md @@ -8,7 +8,9 @@ redirect_from: - /enterprise/admin/enterprise-management/about-clustering versions: enterprise-server: '*' +type: overview topics: + - Clustering - Enterprise --- diff --git a/content/admin/enterprise-management/about-geo-replication.md b/content/admin/enterprise-management/about-geo-replication.md index c369b08a5f..f8d15e861e 100644 --- a/content/admin/enterprise-management/about-geo-replication.md +++ b/content/admin/enterprise-management/about-geo-replication.md @@ -6,8 +6,10 @@ redirect_from: - /enterprise/admin/enterprise-management/about-geo-replication versions: enterprise-server: '*' +type: overview topics: - Enterprise + - High availability --- Multiple active replicas can provide a shorter distance to the nearest replica. For example, an organization with offices in San Francisco, New York, and London could run the primary appliance in a datacenter near New York and two replicas in datacenters near San Francisco and London. Using geolocation-aware DNS, users can be directed to the closest server available and access repository data faster. Designating the appliance near New York as the primary helps reduce the latency between the hosts, compared to the appliance near San Francisco being the primary which has a higher latency to London. diff --git a/content/admin/enterprise-management/about-high-availability-configuration.md b/content/admin/enterprise-management/about-high-availability-configuration.md index 5c0c8a6c1e..f3929bcdc0 100644 --- a/content/admin/enterprise-management/about-high-availability-configuration.md +++ b/content/admin/enterprise-management/about-high-availability-configuration.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/enterprise-management/about-high-availability-configuration versions: enterprise-server: '*' +type: overview topics: - Enterprise + - High availability + - Infrastructure --- When you configure high availability, there is an automated setup of one-way, asynchronous replication of all datastores (Git repositories, MySQL, Redis, and Elasticsearch) from the primary to the replica appliance. diff --git a/content/admin/enterprise-management/accessing-the-monitor-dashboard.md b/content/admin/enterprise-management/accessing-the-monitor-dashboard.md index 6a5a156dd6..8cbfc42a0c 100644 --- a/content/admin/enterprise-management/accessing-the-monitor-dashboard.md +++ b/content/admin/enterprise-management/accessing-the-monitor-dashboard.md @@ -6,8 +6,13 @@ redirect_from: - /enterprise/admin/enterprise-management/accessing-the-monitor-dashboard versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Monitoring + - Performance --- ### Accessing the monitor dashboard diff --git a/content/admin/enterprise-management/cluster-network-configuration.md b/content/admin/enterprise-management/cluster-network-configuration.md index 07f5f04537..f7784d282b 100644 --- a/content/admin/enterprise-management/cluster-network-configuration.md +++ b/content/admin/enterprise-management/cluster-network-configuration.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/enterprise-management/cluster-network-configuration versions: enterprise-server: '*' +type: reference topics: + - Clustering - Enterprise + - Infrastructure + - Networking --- ### Network considerations diff --git a/content/admin/enterprise-management/configuring-collectd.md b/content/admin/enterprise-management/configuring-collectd.md index dc428d24ca..8ec89ce584 100644 --- a/content/admin/enterprise-management/configuring-collectd.md +++ b/content/admin/enterprise-management/configuring-collectd.md @@ -7,8 +7,13 @@ redirect_from: - /enterprise/admin/enterprise-management/configuring-collectd versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Infrastructure + - Monitoring + - Performance --- ### Set up an external `collectd` server diff --git a/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md b/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md index 0d7150e067..e810ec7820 100644 --- a/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md +++ b/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster versions: enterprise-server: '>2.21' +type: how_to topics: + - Clustering - Enterprise + - High availability + - Infrastructure --- ### About high availability replication for clusters diff --git a/content/admin/enterprise-management/creating-a-high-availability-replica.md b/content/admin/enterprise-management/creating-a-high-availability-replica.md index f34f2c58f8..c5389a1283 100644 --- a/content/admin/enterprise-management/creating-a-high-availability-replica.md +++ b/content/admin/enterprise-management/creating-a-high-availability-replica.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/enterprise-management/creating-a-high-availability-replica versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - High availability + - Infrastructure --- {% data reusables.enterprise_installation.replica-limit %} diff --git a/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md b/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md index 93288e899c..d0e484e871 100644 --- a/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md +++ b/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/enterprise-management/differences-between-clustering-and-high-availability-ha versions: enterprise-server: '*' +type: reference topics: + - Clustering - Enterprise + - High availability + - Infrastructure --- ### Failure scenarios diff --git a/content/admin/enterprise-management/enabling-automatic-update-checks.md b/content/admin/enterprise-management/enabling-automatic-update-checks.md index 5f74292ea1..23d47c743d 100644 --- a/content/admin/enterprise-management/enabling-automatic-update-checks.md +++ b/content/admin/enterprise-management/enabling-automatic-update-checks.md @@ -6,8 +6,10 @@ redirect_from: - /enterprise/admin/enterprise-management/enabling-automatic-update-checks versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Upgrades --- When an upgrade package is automatically downloaded for {% data variables.product.product_location %}, you'll receive a message letting you know you can upgrade {% data variables.product.prodname_ghe_server %}. Packages download to the `/var/lib/ghe-updates` directory on {% data variables.product.product_location %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server)." diff --git a/content/admin/enterprise-management/evacuating-a-cluster-node.md b/content/admin/enterprise-management/evacuating-a-cluster-node.md index b740c95ae4..81f8691a6c 100644 --- a/content/admin/enterprise-management/evacuating-a-cluster-node.md +++ b/content/admin/enterprise-management/evacuating-a-cluster-node.md @@ -6,7 +6,9 @@ redirect_from: - /enterprise/admin/enterprise-management/evacuating-a-cluster-node versions: enterprise-server: '*' +type: how_to topics: + - Clustering - Enterprise --- diff --git a/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md b/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md index cfef957df5..7632e2b5f0 100644 --- a/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md +++ b/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Infrastructure + - Performance --- {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} diff --git a/content/admin/enterprise-management/increasing-storage-capacity.md b/content/admin/enterprise-management/increasing-storage-capacity.md index b9faa042f9..c5b3f1b139 100644 --- a/content/admin/enterprise-management/increasing-storage-capacity.md +++ b/content/admin/enterprise-management/increasing-storage-capacity.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/enterprise-management/increasing-storage-capacity versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Infrastructure + - Performance + - Storage --- {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} diff --git a/content/admin/enterprise-management/initializing-the-cluster.md b/content/admin/enterprise-management/initializing-the-cluster.md index cfba2f292b..41280283a3 100644 --- a/content/admin/enterprise-management/initializing-the-cluster.md +++ b/content/admin/enterprise-management/initializing-the-cluster.md @@ -6,7 +6,9 @@ redirect_from: - /enterprise/admin/enterprise-management/initializing-the-cluster versions: enterprise-server: '*' +type: how_to topics: + - Clustering - Enterprise --- diff --git a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md index d98c16406c..e54ffa9299 100644 --- a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md +++ b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - High availability + - Infrastructure --- The time required to failover depends on how long it takes to manually promote the replica and redirect traffic. The average time ranges between 2-10 minutes. diff --git a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md index d68a8ed39e..f4b413e977 100644 --- a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md +++ b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md @@ -5,8 +5,12 @@ redirect_from: - /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster versions: enterprise-server: '>2.21' +type: how_to topics: + - Clustering - Enterprise + - High availability + - Infrastructure --- ### About failover to your replica cluster diff --git a/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md b/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md index 2c272050be..bbfa497259 100644 --- a/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md +++ b/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md @@ -12,8 +12,11 @@ redirect_from: intro: 'To migrate from {% data variables.product.prodname_enterprise %} 11.10.x to 2.1.23, you''ll need to set up a new appliance instance and migrate data from the previous instance.' versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Migration + - Upgrades --- Migrations from {% data variables.product.prodname_enterprise %} 11.10.348 and later are supported. Migrating from {% data variables.product.prodname_enterprise %} 11.10.348 and earlier is not supported. You must first upgrade to 11.10.348 in several upgrades. For more information, see the 11.10.348 upgrading procedure, "[Upgrading to the latest release](/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release/)." diff --git a/content/admin/enterprise-management/monitoring-cluster-nodes.md b/content/admin/enterprise-management/monitoring-cluster-nodes.md index 16786cde14..682a87374d 100644 --- a/content/admin/enterprise-management/monitoring-cluster-nodes.md +++ b/content/admin/enterprise-management/monitoring-cluster-nodes.md @@ -6,8 +6,14 @@ redirect_from: - /enterprise/admin/enterprise-management/monitoring-cluster-nodes versions: enterprise-server: '*' +type: how_to topics: + - Clustering - Enterprise + - Fundamentals + - Infrastructure + - Monitoring + - Performance --- ### Manually checking cluster status diff --git a/content/admin/enterprise-management/monitoring-using-snmp.md b/content/admin/enterprise-management/monitoring-using-snmp.md index 7a77666d47..405cf82c0d 100644 --- a/content/admin/enterprise-management/monitoring-using-snmp.md +++ b/content/admin/enterprise-management/monitoring-using-snmp.md @@ -7,8 +7,12 @@ redirect_from: - /enterprise/admin/enterprise-management/monitoring-using-snmp versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Infrastructure + - Monitoring + - Performance --- SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of {% data variables.product.product_location %} and know when to add more memory, storage, or processor power to the host machine. diff --git a/content/admin/enterprise-management/recommended-alert-thresholds.md b/content/admin/enterprise-management/recommended-alert-thresholds.md index b1c03dea91..7927cfb902 100644 --- a/content/admin/enterprise-management/recommended-alert-thresholds.md +++ b/content/admin/enterprise-management/recommended-alert-thresholds.md @@ -8,8 +8,13 @@ redirect_from: - /enterprise/admin/enterprise-management/recommended-alert-thresholds versions: enterprise-server: '*' +type: reference topics: - Enterprise + - Infrastructure + - Monitoring + - Performance + - Storage --- ### Monitoring storage diff --git a/content/admin/enterprise-management/recovering-a-high-availability-configuration.md b/content/admin/enterprise-management/recovering-a-high-availability-configuration.md index 7e29c1a228..9f756c2b9e 100644 --- a/content/admin/enterprise-management/recovering-a-high-availability-configuration.md +++ b/content/admin/enterprise-management/recovering-a-high-availability-configuration.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/enterprise-management/recovering-a-high-availability-configuration versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - High availability + - Infrastructure --- You can use the former primary appliance as the new replica appliance if the failover was planned or was not related to the health of the appliance. If the failover was related to an issue with the primary appliance, you may prefer to create a new replica appliance. For more information, see "[Creating a high availability replica](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica/)." diff --git a/content/admin/enterprise-management/removing-a-high-availability-replica.md b/content/admin/enterprise-management/removing-a-high-availability-replica.md index 68f5d746a2..c487bda165 100644 --- a/content/admin/enterprise-management/removing-a-high-availability-replica.md +++ b/content/admin/enterprise-management/removing-a-high-availability-replica.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/enterprise-management/removing-a-high-availability-replica versions: enterprise-server: '*' +type: how_to topics: + - Clustering + - High availability - Enterprise + - Infrastructure --- ### Stopping replication temporarily diff --git a/content/admin/enterprise-management/replacing-a-cluster-node.md b/content/admin/enterprise-management/replacing-a-cluster-node.md index d543180faf..749940e87b 100644 --- a/content/admin/enterprise-management/replacing-a-cluster-node.md +++ b/content/admin/enterprise-management/replacing-a-cluster-node.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/enterprise-management/replacing-a-cluster-node versions: enterprise-server: '*' +type: how_to topics: + - Clustering - Enterprise + - Infrastructure --- {% warning %} diff --git a/content/admin/enterprise-management/setting-up-external-monitoring.md b/content/admin/enterprise-management/setting-up-external-monitoring.md index 7862e96eb2..b7d128e601 100644 --- a/content/admin/enterprise-management/setting-up-external-monitoring.md +++ b/content/admin/enterprise-management/setting-up-external-monitoring.md @@ -6,8 +6,12 @@ redirect_from: - /enterprise/admin/enterprise-management/setting-up-external-monitoring versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Infrastructure + - Monitoring + - Performance --- ### About SNMP diff --git a/content/admin/enterprise-management/upgrade-requirements.md b/content/admin/enterprise-management/upgrade-requirements.md index 3615079973..537d07e731 100644 --- a/content/admin/enterprise-management/upgrade-requirements.md +++ b/content/admin/enterprise-management/upgrade-requirements.md @@ -7,8 +7,10 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrade-requirements versions: enterprise-server: '*' +type: reference topics: - Enterprise + - Upgrades --- {% note %} @@ -41,4 +43,8 @@ curl -s http://localhost:9201/audit_log/_stats/store | jq ._all.primaries.store. ``` Use the number to estimate the amount of disk space the MySQL audit logs will need. The script also monitors your free disk space while the import is in progress. Monitoring this number is especially useful if your free disk space is close to the amount of disk space necessary for migration. +{% data reusables.enterprise_installation.upgrade-hardware-requirements %} + +### Next steps + After reviewing these recommendations and requirements, you can upgrade {% data variables.product.prodname_ghe_server %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server/)." diff --git a/content/admin/enterprise-management/upgrading-a-cluster.md b/content/admin/enterprise-management/upgrading-a-cluster.md index 8814c61cd2..3af3d82dc0 100644 --- a/content/admin/enterprise-management/upgrading-a-cluster.md +++ b/content/admin/enterprise-management/upgrading-a-cluster.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrading-a-cluster versions: enterprise-server: '*' +type: how_to topics: + - Clustering - Enterprise + - Upgrades --- ### Upgrading with a hotpatch {% data reusables.enterprise_installation.hotpatching-explanation %} The hotpatch installation script installs the hotpatch on every node in the cluster and restarts the services in their proper sequence to avoid downtime. diff --git a/content/admin/enterprise-management/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/upgrading-github-enterprise-server.md index 4f923a7173..927eb62549 100644 --- a/content/admin/enterprise-management/upgrading-github-enterprise-server.md +++ b/content/admin/enterprise-management/upgrading-github-enterprise-server.md @@ -15,8 +15,10 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrading-github-enterprise-server versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Upgrades --- ### Preparing to upgrade @@ -31,31 +33,7 @@ topics: {% endnote %} -{% if currentVersion ver_gt "enterprise-server@2.20" and currentVersion ver_lt "enterprise-server@3.2" %} - -### About minimum requirements for {% data variables.product.prodname_ghe_server %} 3.0 and later - -Before upgrading to {% data variables.product.prodname_ghe_server %} 3.0 or later, review the hardware resources you've provisioned for your instance. {% data variables.product.prodname_ghe_server %} 3.0 introduces new features such as {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %}, and requires more resources than versions 2.22 and earlier. For more information, see the [{% data variables.product.prodname_ghe_server %} 3.0 release notes](/enterprise-server@3.0/admin/release-notes). - -Increased requirements for {% data variables.product.prodname_ghe_server %} 3.0 and later are **bold** in the following table. - -| User licenses | vCPUs | Memory | Attached storage | Root storage | -| :- | -: | -: | -: | -: | -| Trial, demo, or 10 light users | **4**
_Up from 2_ | **32 GB**
_Up from 16 GB_ | **150 GB**
_Up from 100 GB_ | 200 GB | -| 10 to 3,000 | **8**
_Up from 4_ | **48 GB**
_Up from 32 GB_ | **300 GB**
_Up from 250 GB_ | 200 GB | -| 3,000 to 5000 | **12**
_Up from 8_ | 64 GB | 500 GB | 200 GB | -| 5,000 to 8000 | **16**
_Up from 12_ | 96 GB | 750 GB | 200 GB | -| 8,000 to 10,000+ | **20**
_Up from 16_ | **160 GB**
_Up from 128 GB_ | 1000 GB | 200 GB | - -{% if currentVersion ver_gt "enterprise-server@2.21" %} - -For more information about hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)." - -{% endif %} - -{% data reusables.enterprise_installation.about-adjusting-resources %} - -{% endif %} +{% data reusables.enterprise_installation.upgrade-hardware-requirements %} ### Taking a snapshot diff --git a/content/admin/enterprise-support/about-github-enterprise-support.md b/content/admin/enterprise-support/about-github-enterprise-support.md index 2915204b40..502a511cf0 100644 --- a/content/admin/enterprise-support/about-github-enterprise-support.md +++ b/content/admin/enterprise-support/about-github-enterprise-support.md @@ -6,8 +6,10 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: overview topics: - Enterprise + - Support --- {% note %} diff --git a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md index ea0bbe9a9b..e885ef99ae 100644 --- a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md +++ b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md @@ -7,8 +7,10 @@ redirect_from: - /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server versions: enterprise-server: '*' +type: overview topics: - Enterprise + - Support --- {% note %} diff --git a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md index a171645732..b7b429c92b 100644 --- a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md +++ b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md @@ -5,8 +5,10 @@ redirect_from: - /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise versions: enterprise-server: '*' +type: overview topics: - Enterprise + - Support --- {% note %} diff --git a/content/admin/enterprise-support/about-support-for-advanced-security.md b/content/admin/enterprise-support/about-support-for-advanced-security.md index b52763164a..f981d03c0c 100644 --- a/content/admin/enterprise-support/about-support-for-advanced-security.md +++ b/content/admin/enterprise-support/about-support-for-advanced-security.md @@ -5,8 +5,10 @@ redirect_from: - /enterprise/admin/enterprise-support/about-support-for-advanced-security versions: enterprise-server: '*' +type: overview topics: - Enterprise + - Support --- {% note %} diff --git a/content/admin/enterprise-support/preparing-to-submit-a-ticket.md b/content/admin/enterprise-support/preparing-to-submit-a-ticket.md index 9e623b4ae3..93f1ba297d 100644 --- a/content/admin/enterprise-support/preparing-to-submit-a-ticket.md +++ b/content/admin/enterprise-support/preparing-to-submit-a-ticket.md @@ -6,8 +6,10 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Support --- Before submitting a ticket, you should: diff --git a/content/admin/enterprise-support/providing-data-to-github-support.md b/content/admin/enterprise-support/providing-data-to-github-support.md index 5b9c0bd9fc..7e7f10a20e 100644 --- a/content/admin/enterprise-support/providing-data-to-github-support.md +++ b/content/admin/enterprise-support/providing-data-to-github-support.md @@ -8,8 +8,10 @@ redirect_from: - /enterprise/admin/enterprise-support/providing-data-to-github-support versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Support --- ### Creating and sharing diagnostic files diff --git a/content/admin/enterprise-support/reaching-github-support.md b/content/admin/enterprise-support/reaching-github-support.md index b8b9a0d599..ae8c65233c 100644 --- a/content/admin/enterprise-support/reaching-github-support.md +++ b/content/admin/enterprise-support/reaching-github-support.md @@ -6,8 +6,10 @@ redirect_from: - /enterprise/admin/enterprise-support/reaching-github-support versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Support --- ### Using automated ticketing systems diff --git a/content/admin/enterprise-support/submitting-a-ticket.md b/content/admin/enterprise-support/submitting-a-ticket.md index 5431691b84..89e0b30df0 100644 --- a/content/admin/enterprise-support/submitting-a-ticket.md +++ b/content/admin/enterprise-support/submitting-a-ticket.md @@ -6,8 +6,10 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Support --- ### About submitting a ticket diff --git a/content/admin/github-actions/about-using-actions-in-your-enterprise.md b/content/admin/github-actions/about-using-actions-in-your-enterprise.md index 537bd77fff..341f73ba73 100644 --- a/content/admin/github-actions/about-using-actions-in-your-enterprise.md +++ b/content/admin/github-actions/about-using-actions-in-your-enterprise.md @@ -8,7 +8,9 @@ redirect_from: versions: enterprise-server: '>=2.22' github-ae: next +type: overview topics: + - Actions - Enterprise --- diff --git a/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md b/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md index 782191e0e5..9afbe3c827 100644 --- a/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md +++ b/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md @@ -4,8 +4,12 @@ shortTitle: Backing up and restoring intro: '{% data variables.product.prodname_actions %} data on your external storage provider is not included in regular {% data variables.product.prodname_ghe_server %} backups, and must be backed up separately.' versions: enterprise-server: '>=3.0' +type: how_to topics: + - Actions + - Backups - Enterprise + - Infrastructure --- {% data reusables.actions.enterprise-storage-ha-backups %} diff --git a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md index 9a807ec915..536e5997a2 100644 --- a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md +++ b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md @@ -7,8 +7,11 @@ redirect_from: versions: enterprise-server: '>=2.22' github-ae: next +type: how_to topics: + - Actions - Enterprise + - GitHub Connect --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md index 9a35874248..48959da8e5 100644 --- a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md +++ b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md @@ -6,8 +6,11 @@ redirect_from: versions: enterprise-server: '>=2.22' github-ae: '*' +type: how_to topics: + - Actions - Enterprise + - Policies --- {% data reusables.actions.ae-beta %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md b/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md index 4ce90c5b50..94d4ce307f 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md @@ -1,9 +1,14 @@ --- title: Getting started with GitHub Actions for GitHub AE +shortTitle: Getting started with GitHub Actions intro: 'Learn configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %}.' permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: github-ae: '*' +type: how_to +topics: + - Actions + - Enterprise --- {% data reusables.actions.ae-beta %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md b/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md index 305464bce6..582e9101b8 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md @@ -1,5 +1,6 @@ --- title: Getting started with GitHub Actions for GitHub Enterprise Server +shortTitle: Getting started with GitHub Actions intro: 'Learn about enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} for the first time.' permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' redirect_from: @@ -7,7 +8,9 @@ redirect_from: - /admin/github-actions/enabling-github-actions-and-configuring-storage versions: enterprise-server: '>=2.22' +type: how_to topics: + - Actions - Enterprise --- diff --git a/content/admin/github-actions/high-availability-for-github-actions.md b/content/admin/github-actions/high-availability-for-github-actions.md index a1c649316c..1634f9088d 100644 --- a/content/admin/github-actions/high-availability-for-github-actions.md +++ b/content/admin/github-actions/high-availability-for-github-actions.md @@ -3,8 +3,13 @@ title: High availability for GitHub Actions intro: 'There are some special considerations for administering {% data variables.product.prodname_actions %} in a high availability configuration.' versions: enterprise-server: '>=3.0' +type: reference topics: + - Actions - Enterprise + - High availability + - Infrastructure + - Storage --- ### Replication or redundancy of your {% data variables.product.prodname_actions %} data diff --git a/content/admin/github-actions/using-a-staging-environment.md b/content/admin/github-actions/using-a-staging-environment.md index 288831a701..a14efbc226 100644 --- a/content/admin/github-actions/using-a-staging-environment.md +++ b/content/admin/github-actions/using-a-staging-environment.md @@ -3,8 +3,12 @@ title: Using a staging environment intro: 'Learn about using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_ghe_server %} staging environments.' versions: enterprise-server: '>=3.0' +type: how_to topics: + - Actions - Enterprise + - Infrastructure + - Upgrades --- It can be useful to have a staging or testing environment for {% data variables.product.product_location %}, so that you can test updates or new features before implementing them in your production environment. diff --git a/content/admin/guides.md b/content/admin/guides.md new file mode 100644 index 0000000000..493683ce3f --- /dev/null +++ b/content/admin/guides.md @@ -0,0 +1,104 @@ +--- +title: GitHub Enterprise guides +shortTitle: Guides +intro: 'Learn how to increase developer productivity and code quality with {% data variables.product.product_name %}.' +allowTitleToDifferFromFilename: true +layout: product-sublanding +versions: + enterprise-server: '*' + github-ae: '*' +learningTracks: + - '{% if currentVersion == "github-ae@latest" %}get_started_with_github_ae{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}deploy_an_instance{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}upgrade_your_instance{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}increase_fault_tolerance{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}improve_security_of_your_instance{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %}configure_github_actions{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %}configure_github_advanced_security{% endif %}' +includeGuides: + - /admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider + - /admin/authentication/changing-authentication-methods + - /admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad + - /admin/authentication/configuring-saml-single-sign-on-for-your-enterprise + - /admin/authentication/configuring-user-provisioning-for-your-enterprise + - /admin/authentication/using-cas + - /admin/authentication/using-ldap + - /admin/authentication/using-saml + - /admin/configuration/accessing-the-administrative-shell-ssh + - /admin/configuration/accessing-the-management-console + - /admin/configuration/configuring-a-hostname + - /admin/configuration/configuring-backups-on-your-appliance + - /admin/configuration/configuring-built-in-firewall-rules + - /admin/configuration/configuring-code-scanning-for-your-appliance + - /admin/configuration/configuring-data-encryption-for-your-enterprise + - /admin/configuration/configuring-dns-nameservers + - /admin/configuration/configuring-rate-limits + - /admin/configuration/configuring-secret-scanning-for-your-appliance + - /admin/configuration/configuring-tls + - /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud + - /admin/configuration/enabling-and-scheduling-maintenance-mode + - /admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud + - /admin/configuration/enabling-private-mode + - /admin/configuration/enabling-subdomain-isolation + - /admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom + - /admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom + - /admin/configuration/initializing-github-ae + - /admin/configuration/managing-github-for-mobile-for-your-enterprise + - /admin/configuration/network-ports + - /admin/configuration/restricting-network-traffic-to-your-enterprise + - /admin/configuration/site-admin-dashboard + - /admin/configuration/troubleshooting-ssl-errors + - /admin/configuration/using-github-enterprise-server-with-a-load-balancer + - /admin/enterprise-management/about-high-availability-configuration + - /admin/enterprise-management/accessing-the-monitor-dashboard + - /admin/enterprise-management/creating-a-high-availability-replica + - /admin/enterprise-management/differences-between-clustering-and-high-availability-ha + - /admin/enterprise-management/enabling-automatic-update-checks + - /admin/enterprise-management/initiating-a-failover-to-your-replica-appliance + - /admin/enterprise-management/recommended-alert-thresholds + - /admin/enterprise-management/setting-up-external-monitoring + - /admin/enterprise-management/upgrade-requirements + - /admin/enterprise-management/upgrading-github-enterprise-server + - /admin/enterprise-support/about-github-enterprise-support + - /admin/github-actions/about-using-actions-in-your-enterprise + - /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/enforcing-github-actions-policies-for-your-enterprise + - /admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect + - /admin/github-actions/high-availability-for-github-actions + - /admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled + - /admin/github-actions/using-a-staging-environment + - /admin/overview/about-data-residency + - /admin/overview/about-github-ae + - /admin/overview/about-upgrades-to-new-releases + - /admin/packages/configuring-package-ecosystem-support-for-your-enterprise + - /admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages + - /admin/policies/about-pre-receive-hooks + - /admin/policies/creating-a-pre-receive-hook-environment + - /admin/policies/creating-a-pre-receive-hook-script + - /admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance + - /admin/user-management/about-migrations + - /admin/user-management/audited-actions + - /admin/user-management/adding-people-to-teams + - /admin/user-management/auditing-ssh-keys + - /admin/user-management/auditing-users-across-your-enterprise + - /admin/user-management/configuring-git-large-file-storage-for-your-enterprise + - /admin/user-management/configuring-visibility-for-organization-membership + - /admin/user-management/continuous-integration-using-jenkins + - /admin/user-management/disabling-git-ssh-access-on-your-enterprise + - /admin/user-management/creating-teams + - /admin/user-management/exporting-migration-data-from-githubcom + - /admin/user-management/exporting-migration-data-from-your-enterprise + - /admin/user-management/importing-data-from-third-party-version-control-systems + - /admin/user-management/managing-dormant-users + - /admin/user-management/managing-global-webhooks + - /admin/user-management/managing-projects-using-jira + - /admin/user-management/removing-users-from-teams-and-organizations + - /admin/user-management/migrating-data-to-your-enterprise + - /admin/user-management/migrating-to-internal-repositories + - /admin/user-management/placing-a-legal-hold-on-a-user-or-organization + - /admin/user-management/preparing-to-migrate-data-to-your-enterprise + - /admin/user-management/preventing-users-from-creating-organizations + - /admin/user-management/rebuilding-contributions-data + - /admin/user-management/requiring-two-factor-authentication-for-an-organization + - /admin/user-management/suspending-and-unsuspending-users +--- diff --git a/content/admin/index.md b/content/admin/index.md index db873bbe8b..d1358bcde6 100644 --- a/content/admin/index.md +++ b/content/admin/index.md @@ -1,36 +1,77 @@ --- -title: Enterprise Administrators -redirect_from: - - /enterprise/admin/hidden/migrating-from-github-fi/ - - /enterprise/admin -intro: Documentation and guides for enterprise administrators, system administrators, and security specialists who {% if enterpriseServerVersions contains currentVersion %}deploy, {% endif %}configure{% if enterpriseServerVersions contains currentVersion %},{% endif %} and manage {% data variables.product.product_name %}. +title: GitHub Enterprise Documentation +shortTitle: GitHub Enterprise +intro: 'Documentation and guides for enterprise administrators, system administrators, and security specialists who {% if enterpriseServerVersions contains currentVersion %}deploy, {% endif %}configure{% if enterpriseServerVersions contains currentVersion %},{% endif %} and manage {% data variables.product.product_name %}.' +introLinks: + overview: '{% if enterpriseServerVersions contains currentVersion %}/admin/overview/system-overview{% elsif currentVersion == "github-ae@latest" %}/admin/overview/about-github-ae{% endif %}' +changelog: + label: 'enterprise' +featuredLinks: + guides: + + # Most of this versioning does not have a practical effect, and is just to + # explicitly show writers which article appears for which product. + + - '{% if currentVersion == "github-ae@latest" %}/admin/overview/managing-billing-for-your-enterprise{% endif %}' + - '{% if currentVersion == "github-ae@latest" %}/admin/user-management/auditing-users-across-your-enterprise{% endif %}' + - '{% if currentVersion == "github-ae@latest" %}/admin/configuration/restricting-network-traffic-to-your-enterprise{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}/admin/configuration/configuring-backups-on-your-appliance{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}/admin/enterprise-management/creating-a-high-availability-replica{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}/admin/enterprise-management/upgrading-github-enterprise-server{% endif %}' + + guideCards: + + # GitHub Enterprise Server + + - '{% if currentVersion ver_gt "enterprise-server@2.22" %} + /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server + {% elsif currentVersion ver_lt "enterprise-server@3.0" %} + /admin/enterprise-management/upgrading-github-enterprise-server + {% endif %}' + - '{% if currentVersion ver_gt "enterprise-server@2.22" %} + /admin/packages/getting-started-with-github-packages-for-your-enterprise + {% elsif currentVersion ver_lt "enterprise-server@3.0" %} + /admin/user-management/customizing-user-messages-for-your-enterprise + {% endif %}' + - '{% if currentVersion ver_gt "enterprise-server@2.22" %} + /admin/configuration/configuring-advanced-security-features + {% elsif currentVersion ver_lt "enterprise-server@3.0" %} + /admin/installation/setting-up-a-staging-instance + {% endif %}' + + # GitHub AE + + - '{% if currentVersion == "github-ae@latest" %}/admin/configuration/initializing-github-ae{% endif %}' + - '{% if currentVersion == "github-ae@latest" %}/admin/user-management/customizing-user-messages-for-your-enterprise{% endif %}' + - '{% if currentVersion == "github-ae@latest" %}/admin/github-actions/getting-started-with-github-actions-for-github-ae{% endif %}' + + popular: + + # Most of this versioning does not have a practical effect, and is just to + # explicitly show writers which article appears for which product. + + - '{% if currentVersion == "github-ae@latest" %}/admin/overview/github-ae-release-notes{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}/admin/installation{% endif %}' + - '{% if currentVersion == "github-ae@latest" %}/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad{% endif %}' + - '{% if currentVersion == "github-ae@latest" %}/admin/overview/about-upgrades-to-new-releases{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}/admin/overview/managing-your-github-enterprise-license{% endif %}' + - '{% if enterpriseServerVersions contains currentVersion %}/admin/configuration/command-line-utilities{% endif %}' + - /admin/enterprise-support/about-github-enterprise-support +layout: product-landing versions: enterprise-server: '*' github-ae: '*' --- -{% link_with_intro /overview %} - -{% link_with_intro /installation %} - -{% link_with_intro /configuration %} - -{% link_with_intro /authentication %} - -{% link_with_intro /user-management %} - -{% link_with_intro /policies %} - -{% link_with_intro /enterprise-management %} - -{% link_with_intro /github-actions %} - -{% link_with_intro /packages %} - -{% link_with_intro /advanced-security %} - -{% link_with_intro /enterprise-support %} - -{% link_with_intro /release-notes %} - -{% link_with_intro /all-releases %} + + + + + + + + + + + diff --git a/content/admin/installation/index.md b/content/admin/installation/index.md index 514ae4464e..74e8ed3453 100644 --- a/content/admin/installation/index.md +++ b/content/admin/installation/index.md @@ -11,8 +11,11 @@ redirect_from: - /enterprise/admin/installation versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Fundamentals + - Set up --- For more information, or to purchase {% data variables.product.prodname_enterprise %}, see [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise). diff --git a/content/admin/installation/setting-up-a-staging-instance.md b/content/admin/installation/setting-up-a-staging-instance.md index 5b184e5fb9..e485328c12 100644 --- a/content/admin/installation/setting-up-a-staging-instance.md +++ b/content/admin/installation/setting-up-a-staging-instance.md @@ -5,8 +5,11 @@ redirect_from: - /enterprise/admin/installation/setting-up-a-staging-instance versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Infrastructure + - Upgrades --- {% tip %} diff --git a/content/admin/overview/about-data-residency.md b/content/admin/overview/about-data-residency.md index a83066177e..08df5703dc 100644 --- a/content/admin/overview/about-data-residency.md +++ b/content/admin/overview/about-data-residency.md @@ -1,8 +1,12 @@ --- title: About data residency -intro: You can choose the geography where {% data variables.product.product_name %} stores all customer data for your enterprise. +intro: 'You can choose the geography where {% data variables.product.product_name %} stores all customer data for your enterprise.' versions: github-ae: '*' +type: overview +topics: + - Enterprise + - Fundamentals --- {% data reusables.github-ae.github-ae-enables-you %} You can choose the geography where you store all the customer data for {% data variables.product.product_location %}, and members of your enterprise can access {% data variables.product.product_name %} from anywhere in the world. diff --git a/content/admin/overview/about-enterprise-accounts.md b/content/admin/overview/about-enterprise-accounts.md index fdaf0e4c8b..68a101ab35 100644 --- a/content/admin/overview/about-enterprise-accounts.md +++ b/content/admin/overview/about-enterprise-accounts.md @@ -7,8 +7,11 @@ redirect_from: versions: enterprise-server: '>=2.20' github-ae: '*' +type: overview topics: + - Accounts - Enterprise + - Fundamentals --- ### About enterprise accounts on {% data variables.product.product_name %} diff --git a/content/admin/overview/about-github-ae.md b/content/admin/overview/about-github-ae.md index e8f9a0e199..7410be1cb7 100644 --- a/content/admin/overview/about-github-ae.md +++ b/content/admin/overview/about-github-ae.md @@ -3,6 +3,10 @@ title: About GitHub AE intro: '{% data variables.product.prodname_ghe_managed %} is a security-enhanced and compliant way to use {% data variables.product.prodname_dotcom %} in the cloud.' versions: github-ae: '*' +type: overview +topics: + - Enterprise + - Fundamentals --- ### About {% data variables.product.prodname_ghe_managed %} diff --git a/content/admin/overview/about-upgrades-to-new-releases.md b/content/admin/overview/about-upgrades-to-new-releases.md index 6fc848ee6f..f36e855192 100644 --- a/content/admin/overview/about-upgrades-to-new-releases.md +++ b/content/admin/overview/about-upgrades-to-new-releases.md @@ -5,8 +5,10 @@ intro: '{% if currentVersion == "github-ae@latest" %}Your {% data variables.prod versions: enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - Enterprise + - Upgrades --- {% data variables.product.product_name %} is constantly improving, with new functionality and bug fixes introduced through major and minor releases. {% if currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_managed %} is a fully managed service, so {% data variables.product.company_short %} completes the upgrade process for your enterprise.{% endif %} diff --git a/content/admin/overview/system-overview.md b/content/admin/overview/system-overview.md index 4745d5d962..29cc19bb87 100644 --- a/content/admin/overview/system-overview.md +++ b/content/admin/overview/system-overview.md @@ -6,8 +6,13 @@ redirect_from: - /enterprise/admin/overview/system-overview versions: enterprise-server: '*' +type: overview topics: - Enterprise + - Fundamentals + - Infrastructure + - Security + - Storage --- ### Storage architecture diff --git a/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md b/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md index 95541c549a..d9237b65b8 100644 --- a/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md +++ b/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md @@ -6,8 +6,10 @@ redirect_from: - /admin/packages/configuring-packages-support-for-your-enterprise versions: enterprise-server: '>=2.22' +type: how_to topics: - Enterprise + - Packages --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md b/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md index 398ccc528c..ca1bd427f3 100644 --- a/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md +++ b/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md @@ -1,13 +1,16 @@ --- title: Getting started with GitHub Packages for your enterprise +shortTitle: Getting started with GitHub Packages intro: 'You can start using {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} by enabling the feature, configuring third-party storage, configuring the ecosystems you want to support, and updating your TLS certificate.' redirect_from: - /enterprise/admin/packages/enabling-github-packages-for-your-enterprise - /admin/packages/enabling-github-packages-for-your-enterprise versions: enterprise-server: '>=2.22' +type: how_to topics: - Enterprise + - Packages --- {% if currentVersion == "enterprise-server@2.22" %} diff --git a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index f62eca5dfa..3b7045c3be 100644 --- a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -3,8 +3,11 @@ title: Quickstart for configuring your MinIO storage bucket for GitHub Packages intro: 'Configure your custom MinIO storage bucket for use with {% data variables.product.prodname_registry %}.' versions: enterprise-server: '>=2.22' +type: quick_start topics: + - Packages - Enterprise + - Storage --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/admin/policies/about-pre-receive-hooks.md b/content/admin/policies/about-pre-receive-hooks.md index 11fda56c85..73ed0a1805 100644 --- a/content/admin/policies/about-pre-receive-hooks.md +++ b/content/admin/policies/about-pre-receive-hooks.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/policies/about-pre-receive-hooks versions: enterprise-server: '*' +type: overview topics: - Enterprise + - Policies + - Pre-receive hooks --- When a push occurs, each script runs in an isolated environment and can perform checks on the content of the push. The scripts will cause the push to be accepted if the exit status is 0, or rejected if the exit status is non-zero. diff --git a/content/admin/policies/creating-a-pre-receive-hook-environment.md b/content/admin/policies/creating-a-pre-receive-hook-environment.md index 7551882c18..66d00662fe 100644 --- a/content/admin/policies/creating-a-pre-receive-hook-environment.md +++ b/content/admin/policies/creating-a-pre-receive-hook-environment.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/policies/creating-a-pre-receive-hook-environment versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Policies + - Pre-receive hooks --- A pre-receive environment for {% data variables.product.prodname_ghe_server %} is a Linux [`chroot`](https://en.wikipedia.org/wiki/Chroot) environment. Because pre-receive hooks execute on every push event, they should be fast and lightweight. The environment needed for such checks will typically be minimal. diff --git a/content/admin/policies/creating-a-pre-receive-hook-script.md b/content/admin/policies/creating-a-pre-receive-hook-script.md index fe82feb726..ab5e383a13 100644 --- a/content/admin/policies/creating-a-pre-receive-hook-script.md +++ b/content/admin/policies/creating-a-pre-receive-hook-script.md @@ -7,8 +7,11 @@ redirect_from: - /enterprise/admin/policies/creating-a-pre-receive-hook-script versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Policies + - Pre-receive hooks --- You can see examples of pre-receive hooks for {% data variables.product.prodname_ghe_server %} in the [`github/platform-samples` repository](https://github.com/github/platform-samples/tree/master/pre-receive-hooks). diff --git a/content/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise.md index 7b9d29efd5..51b539eddb 100644 --- a/content/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise.md @@ -5,6 +5,13 @@ product: '{% data reusables.gated-features.ghas %}' versions: enterprise-server: '>=3.1' github-ae: 'next' +type: how_to +topics: + - Advanced Security + - Code scanning + - Policies + - Secret scanning + - Security --- ### About {% data variables.product.prodname_GH_advanced_security %} diff --git a/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md index 69aaa1aa82..ca6bff221b 100644 --- a/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md @@ -28,8 +28,11 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Policies + - Security --- ### Configuring the default visibility of new repositories in your enterprise diff --git a/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md b/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md index a4656c0085..b54a582e50 100644 --- a/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md +++ b/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md @@ -7,8 +7,11 @@ redirect_from: - /enterprise/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Policies + - Pre-receive hooks --- ### Creating pre-receive hooks diff --git a/content/admin/release-notes.md b/content/admin/release-notes.md index 1af66701b5..7dfc63a71c 100644 --- a/content/admin/release-notes.md +++ b/content/admin/release-notes.md @@ -6,5 +6,6 @@ versions: enterprise-server: '*' topics: - Enterprise + - Upgrades --- diff --git a/content/admin/user-management/about-migrations.md b/content/admin/user-management/about-migrations.md index 53798add6c..24182e2b6c 100644 --- a/content/admin/user-management/about-migrations.md +++ b/content/admin/user-management/about-migrations.md @@ -6,8 +6,10 @@ redirect_from: - /enterprise/admin/user-management/about-migrations versions: enterprise-server: '*' +type: overview topics: - Enterprise + - Migration --- ### Types of migrations diff --git a/content/admin/user-management/adding-people-to-teams.md b/content/admin/user-management/adding-people-to-teams.md index 6ddc24d377..522d39f391 100644 --- a/content/admin/user-management/adding-people-to-teams.md +++ b/content/admin/user-management/adding-people-to-teams.md @@ -8,8 +8,12 @@ redirect_from: intro: 'Once a team has been created, organization admins can add users from {% data variables.product.product_location %} to the team and determine which repositories they have access to.' versions: enterprise-server: '*' +type: how_to topics: + - Access management - Enterprise + - Teams + - User account --- Each team has its own individually defined [access permissions for repositories owned by your organization](/articles/permission-levels-for-an-organization). diff --git a/content/admin/user-management/audit-logging.md b/content/admin/user-management/audit-logging.md index c9d7347644..aaf7b47f33 100644 --- a/content/admin/user-management/audit-logging.md +++ b/content/admin/user-management/audit-logging.md @@ -8,8 +8,12 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: reference topics: + - Auditing - Enterprise + - Logging + - Security --- For a full list, see "[Audited actions](/admin/user-management/audited-actions)." For more information on finding a particular action, see "[Searching the audit log](/admin/user-management/searching-the-audit-log)." diff --git a/content/admin/user-management/audited-actions.md b/content/admin/user-management/audited-actions.md index 8ca050893a..14607fde29 100644 --- a/content/admin/user-management/audited-actions.md +++ b/content/admin/user-management/audited-actions.md @@ -9,8 +9,11 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: reference topics: + - Auditing - Enterprise + - Security --- #### Authentication diff --git a/content/admin/user-management/auditing-ssh-keys.md b/content/admin/user-management/auditing-ssh-keys.md index 9d16668a4c..ca445e5db7 100644 --- a/content/admin/user-management/auditing-ssh-keys.md +++ b/content/admin/user-management/auditing-ssh-keys.md @@ -7,8 +7,12 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: + - Auditing - Enterprise + - Security + - SSH --- Once initiated, the audit disables all existing SSH keys and forces users to approve or reject them before they're able to clone, pull, or push to any repositories. An audit is useful in situations where an employee or contractor leaves the company and you need to ensure that all keys are verified. diff --git a/content/admin/user-management/auditing-users-across-your-enterprise.md b/content/admin/user-management/auditing-users-across-your-enterprise.md index 82ab8744f7..49dda1c2cb 100644 --- a/content/admin/user-management/auditing-users-across-your-enterprise.md +++ b/content/admin/user-management/auditing-users-across-your-enterprise.md @@ -8,8 +8,13 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: + - Auditing - Enterprise + - Organizations + - Security + - User account --- ### Accessing the audit log diff --git a/content/admin/user-management/best-practices-for-user-security.md b/content/admin/user-management/best-practices-for-user-security.md index 85382758ff..e814bc4358 100644 --- a/content/admin/user-management/best-practices-for-user-security.md +++ b/content/admin/user-management/best-practices-for-user-security.md @@ -6,8 +6,11 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: reference topics: - Enterprise + - Security + - User account --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md b/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md index 0388fa0cdb..a6c1a0bbb1 100644 --- a/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md +++ b/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md @@ -15,8 +15,12 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: + - Git - Enterprise + - LFS + - Storage --- ### About {% data variables.large_files.product_name_long %} diff --git a/content/admin/user-management/configuring-visibility-for-organization-membership.md b/content/admin/user-management/configuring-visibility-for-organization-membership.md index 6ddf5a89c0..99fb5dedc4 100644 --- a/content/admin/user-management/configuring-visibility-for-organization-membership.md +++ b/content/admin/user-management/configuring-visibility-for-organization-membership.md @@ -6,8 +6,11 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Organizations + - User account --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/user-management/continuous-integration-using-jenkins.md b/content/admin/user-management/continuous-integration-using-jenkins.md index e7605edb1e..1797bf1854 100644 --- a/content/admin/user-management/continuous-integration-using-jenkins.md +++ b/content/admin/user-management/continuous-integration-using-jenkins.md @@ -6,7 +6,9 @@ redirect_from: - /enterprise/admin/user-management/continuous-integration-using-jenkins versions: enterprise-server: '*' +type: reference topics: + - CI - Enterprise --- diff --git a/content/admin/user-management/creating-teams.md b/content/admin/user-management/creating-teams.md index 8d3680ed23..d45949ba68 100644 --- a/content/admin/user-management/creating-teams.md +++ b/content/admin/user-management/creating-teams.md @@ -5,8 +5,12 @@ redirect_from: - /enterprise/admin/user-management/creating-teams versions: enterprise-server: '*' +type: how_to topics: + - Access management - Enterprise + - Teams + - User account --- Teams are central to many of {% data variables.product.prodname_dotcom %}'s collaborative features, such as team @mentions to notify appropriate parties that you'd like to request their input or attention. For more information, see "[Permission levels for an organization repository](/enterprise/{{ currentVersion }}/user/articles/repository-permission-levels-for-an-organization/)". diff --git a/content/admin/user-management/customizing-user-messages-for-your-enterprise.md b/content/admin/user-management/customizing-user-messages-for-your-enterprise.md index 2024409c1b..f26e1ce8e2 100644 --- a/content/admin/user-management/customizing-user-messages-for-your-enterprise.md +++ b/content/admin/user-management/customizing-user-messages-for-your-enterprise.md @@ -1,5 +1,6 @@ --- title: Customizing user messages for your enterprise +shortTitle: Customizing user messages redirect_from: - /enterprise/admin/user-management/creating-a-custom-sign-in-message/ - /enterprise/admin/user-management/customizing-user-messages-on-your-instance @@ -8,8 +9,10 @@ intro: 'You can create custom messages that users will see on {% data variables. versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Maintenance --- ### About user messages diff --git a/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md b/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md index 9cdf61c170..45f2f39137 100644 --- a/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md +++ b/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md @@ -17,8 +17,12 @@ intro: You can prevent people from using Git over SSH for certain or all reposit versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Policies + - Security + - SSH --- ### Disabling Git SSH access to a specific repository diff --git a/content/admin/user-management/exporting-migration-data-from-githubcom.md b/content/admin/user-management/exporting-migration-data-from-githubcom.md index b1463aa91b..b3c850efce 100644 --- a/content/admin/user-management/exporting-migration-data-from-githubcom.md +++ b/content/admin/user-management/exporting-migration-data-from-githubcom.md @@ -11,8 +11,11 @@ redirect_from: - /enterprise/admin/user-management/exporting-migration-data-from-githubcom versions: enterprise-server: '*' +type: how_to topics: + - API - Enterprise + - Migration --- ### Preparing the source organization on {% data variables.product.prodname_dotcom %} diff --git a/content/admin/user-management/exporting-migration-data-from-your-enterprise.md b/content/admin/user-management/exporting-migration-data-from-your-enterprise.md index aef125ce7d..f0b975c6e6 100644 --- a/content/admin/user-management/exporting-migration-data-from-your-enterprise.md +++ b/content/admin/user-management/exporting-migration-data-from-your-enterprise.md @@ -11,8 +11,11 @@ redirect_from: - /enterprise/admin/user-management/exporting-migration-data-from-your-enterprise versions: enterprise-server: '*' +type: how_to topics: + - API - Enterprise + - Migration --- ### Preparing the {% data variables.product.prodname_ghe_server %} source instance diff --git a/content/admin/user-management/importing-data-from-third-party-version-control-systems.md b/content/admin/user-management/importing-data-from-third-party-version-control-systems.md index eb37793519..c0c9dcc519 100644 --- a/content/admin/user-management/importing-data-from-third-party-version-control-systems.md +++ b/content/admin/user-management/importing-data-from-third-party-version-control-systems.md @@ -6,8 +6,10 @@ redirect_from: - /enterprise/admin/user-management/importing-data-from-third-party-version-control-systems versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Migration --- ### Importing projects from Mercurial diff --git a/content/admin/user-management/log-forwarding.md b/content/admin/user-management/log-forwarding.md index 4036305f43..f6b00cbb7d 100644 --- a/content/admin/user-management/log-forwarding.md +++ b/content/admin/user-management/log-forwarding.md @@ -9,8 +9,12 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: + - Auditing - Enterprise + - Logging + - Security --- Any log collection system that supports syslog-style log streams is supported (e.g., [Logstash](http://logstash.net/) and [Splunk](http://docs.splunk.com/Documentation/Splunk/latest/Data/Monitornetworkports)). diff --git a/content/admin/user-management/managing-dormant-users.md b/content/admin/user-management/managing-dormant-users.md index 9bb568b5c6..e36a6d8ab4 100644 --- a/content/admin/user-management/managing-dormant-users.md +++ b/content/admin/user-management/managing-dormant-users.md @@ -9,8 +9,11 @@ intro: 'A user account is considered to be dormant if it has not been active for versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: + - Accounts - Enterprise + - Licensing --- "Activity" includes, but is not limited to: diff --git a/content/admin/user-management/managing-global-webhooks.md b/content/admin/user-management/managing-global-webhooks.md index 6cd3ef7f2e..1f0537d7f5 100644 --- a/content/admin/user-management/managing-global-webhooks.md +++ b/content/admin/user-management/managing-global-webhooks.md @@ -7,8 +7,10 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Webhooks --- ### About global webhooks diff --git a/content/admin/user-management/managing-projects-using-jira.md b/content/admin/user-management/managing-projects-using-jira.md index cc4a216221..c992dfa998 100644 --- a/content/admin/user-management/managing-projects-using-jira.md +++ b/content/admin/user-management/managing-projects-using-jira.md @@ -9,8 +9,10 @@ redirect_from: - /enterprise/admin/user-management/managing-projects-using-jira versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Project management --- ### Connecting Jira to a {% data variables.product.prodname_enterprise %} organization diff --git a/content/admin/user-management/migrating-data-to-your-enterprise.md b/content/admin/user-management/migrating-data-to-your-enterprise.md index 44d7103177..6cab7cfffc 100644 --- a/content/admin/user-management/migrating-data-to-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-your-enterprise.md @@ -13,8 +13,10 @@ redirect_from: - /enterprise/admin/user-management/migrating-data-to-your-enterprise versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Migration --- ### Applying the imported data on {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/user-management/migrating-to-internal-repositories.md b/content/admin/user-management/migrating-to-internal-repositories.md index 1a28933745..f20402ae2a 100644 --- a/content/admin/user-management/migrating-to-internal-repositories.md +++ b/content/admin/user-management/migrating-to-internal-repositories.md @@ -7,8 +7,12 @@ redirect_from: permissions: Site administrators can migrate to internal repositories. versions: enterprise-server: '>=2.20' +type: how_to topics: - Enterprise + - Privacy + - Repositories + - Security --- ### About internal repositories diff --git a/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md b/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md index 0136977fad..743a6c9053 100644 --- a/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md +++ b/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md @@ -6,8 +6,13 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: + - Accounts + - Auditing - Enterprise + - Organizations + - User account --- Usually, if someone deletes a repository, it will be available on disk for 90 days and can be restored via the site admin dashboard. After 90 days the repository is purged and deleted forever. If you place a legal hold on a user or organization, repositories they own are available for restore indefinitely. diff --git a/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md b/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md index 7289b051c3..f2f58d3743 100644 --- a/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md +++ b/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md @@ -10,8 +10,10 @@ redirect_from: - /enterprise/admin/user-management/preparing-to-migrate-data-to-your-enterprise versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Migration --- ### Preparing the migrated data for import to {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/user-management/preventing-users-from-creating-organizations.md b/content/admin/user-management/preventing-users-from-creating-organizations.md index 936cf90706..c2432cb407 100644 --- a/content/admin/user-management/preventing-users-from-creating-organizations.md +++ b/content/admin/user-management/preventing-users-from-creating-organizations.md @@ -8,8 +8,11 @@ intro: You can prevent users from creating organizations in your enterprise. versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: - Enterprise + - Organizations + - Policies --- {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/admin/user-management/promoting-or-demoting-a-site-administrator.md b/content/admin/user-management/promoting-or-demoting-a-site-administrator.md index 80a5237ce7..25ccc2a803 100644 --- a/content/admin/user-management/promoting-or-demoting-a-site-administrator.md +++ b/content/admin/user-management/promoting-or-demoting-a-site-administrator.md @@ -7,7 +7,11 @@ redirect_from: intro: 'Site administrators can promote any normal user account to a site administrator, as well as demote other site administrators to regular users.' versions: enterprise-server: '*' +type: how_to topics: + - Access management + - Accounts + - User account - Enterprise --- diff --git a/content/admin/user-management/rebuilding-contributions-data.md b/content/admin/user-management/rebuilding-contributions-data.md index 480c282a42..bc5637baaa 100644 --- a/content/admin/user-management/rebuilding-contributions-data.md +++ b/content/admin/user-management/rebuilding-contributions-data.md @@ -6,8 +6,11 @@ redirect_from: - /enterprise/admin/user-management/rebuilding-contributions-data versions: enterprise-server: '*' +type: how_to topics: - Enterprise + - Repositories + - User account --- Whenever a commit is pushed to {% data variables.product.prodname_enterprise %}, it is linked to a user account if they are both associated with the same email address. However, existing commits are *not* retroactively linked when a user registers a new email address or creates a new account. diff --git a/content/admin/user-management/removing-users-from-teams-and-organizations.md b/content/admin/user-management/removing-users-from-teams-and-organizations.md index 1441fb948f..2230bb733e 100644 --- a/content/admin/user-management/removing-users-from-teams-and-organizations.md +++ b/content/admin/user-management/removing-users-from-teams-and-organizations.md @@ -5,8 +5,12 @@ redirect_from: - /enterprise/admin/user-management/removing-users-from-teams-and-organizations versions: enterprise-server: '*' +type: how_to topics: + - Access management + - Accounts - Enterprise + - Teams --- Only owners or team admins can remove organization members. When a user is removed from a team or organization, their issues, pull requests, and comments in the organization's repositories remain intact and are still attributed to the user. diff --git a/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md b/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md index bdee0a4e44..07c68c993c 100644 --- a/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md +++ b/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md @@ -5,8 +5,13 @@ redirect_from: - /enterprise/admin/user-management/requiring-two-factor-authentication-for-an-organization versions: enterprise-server: '*' +type: how_to topics: + - 2fa - Enterprise + - Organizations + - Policies + - Security --- When using LDAP or built-in authentication, two-factor authentication is supported on {% data variables.product.product_location %}. Organization administrators can require members to have two-factor authentication enabled. diff --git a/content/admin/user-management/searching-the-audit-log.md b/content/admin/user-management/searching-the-audit-log.md index 9fc1c3deed..5e1d167faa 100644 --- a/content/admin/user-management/searching-the-audit-log.md +++ b/content/admin/user-management/searching-the-audit-log.md @@ -8,8 +8,11 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: + - Auditing - Enterprise + - Logging --- ### Search query syntax diff --git a/content/admin/user-management/suspending-and-unsuspending-users.md b/content/admin/user-management/suspending-and-unsuspending-users.md index 85484bafb3..2cc7c7e7c5 100644 --- a/content/admin/user-management/suspending-and-unsuspending-users.md +++ b/content/admin/user-management/suspending-and-unsuspending-users.md @@ -10,8 +10,12 @@ redirect_from: intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location %}.' versions: enterprise-server: '*' +type: how_to topics: + - Access management - Enterprise + - Security + - User account --- If employees leave the company, you can suspend their {% data variables.product.prodname_ghe_server %} accounts to open up user licenses in your {% data variables.product.prodname_enterprise %} license while preserving the issues, comments, repositories, gists, and other data they created. Suspended users cannot sign into your instance, nor can they push or pull code. diff --git a/content/admin/user-management/viewing-push-logs.md b/content/admin/user-management/viewing-push-logs.md index d34acb4a32..dad6af6837 100644 --- a/content/admin/user-management/viewing-push-logs.md +++ b/content/admin/user-management/viewing-push-logs.md @@ -8,8 +8,12 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +type: how_to topics: + - Auditing - Enterprise + - Git + - Logging --- Push log entries show: diff --git a/data/allowed-topics.js b/data/allowed-topics.js index 66c13e344f..931d555238 100644 --- a/data/allowed-topics.js +++ b/data/allowed-topics.js @@ -13,50 +13,73 @@ module.exports = [ '2fa', 'Action development', + 'Actions', 'Administrator', + 'Advanced Security', 'Amazon ECS', 'Android', 'Ant', 'Analytics', 'API', + 'Auditing', + 'Authentication', 'Azure App Service', 'Azure Pipelines', + 'Backups', 'CD', 'CI', 'CircleCI', + 'Clustering', 'Contacting sponsors', 'Containers', + 'Code scanning', 'Codespaces', 'Discussions', 'Docker', 'Developer', 'Events', + 'Errors', 'Fundamentals', + 'Git', + 'GitHub Connect', 'GitLab', 'Google Kubernetes Engine', 'Gradle', 'GraphQL', + 'High availability', + 'Infrastructure', 'iOS', 'Java', 'JavaScript', 'Jenkins', + 'Licensing', + 'Logging', 'Maven', 'Migration', + 'Monitoring', + 'Networking', 'Node', 'Open Source', 'Organizations', + 'Packages', 'Packaging', + 'Performance', 'Powershell', + 'Pre-receive hooks', 'Privacy', 'Project management', 'Publishing', 'Python', 'Ruby', + 'Secret scanning', 'Security', 'Sponsors payments', 'Sponsors profile', + 'Storage', + 'Support', 'Swift', 'Travis CI', + 'Upgrades', 'User account', 'Webhooks', 'Workflows', @@ -77,12 +100,15 @@ module.exports = [ 'Issues', 'Jobs', 'Legal', + 'LFS', + 'Maintenance', 'Marketplace', 'Mobile', 'Notifications', 'OAuth Apps', 'Pages', 'Permissions', + 'Policies', 'Policy', 'Profile', 'Profiles', @@ -90,10 +116,13 @@ module.exports = [ 'Pull requests', 'Repositories', 'Security', + 'Support', 'Set up', 'SSH', 'SSO', 'Teams', + 'Troubleshooting', + 'Upgrades', 'Usernames', 'Visual Studio Code', 'Xamarin', diff --git a/data/learning-tracks/admin.yml b/data/learning-tracks/admin.yml new file mode 100644 index 0000000000..66b9c7aadd --- /dev/null +++ b/data/learning-tracks/admin.yml @@ -0,0 +1,77 @@ +get_started_with_github_ae: + title: 'Get started with {% data variables.product.prodname_ghe_managed %}' + description: 'Learn about {% data variables.product.prodname_ghe_managed %} and complete the initial configuration of a new enterprise.' + guides: + - /admin/overview/about-github-ae + - /admin/overview/about-data-residency + - /admin/configuration/initializing-github-ae + - /admin/configuration/restricting-network-traffic-to-your-enterprise + - /admin/github-actions/getting-started-with-github-actions-for-github-ae + +deploy_an_instance: + title: 'Deploy an instance' + description: 'Install {% data variables.product.prodname_ghe_server %} on your platform of choice and configure SAML authentication.' + featured_track: true + guides: + - /admin/overview/system-overview + - /admin/installation + - /admin/configuration/accessing-the-management-console + - /admin/configuration/configuring-a-hostname + - /admin/authentication/using-saml + - /admin/configuration/site-admin-dashboard + +upgrade_your_instance: + title: 'Upgrade your instance' + description: 'Test upgrades in staging, notify users of maintenance, and upgrade your instance for the latest features and security updates.' + guides: + - /admin/enterprise-management/enabling-automatic-update-checks + - /admin/installation/setting-up-a-staging-instance + - /admin/enterprise-management/upgrade-requirements + - /admin/user-management/customizing-user-messages-for-your-enterprise + - /admin/configuration/enabling-and-scheduling-maintenance-mode + - /admin/enterprise-management/upgrading-github-enterprise-server + +increase_fault_tolerance: + title: 'Increase the fault tolerance of your instance' + description: "Back up your developers' code and configure high availability (HA) to ensure the reliability of {% data variables.product.prodname_ghe_server %} in your environment." + guides: + - /admin/configuration/accessing-the-administrative-shell-ssh + - /admin/configuration/configuring-backups-on-your-appliance + - /admin/enterprise-management/about-high-availability-configuration + - /admin/enterprise-management/creating-a-high-availability-replica + - /admin/configuration/using-github-enterprise-server-with-a-load-balancer + +improve_security_of_your_instance: + title: 'Improve the security of your instance' + description: "Review network configuration and security features, and harden the instance running {% data variables.product.prodname_ghe_server %} to protect your enterprise's data." + guides: + - /admin/configuration/enabling-private-mode + - /admin/guides/installation/configuring-tls + - /admin/configuration/troubleshooting-ssl-errors + - /admin/configuration/enabling-subdomain-isolation + - /admin/configuration/accessing-the-administrative-shell-ssh + - /admin/configuration/network-ports + - /admin/configuration/configuring-built-in-firewall-rules + - /admin/user-management/best-practices-for-user-security + - /admin/user-management/promoting-or-demoting-a-site-administrator + +configure_github_actions: + title: 'Configure {% data variables.product.prodname_actions %}' + description: 'Allow your developers to create, automate, customize, and execute powerful software development workflows for {% data variables.product.product_location %} with {% data variables.product.prodname_actions %}.' + guides: + - /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server + - /admin/github-actions/enforcing-github-actions-policies-for-your-enterprise + - /admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect + - /admin/github-actions/high-availability-for-github-actions + - /admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled + - /admin/github-actions/using-a-staging-environment + +configure_github_advanced_security: + title: 'Configure {% data variables.product.prodname_GH_advanced_security %}' + description: "Improve the quality and security of your developers' code with {% data variables.product.prodname_GH_advanced_security %}." + guides: + - /admin/advanced-security/about-licensing-for-github-advanced-security + - /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise + - /admin/advanced-security/configuring-code-scanning-for-your-appliance + - /admin/advanced-security/configuring-secret-scanning-for-your-appliance + - /admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise diff --git a/data/reusables/enterprise_installation/upgrade-hardware-requirements.md b/data/reusables/enterprise_installation/upgrade-hardware-requirements.md new file mode 100644 index 0000000000..5eba1919ae --- /dev/null +++ b/data/reusables/enterprise_installation/upgrade-hardware-requirements.md @@ -0,0 +1,25 @@ +{% if currentVersion ver_gt "enterprise-server@2.20" and currentVersion ver_lt "enterprise-server@3.2" %} + +### About minimum requirements for {% data variables.product.prodname_ghe_server %} 3.0 and later + +Before upgrading to {% data variables.product.prodname_ghe_server %} 3.0 or later, review the hardware resources you've provisioned for your instance. {% data variables.product.prodname_ghe_server %} 3.0 introduces new features such as {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %}, and requires more resources than versions 2.22 and earlier. For more information, see the [{% data variables.product.prodname_ghe_server %} 3.0 release notes](/enterprise-server@3.0/admin/release-notes). + +Increased requirements for {% data variables.product.prodname_ghe_server %} 3.0 and later are **bold** in the following table. + +| User licenses | vCPUs | Memory | Attached storage | Root storage | +| :- | -: | -: | -: | -: | +| Trial, demo, or 10 light users | **4**
_Up from 2_ | **32 GB**
_Up from 16 GB_ | **150 GB**
_Up from 100 GB_ | 200 GB | +| 10 to 3,000 | **8**
_Up from 4_ | **48 GB**
_Up from 32 GB_ | **300 GB**
_Up from 250 GB_ | 200 GB | +| 3,000 to 5000 | **12**
_Up from 8_ | 64 GB | 500 GB | 200 GB | +| 5,000 to 8000 | **16**
_Up from 12_ | 96 GB | 750 GB | 200 GB | +| 8,000 to 10,000+ | **20**
_Up from 16_ | **160 GB**
_Up from 128 GB_ | 1000 GB | 200 GB | + +{% if currentVersion ver_gt "enterprise-server@2.21" %} + +For more information about hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)." + +{% endif %} + +{% data reusables.enterprise_installation.about-adjusting-resources %} + +{% endif %} diff --git a/data/ui.yml b/data/ui.yml index a13f76d4bf..261ade0760 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -145,6 +145,11 @@ product_landing: communities_using_discussions: Communities 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 + explore_release_notes: Explore release notes product_sublanding: start: Start start_path: Start path diff --git a/includes/product-releases.html b/includes/product-releases.html new file mode 100644 index 0000000000..12c6f45a8e --- /dev/null +++ b/includes/product-releases.html @@ -0,0 +1,27 @@ +
+
+

{% data ui.product_landing.supported_releases %}

+ +
+ {% for release in releases %} + {% assign releaseNumber = release.version %} + {% if enterpriseServerReleases.supported contains releaseNumber %} + {% assign releaseVersion = 'enterprise-server@' | append: releaseNumber %} + {% assign latestPatch = release.patches[0] %} + {% assign firstPreviousVersion = 'enterprise-server@' | append: release.firstPreviousRelease %} + {% assign secondPreviousVersion = 'enterprise-server@' | append: release.secondPreviousRelease %} +
+
+

{{ allVersions[releaseVersion].versionTitle }}

+

{% octicon "list-unordered" %} {% data ui.product_landing.release_notes_for %} {{ latestPatch.version }} ({{ latestPatch.date }})

+

{% octicon "arrow-up" %} {% data ui.product_landing.upgrade_from %} {{ release.firstPreviousRelease }} or {{ release.secondPreviousRelease }}

+

{% octicon "file" %} {% data ui.product_landing.browse_all_docs %}

+
+
+ {% endif %} + {% endfor %} +
+ + {% data ui.product_landing.explore_release_notes %} {% octicon "arrow-right" %} +
+
diff --git a/layouts/product-landing.html b/layouts/product-landing.html index 2f41a56d5e..f4a23ee570 100644 --- a/layouts/product-landing.html +++ b/layouts/product-landing.html @@ -126,6 +126,10 @@ {{ renderedPage }} + {% if currentVersion contains 'enterprise-server' and currentProduct == 'admin' %} + {% include product-releases %} + {% endif %} + {% if featuredLinks.guideCards %}
diff --git a/lib/enterprise-server-releases.js b/lib/enterprise-server-releases.js index d7c0ae899e..3c6cbf838e 100644 --- a/lib/enterprise-server-releases.js +++ b/lib/enterprise-server-releases.js @@ -59,6 +59,11 @@ const deprecatedReleasesWithLegacyFormat = deprecated.filter(version => versionS const deprecatedReleasesWithNewFormat = deprecated.filter(version => versionSatisfiesRange(version, '>2.18')) const deprecatedReleasesOnDeveloperSite = deprecated.filter(version => versionSatisfiesRange(version, '<=2.16')) const firstReleaseNote = '2.20' +const firstRestoredAdminGuides = '2.21' + +const findReleaseNumberIndex = (releaseNum) => { return all.findIndex(i => i === releaseNum) } +const getNextReleaseNumber = (releaseNum) => { return all[findReleaseNumberIndex(releaseNum) - 1] } +const getPreviousReleaseNumber = (releaseNum) => { return all[findReleaseNumberIndex(releaseNum) + 1] } module.exports = { next, @@ -78,5 +83,8 @@ module.exports = { deprecatedReleasesWithLegacyFormat, deprecatedReleasesWithNewFormat, deprecatedReleasesOnDeveloperSite, - firstReleaseNote + firstReleaseNote, + firstRestoredAdminGuides, + getNextReleaseNumber, + getPreviousReleaseNumber } diff --git a/lib/redirects/get-old-paths-from-permalink.js b/lib/redirects/get-old-paths-from-permalink.js index d488b5292b..5c3615a9d5 100644 --- a/lib/redirects/get-old-paths-from-permalink.js +++ b/lib/redirects/get-old-paths-from-permalink.js @@ -1,4 +1,4 @@ -const { latest, deprecated, lastReleaseWithLegacyFormat } = require('../enterprise-server-releases') +const { latest, deprecated, lastReleaseWithLegacyFormat, firstRestoredAdminGuides } = require('../enterprise-server-releases') const { getPathWithoutLanguage, getPathWithLanguage, getVersionStringFromPath } = require('../path-utils') const patterns = require('../patterns') const versionSatisfiesRange = require('../version-satisfies-range') @@ -29,11 +29,18 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren .replace(`/${languageCode}/enterprise/${latest}/user/insights`, '/insights')) // create old path /desktop/guides from current path /desktop - // create old path /admin/guides from current path /admin - if (!currentPath.includes('/guides')) { + if (currentPath.includes('/desktop') && !currentPath.includes('/guides')) { oldPaths.add(currentPath - .replace('/desktop', '/desktop/guides') - .replace('/admin', '/admin/guides')) + .replace('/desktop', '/desktop/guides')) + } + + // create old path /admin/guides from current path /admin + if (currentPath.includes('admin') && !currentPath.includes('/guides')) { + // ... but ONLY on versions <2.21 and in deep links on all versions + if (versionSatisfiesRange(currentVersion, `<${firstRestoredAdminGuides}`) || !currentPath.endsWith('/admin')) { + oldPaths.add(currentPath + .replace('/admin', '/admin/guides')) + } } // create old path /user from current path /user/github on 2.16+ only diff --git a/middleware/contextualizers/enterprise-release-notes.js b/middleware/contextualizers/enterprise-release-notes.js index 1a75370f22..94e00e4cbf 100644 --- a/middleware/contextualizers/enterprise-release-notes.js +++ b/middleware/contextualizers/enterprise-release-notes.js @@ -76,7 +76,7 @@ async function renderPatchNotes (patch, ctx) { module.exports = async function enterpriseReleaseNotesContext (req, res, next) { // The `/release-notes` sub-path - if (!req.path.endsWith('/release-notes')) return next() + if (!(req.path.endsWith('/release-notes') || req.path.endsWith('/admin'))) return next() // ignore paths that don't have an enterprise version number if (!patterns.getEnterpriseServerNumber.test(req.path)) return next() @@ -106,7 +106,11 @@ module.exports = async function enterpriseReleaseNotesContext (req, res, next) { const release = req.context.site.data['release-notes'][version.replace(/\./g, '-')] if (!release) return ret const patches = sortPatchKeys(release, version) - return { ...ret, patches } + + const firstPreviousRelease = all[all.findIndex(v => v === version) + 1] + const secondPreviousRelease = all[all.findIndex(v => v === firstPreviousRelease) + 1] + + return { ...ret, patches, firstPreviousRelease, secondPreviousRelease } }) const releaseIndex = supported.findIndex(release => release === requestedVersion) diff --git a/middleware/contextualizers/whats-new-changelog.js b/middleware/contextualizers/whats-new-changelog.js index e17676d923..1248d3699b 100644 --- a/middleware/contextualizers/whats-new-changelog.js +++ b/middleware/contextualizers/whats-new-changelog.js @@ -3,9 +3,14 @@ const { getRssFeed, getChangelogItems } = require('../../lib/changelog') module.exports = async function whatsNewChangelog (req, res, next) { if (!req.context.page) return next() if (!req.context.page.changelog) return next() - req.context.changelogUrl = req.context.page.changelog.label === 'education' - ? 'https://github.blog/category/community/education' - : `https://github.blog/changelog/label/${req.context.page.changelog.label}` + const label = req.context.page.changelog.label + + const labelUrls = { + education: 'https://github.blog/category/community/education', + enterprise: 'https://github.blog/category/enterprise/' + } + + req.context.changelogUrl = labelUrls[label] || `https://github.blog/changelog/label/${label}` const feed = await getRssFeed(req.context.changelogUrl) req.context.whatsNewChangelog = await getChangelogItems(req.context.page.changelog.prefix, feed) diff --git a/package-lock.json b/package-lock.json index 1e13e20619..2038ffd9a1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -18724,7 +18724,7 @@ }, "picomatch": { "version": "2.2.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.3.tgz", + "resolved": "", "integrity": "sha512-KpELjfwcCDUb9PeigTs2mBJzXUPzAuP2oPcA989He8Rte0+YUAjw1JVedDhuTKPkHjSYzMN3npC9luThGYEKdg==" }, "pify": { diff --git a/tests/rendering/header.js b/tests/rendering/header.js index bb11056880..c381ccf311 100644 --- a/tests/rendering/header.js +++ b/tests/rendering/header.js @@ -74,7 +74,7 @@ describe('header', () => { const ghe = $(`#homepages a[href="/en/enterprise-server@${latest}/admin"]`) expect(ghe.length).toBe(1) - expect(ghe.text().trim()).toBe('Enterprise Administrators') + expect(ghe.text().trim()).toBe('GitHub Enterprise') expect(ghe.attr('class').includes('active')).toBe(false) }) diff --git a/tests/rendering/server.js b/tests/rendering/server.js index 249730fba9..d03ac9c728 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -518,8 +518,8 @@ describe('GitHub Enterprise URLs', () => { test('renders the Enterprise Admin category homepage', async () => { const adminPath = `/en/enterprise-server@${enterpriseServerReleases.latest}/admin` const $ = await getDOM(adminPath) - expect($(`article a[href="${adminPath}/installation"]`).length).toBe(1) - expect($.text()).toContain('This guide describes') + expect($(`h3 ~ a[href="${adminPath}/guides"]`).length).toBe(1) + expect($('h2 a[href="#all-docs"]').length).toBe(1) }) test('renders an Enterprise Admin category with correct links', async () => { diff --git a/tests/rendering/sidebar.js b/tests/rendering/sidebar.js index 9157773d73..2e66798a1a 100644 --- a/tests/rendering/sidebar.js +++ b/tests/rendering/sidebar.js @@ -15,7 +15,7 @@ describe('sidebar', () => { test('highlights active product on Enterprise pages', async () => { expect($enterprisePage('.sidebar li.sidebar-product').length).toBe(1) - expect($enterprisePage('.sidebar li.sidebar-product > a').text().trim()).toBe('Enterprise Administrators') + expect($enterprisePage('.sidebar li.sidebar-product > a').text().trim()).toBe('GitHub Enterprise') }) test('highlights active product on GitHub pages', async () => { diff --git a/tests/routing/redirects.js b/tests/routing/redirects.js index 0bb7eb1586..8064dfe669 100644 --- a/tests/routing/redirects.js +++ b/tests/routing/redirects.js @@ -6,6 +6,7 @@ const enterpriseServerReleases = require('../../lib/enterprise-server-releases') const nonEnterpriseDefaultVersion = require('../../lib/non-enterprise-default-version') const Page = require('../../lib/page') const { get } = require('../helpers/supertest') +const versionSatisfiesRange = require('../../lib/version-satisfies-range') describe('redirects', () => { jest.setTimeout(5 * 60 * 1000) @@ -195,11 +196,16 @@ describe('redirects', () => { }) describe('enterprise admin', () => { - const enterpriseAdmin = `/en/enterprise-server@${enterpriseServerReleases.latest}/admin` + // firstRestoredAdminGuides = 2.21 + // lastBeforeRestoredAdminGuides = 2.20 + // (these won't change but it's more convenient to use constants) + const { firstRestoredAdminGuides, getPreviousReleaseNumber, latest } = enterpriseServerReleases + const lastBeforeRestoredAdminGuides = getPreviousReleaseNumber(firstRestoredAdminGuides) + const enterpriseAdmin = `/en/enterprise-server@${latest}/admin` const japaneseEnterpriseAdmin = enterpriseAdmin.replace('/en/', '/ja/') test('no language code redirects to english', async () => { - const res = await get(`/enterprise/${enterpriseServerReleases.latest}/admin`) + const res = await get(`/enterprise/${latest}/admin`) expect(res.statusCode).toBe(301) expect(res.headers.location).toBe(enterpriseAdmin) }) @@ -210,24 +216,39 @@ describe('redirects', () => { expect(res.headers.location).toBe(enterpriseAdmin) }) - test('admin/guides redirects to admin', async () => { - const res = await get(`/en/enterprise/${enterpriseServerReleases.latest}/admin/guides`) + test('admin/guides redirects to admin on <2.21', async () => { + const res = await get(`/en/enterprise-server@${lastBeforeRestoredAdminGuides}/admin/guides`) expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(enterpriseAdmin) + expect(res.headers.location).toBe(enterpriseAdmin.replace(latest, lastBeforeRestoredAdminGuides)) }) - test('no version plus admin/guides redirects to admin on latest version', async () => { - const res = await get('/en/enterprise/admin/guides') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(enterpriseAdmin) + test('admin/guides does not redirect to admin on >=2.21', async () => { + const res = await get(`/en/enterprise-server@${firstRestoredAdminGuides}/admin/guides`) + expect(res.statusCode).toBe(200) }) - test('admin/guides redirects to admin in redirects', async () => { - const res = await get(`/en/enterprise/${enterpriseServerReleases.latest}/admin/guides/installation/upgrading-github-enterprise`) + test('no version plus admin/guides redirects to the right place on latest version', async () => { + const shouldRedirect = versionSatisfiesRange(latest, `<${firstRestoredAdminGuides}`) + const expectedStatusCode = shouldRedirect ? 301 : 200 + const res = await get(`/en/enterprise-server@${latest}/admin/guides`) + expect(res.statusCode).toBe(expectedStatusCode) + }) + + test('admin/guides redirects to admin in deep links on <2.21', async () => { + const res = await get(`/en/enterprise-server@${lastBeforeRestoredAdminGuides}/admin/guides/installation/upgrading-github-enterprise`) expect(res.statusCode).toBe(301) const redirectRes = await get(res.headers.location) expect(redirectRes.statusCode).toBe(200) - const expected = `/en/enterprise-server@${enterpriseServerReleases.latest}/admin/enterprise-management/upgrading-github-enterprise-server` + const expected = `/en/enterprise-server@${lastBeforeRestoredAdminGuides}/admin/enterprise-management/upgrading-github-enterprise-server` + expect(res.headers.location).toBe(expected) + }) + + test('admin/guides still redirects to admin in deep links on >=2.21', async () => { + const res = await get(`/en/enterprise-server@${firstRestoredAdminGuides}/admin/guides/installation/upgrading-github-enterprise`) + expect(res.statusCode).toBe(301) + const redirectRes = await get(res.headers.location) + expect(redirectRes.statusCode).toBe(200) + const expected = `/en/enterprise-server@${firstRestoredAdminGuides}/admin/enterprise-management/upgrading-github-enterprise-server` expect(res.headers.location).toBe(expected) }) @@ -237,10 +258,15 @@ describe('redirects', () => { expect(res.headers.location).toBe(japaneseEnterpriseAdmin) }) - test('admin/guides redirects to admin (japanese)', async () => { - const res = await get(`/ja/enterprise/${enterpriseServerReleases.latest}/admin/guides`) + test('admin/guides redirects to admin on <2.21 (japanese)', async () => { + const res = await get(`/ja/enterprise-server@${lastBeforeRestoredAdminGuides}/admin/guides`) expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(japaneseEnterpriseAdmin) + expect(res.headers.location).toBe(japaneseEnterpriseAdmin.replace(latest, lastBeforeRestoredAdminGuides)) + }) + + test('admin/guides does not redirect to admin on >=2.21 (japanese)', async () => { + const res = await get(`/ja/enterprise-server@${firstRestoredAdminGuides}/admin/guides`) + expect(res.statusCode).toBe(200) }) }) diff --git a/tests/unit/products.js b/tests/unit/products.js index ad7b51eb98..a84f3c2ebc 100644 --- a/tests/unit/products.js +++ b/tests/unit/products.js @@ -27,7 +27,7 @@ describe('mobile-only products nav', () => { expect((await getDOM('/github'))('#current-product').text().trim()).toBe('GitHub.com') // Enterprise server - expect((await getDOM('/en/enterprise/admin'))('#current-product').text().trim()).toBe('Enterprise Administrators') + expect((await getDOM('/en/enterprise/admin'))('#current-product').text().trim()).toBe('GitHub Enterprise') expect((await getDOM('/en/enterprise/user/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address'))('#current-product').text().trim()).toBe('GitHub.com') expect((await getDOM('/desktop'))('#current-product').text().trim()).toBe('GitHub Desktop')