Skip to content

repo sync #25290

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
Octomerger merged 3 commits into from
Apr 28, 2023
Merged

repo sync #25290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a3cb9a
Remove hardcoded enterprise article links tests (#36702)
Apr 28, 2023
5f02a71
Path based routing not available for private pages (#36548)
GretaP Apr 28, 2023
9e5aa42
Merge branch 'main' into repo-sync
Octomerger Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ...stom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,13 @@ You can set up either or both of apex and `www` subdomain configurations for you

We recommend always using a `www` subdomain, even if you also use an apex domain. When you create a new site with an apex domain, we automatically attempt to secure the `www` subdomain for use when serving your site's content, but you need to make the DNS changes to use the `www` subdomain. If you configure a `www` subdomain, we automatically attempt to secure the associated apex domain. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)."

After you configure a custom domain for a user or organization site, the custom domain will replace the `<user>.github.io` or `<organization>.github.io` portion of the URL for any project sites owned by the account that do not have a custom domain configured. For example, if the custom domain for your user site is `www.octocat.com`, and you have a project site with no custom domain configured that is published from a repository called `octo-project`, the {% data variables.product.prodname_pages %} site for that repository will be available at `www.octocat.com/octo-project`.
After you configure a custom domain for a user or organization site, the custom domain will replace the `<user>.github.io` or `<organization>.github.io` portion of the URL for any project sites owned by the account that are published publicly and do not have a custom domain configured. For example, if the custom domain for your user site is `www.octocat.com`, and you have a project site with no custom domain configured that is published from a repository called `octo-project`, the {% data variables.product.prodname_pages %} site for that repository will be available at `www.octocat.com/octo-project`.

{% note %}

**Note:** The URLs for project sites that are privately published are not affected by the custom domain for your user or organization site. For more information about privately published sites, see "[AUTOTITLE](/enterprise-cloud@latest/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}

{% endnote %}
For more information about each type of site and handling custom domains, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."

## Using a subdomain for your {% data variables.product.prodname_pages %} site
Expand Down
161 changes: 0 additions & 161 deletions tests/rendering/server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,96 +230,6 @@ describe('server', () => {
})
})

test('displays links to categories on product TOCs', async () => {
const $ = await getDOM('/en/authentication')
expect($('a[href="/en/authentication/keeping-your-account-and-data-secure"]')).toHaveLength(1)
})

describe('English local links', () => {
const latestEnterprisePath = `/en/enterprise-server@${enterpriseServerReleases.latest}`

test('dotcom articles on dotcom have links that include "en"', async () => {
const $ = await getDOM('/en/articles/set-up-git')
expect($('a[href="/en/repositories/working-with-files/managing-files"]').length).toBe(1)
})

// Any links expressed in Markdown as '.../enterprise-server@latest/...'
// should become '.../enterprise-server@<VERSION>/...' when rendered out.
test('enterprise-server@latest links get rewritten to include the latest GHE version', async () => {
const $ = await getDOM(
'/en/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server'
)
expect(
$(`a[href="${latestEnterprisePath}/billing/managing-your-license-for-github-enterprise"]`)
.length
).toBe(1)
})

test('dotcom articles on GHE have Enterprise user links', async () => {
const $ = await getDOM(
`${latestEnterprisePath}/github/getting-started-with-github/set-up-git`
)
expect(
$(`a[href="${latestEnterprisePath}/repositories/working-with-files/managing-files"]`).length
).toBe(1)
})

test('dotcom categories on GHE have Enterprise user links', async () => {
const $ = await getDOM(`${latestEnterprisePath}/get-started/writing-on-github`)
expect(
$(
`ul.list-style-circle li a[href="${latestEnterprisePath}/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github"]`
).length
).toBe(1)
})

test('dotcom-only links on GHE are dotcom-only', async () => {
const $ = await getDOM(
`${latestEnterprisePath}/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud`
)
expect(
$(
'a[href="/en/site-policy/github-terms/github-terms-for-additional-products-and-features#connect"]'
).length
).toBe(1)
})

test('desktop links on GHE are dotcom-only', async () => {
const $ = await getDOM(
`${latestEnterprisePath}/github/getting-started-with-github/set-up-git`
)
expect($('a[href="/en/desktop/installing-and-configuring-github-desktop"]').length).toBe(1)
})

test('admin articles that link to non-admin articles have Enterprise user links', async () => {
const $ = await getDOM(
`${latestEnterprisePath}/admin/installation/configuring-the-default-visibility-of-new-repositories-on-your-appliance`
)
expect(
$(
`a[href="${latestEnterprisePath}/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility"]`
).length
).toBeGreaterThan(0)
})

test('admin articles that link to Enterprise user articles have Enterprise user links', async () => {
const $ = await getDOM(
`${latestEnterprisePath}/admin/user-management/customizing-user-messages-for-your-enterprise`
)
expect($('a[href*="about-writing-and-formatting-on-github"]').length).toBe(1)
})

test('articles that link to external links that contain /articles/ are not rewritten', async () => {
const $ = await getDOM(
`${latestEnterprisePath}/admin/installation/upgrading-github-enterprise-server`
)
expect(
$('a[href="https://docs.microsoft.com/azure/backup/backup-azure-vms-first-look-arm"]')
.length
).toBe(1)
})
})

describeViaActionsOnly('Early Access articles', () => {
test('have noindex meta tags', async () => {
const allPages = await loadPages()
Expand Down Expand Up @@ -354,14 +264,6 @@ describe('server', () => {
expect(res.headers.vary).toContain('x-user-language')
})

test('redirects old articles to their slugified URL', async () => {
const res = await get('/articles/about-github-s-ip-addresses')
expect(res.statusCode).toBe(302)
expect(res.body).toBe(
'Found. Redirecting to /en/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses'
)
})

test('redirects / to /en when no language preference is specified', async () => {
const res = await get('/')
expect(res.statusCode).toBe(302)
Expand Down Expand Up @@ -436,69 +338,6 @@ describe('server', () => {
})
})

describe('GitHub Enterprise URLs', () => {
test('renders the GHE user docs homepage', async () => {
const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/get-started`)
expect(
$(
`a[href="/en/enterprise-server@${enterpriseServerReleases.latest}/get-started/writing-on-github"]`
).length
).toBe(1)
})

test('renders the Enterprise Server homepage with correct links', async () => {
const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}`)
expect(
$(
`section.container-xl a[href="/en/enterprise-server@${enterpriseServerReleases.latest}/admin"]`
).length
).toBe(1)
expect(
$(
`section.container-xl a[href="/en/enterprise-server@${enterpriseServerReleases.latest}/get-started"]`
).length
).toBe(1)
})

test('renders the Enterprise Admin category homepage', async () => {
const adminPath = `/en/enterprise-server@${enterpriseServerReleases.latest}/admin`
const $ = await getDOM(adminPath)
expect($(`h2 ~ 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 () => {
const installationCategoryHome = `/en/enterprise-server@${enterpriseServerReleases.latest}/admin/installation`
const $ = await getDOM(installationCategoryHome)
expect($(`a[href^="${installationCategoryHome}/"]`).length).toBeGreaterThan(1)
})

test('renders an Enterprise Admin category article', async () => {
const $ = await getDOM(
`/en/enterprise/${enterpriseServerReleases.latest}/admin/overview/about-github-enterprise-server`
)
expect($.text()).toContain('platform that you can host in a private environment')
})

test('renders an Enterprise Admin map topic', async () => {
const $ = await getDOM(
`/en/enterprise/${enterpriseServerReleases.latest}/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources`
)
expect(
$(
`a[href^="/en/enterprise-server@${enterpriseServerReleases.latest}/admin/enterprise-management/"]`
).length
).toBeGreaterThan(1)
})

test('renders an Enterprise Admin category article within a map topic', async () => {
const $ = await getDOM(
`/en/enterprise/${enterpriseServerReleases.latest}/admin/installation/upgrade-requirements`
)
expect($.text()).toContain('Before upgrading GitHub Enterprise')
})
})

describe('static routes', () => {
it('serves content from the /assets directory', async () => {
const res = await get('/assets/images/site/be-social.gif')
Expand Down