Skip to content

Commit fbc8361

Browse files
Make GitHub Pages content a top-level doc set (#18480)
* Add new product to products.yml * Move directory to new location * Update new index page * Remove old category from github product index * Add getting started category * Add Jekyll category * Create custom domain category * Update links to custom domain articles * Add redirects and update links for getting started articles * Add redirects and update links for jekyll articles * Fix link * Fix link * Fix link * Fix link
1 parent d928580 commit fbc8361

File tree

40 files changed

+127
-110
lines changed

40 files changed

+127
-110
lines changed

.pa11yci

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address",
2525
"http://localhost:4001/en/github/authenticating-to-github/configuring-two-factor-authentication",
2626
"http://localhost:4001/en/rest",
27-
"http://localhost:4001/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site",
27+
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site",
2828
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests",
2929
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address",
3030
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile",
@@ -36,17 +36,17 @@
3636
"http://localhost:4001/en/github/authenticating-to-github/testing-your-ssh-connection",
3737
"http://localhost:4001/en/github/getting-started-with-github/fork-a-repo",
3838
"http://localhost:4001/en/graphql",
39-
"http://localhost:4001/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site",
39+
"http://localhost:4001/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site",
4040
"http://localhost:4001/en/developers",
4141
"http://localhost:4001/en/github/getting-started-with-github/supported-browsers",
4242
"http://localhost:4001/en/github/managing-your-work-on-github/about-project-boards",
4343
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork",
44-
"http://localhost:4001/en/github/working-with-github-pages/creating-a-github-pages-site",
44+
"http://localhost:4001/en/pages/getting-started-with-github-pages/creating-a-github-pages-site",
4545
"http://localhost:4001/en/github/authenticating-to-github/working-with-ssh-key-passphrases",
4646
"http://localhost:4001/en/github/authenticating-to-github",
4747
"http://localhost:4001/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages",
48-
"http://localhost:4001/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site",
49-
"http://localhost:4001/en/github/working-with-github-pages/about-github-pages",
48+
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site",
49+
"http://localhost:4001/en/pages/getting-started-with-github-pages/about-github-pages",
5050
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile",
5151
"http://localhost:4001/en/actions/getting-started-with-github-actions/about-github-actions",
5252
"http://localhost:4001/en/github/getting-started-with-github",
@@ -75,7 +75,7 @@
7575
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository",
7676
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/changing-your-github-username",
7777
"http://localhost:4001/en/github/getting-started-with-github/create-a-repo",
78-
"http://localhost:4001/en/github/working-with-github-pages/getting-started-with-github-pages",
78+
"http://localhost:4001/en/pages/getting-started-with-github-pages",
7979
"http://localhost:4001/en/github/administering-a-repository/deleting-a-repository",
8080
"http://localhost:4001/en/actions/configuring-and-managing-workflows/using-environment-variables",
8181
"http://localhost:4001/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets",
@@ -86,7 +86,7 @@
8686
"http://localhost:4001/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue",
8787
"http://localhost:4001/en/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates",
8888
"http://localhost:4001/en/github/authenticating-to-github/about-two-factor-authentication",
89-
"http://localhost:4001/en/github/working-with-github-pages/about-custom-domains-and-github-pages",
89+
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages",
9090
"http://localhost:4001/en/github/searching-for-information-on-github/searching-code",
9191
"http://localhost:4001/en/github/getting-started-with-github/configuring-git-to-handle-line-endings",
9292
"http://localhost:4001/en/github/getting-started-with-github/getting-changes-from-a-remote-repository",
@@ -95,7 +95,7 @@
9595
"http://localhost:4001/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository",
9696
"http://localhost:4001/en/github/getting-started-with-github/verifying-your-email-address",
9797
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile/personalizing-your-profile",
98-
"http://localhost:4001/en/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll",
98+
"http://localhost:4001/en/pages/setting-up-a-github-pages-site-with-jekyll",
9999
"http://localhost:4001/en/github/managing-subscriptions-and-notifications-on-github",
100100
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork"
101101
]

content/admin/overview/github-ae-release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ With auto-merge, pull requests can be set to merge automatically when all merge
4848
#### Developer changes
4949

5050
- [Organization owners can now disable publication](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization) of {% data variables.product.prodname_pages %} sites from repositories in the organization. This will not unpublish existing sites.
51-
- Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites).
51+
- Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/pages/getting-started-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites).
5252
- When writing an issue or pull request, the list syntax for bullets, numbers, and tasks will now be autocompleted after you press `return` or `enter`.
5353
- You can now delete a directory in a repository from the repository page. When navigating to a directory, a new kebab button next to the "Add file" button gives the option to delete the directory.
5454
- It’s now easier and faster to [reference issues or pull requests](/github/writing-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests), with search across multiple words after the "#".

content/github/administering-a-repository/renaming-a-repository.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ When you rename a repository, all existing information, with the exception of pr
1717
* Stars
1818
* Followers
1919

20-
For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)."
20+
For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."
2121

2222
In addition to redirecting web traffic, all `git clone`, `git fetch`, or `git push` operations targeting the previous location will continue to function as if made on the new location. However, to reduce confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line:
2323

@@ -29,7 +29,7 @@ For more information, see "[Managing remote repositories](/github/getting-starte
2929

3030
{% if currentVersion == "free-pro-team@latest" %}
3131

32-
If you plan to rename a repository that has a {% data variables.product.prodname_pages %} site, we recommend using a custom domain for your site. This ensures that the site's URL isn't impacted by renaming the repository. For more information, see "[About custom domains and {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/about-custom-domains-and-github-pages)."
32+
If you plan to rename a repository that has a {% data variables.product.prodname_pages %} site, we recommend using a custom domain for your site. This ensures that the site's URL isn't impacted by renaming the repository. For more information, see "[About custom domains and {% data variables.product.prodname_pages %} site](/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)."
3333

3434
{% endif %}
3535

content/github/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ versions:
5757

5858
{% link_in_list /extending-github %}
5959

60-
{% link_in_list /working-with-github-pages %}
6160
{% link_in_list /supporting-the-open-source-community-with-github-sponsors %}
6261
{% link_in_list /finding-talent-with-github-jobs %}
6362
{% link_in_list /working-with-github-support %}

content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ topics:
1818
If your organization uses {% data variables.product.prodname_ghe_cloud %}, you can choose to allow organization members to create publicly published sites, privately published sites, both, or neither. Otherwise, you can choose to allow or disallow public publishing. For more information about access control for {% data variables.product.prodname_pages %} sites, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
1919
{% endif %}
2020

21-
If you disallow publication of {% data variables.product.prodname_pages %} sites, any sites that are already published will remain published. You can manually unpublish the site. For more information, see "[Unpublishing a {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/unpublishing-a-github-pages-site)."
21+
If you disallow publication of {% data variables.product.prodname_pages %} sites, any sites that are already published will remain published. You can manually unpublish the site. For more information, see "[Unpublishing a {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site)."
2222

2323
{% data reusables.profile.access_profile %}
2424
{% data reusables.profile.access_org %}
@@ -32,4 +32,4 @@ If you disallow publication of {% data variables.product.prodname_pages %} sites
3232

3333
### Further reading
3434

35-
- "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)"
35+
- "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)"

content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Commits will appear on your contributions graph if they meet **all** of the foll
2525
- In the repository's default branch
2626
- In the `gh-pages` branch (for repositories with project sites)
2727

28-
For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)."
28+
For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."
2929

3030
In addition, **at least one** of the following must be true:
3131
- You are a collaborator on the repository or are a member of the organization that owns the repository.
@@ -66,7 +66,7 @@ Generic email addresses--such as `[email protected]`--cannot be added to {% da
6666

6767
#### Commit was not made in the default or `gh-pages` branch
6868

69-
Commits are only counted if they are made in the default branch or the `gh-pages` branch (for repositories with project sites). For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)."
69+
Commits are only counted if they are made in the default branch or the `gh-pages` branch (for repositories with project sites). For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."
7070

7171
If your commits are in a non-default or non-`gh-pages` branch and you'd like them to count toward your contributions, you will need to do one of the following:
7272
- [Open a pull request](/articles/creating-a-pull-request) to have your changes merged into the default branch or the `gh-pages` branch.

content/github/working-with-github-pages/getting-started-with-github-pages.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

content/github/working-with-github-pages/index.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

content/github/working-with-github-pages/about-custom-domains-and-github-pages.md renamed to content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ redirect_from:
66
- /articles/about-supported-custom-domains/
77
- /articles/custom-domain-redirects-for-your-github-pages-site/
88
- /articles/about-custom-domains-and-github-pages
9+
- /github/working-with-github-pages/about-custom-domains-and-github-pages
910
product: '{% data reusables.gated-features.pages %}'
1011
versions:
1112
free-pro-team: '*'
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,14 @@ redirect_from:
1010
- /articles/setting-up-a-custom-domain-with-pages/
1111
- /articles/setting-up-a-custom-domain-with-github-pages/
1212
- /articles/configuring-a-custom-domain-for-your-github-pages-site
13+
- /github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site
1314
product: '{% data reusables.gated-features.pages %}'
14-
mapTopic: true
1515
versions:
1616
free-pro-team: '*'
1717
topics:
1818
- pages
1919
---
2020

21+
{% link_in_list /about-custom-domains-and-github-pages %}
22+
{% link_in_list /managing-a-custom-domain-for-your-github-pages-site %}
23+
{% link_in_list /troubleshooting-custom-domains-and-github-pages %}

content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md renamed to content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ redirect_from:
1010
- /articles/adding-a-cname-file-to-your-repository/
1111
- /articles/setting-up-your-pages-site-repository/
1212
- /articles/managing-a-custom-domain-for-your-github-pages-site
13+
- /github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site
1314
product: '{% data reusables.gated-features.pages %}'
1415
versions:
1516
free-pro-team: '*'

content/github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages.md renamed to content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ redirect_from:
66
- /articles/custom-domain-isn-t-working/
77
- /articles/troubleshooting-custom-domains/
88
- /articles/troubleshooting-custom-domains-and-github-pages
9+
- /github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages
910
product: '{% data reusables.gated-features.pages %}'
1011
versions:
1112
free-pro-team: '*'

content/github/working-with-github-pages/about-github-pages.md renamed to content/pages/getting-started-with-github-pages/about-github-pages.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ redirect_from:
99
- /articles/mime-types-on-github-pages/
1010
- /articles/should-i-rename-usernamegithubcom-repositories-to-usernamegithubio/
1111
- /articles/about-github-pages
12+
- /github/working-with-github-pages/about-github-pages
1213
product: '{% data reusables.gated-features.pages %}'
1314
versions:
1415
free-pro-team: '*'
@@ -27,7 +28,7 @@ You can host your site on {% data variables.product.prodname_dotcom %}'s `github
2728
{% endif %}
2829

2930
{% if currentVersion == "free-pro-team@latest" %}
30-
{% data reusables.pages.about-private-publishing %} For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
31+
{% data reusables.pages.about-private-publishing %} For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
3132
{% endif %}
3233

3334
To get started, see "[Creating a {% data variables.product.prodname_pages %} site](/articles/creating-a-github-pages-site)."
@@ -45,7 +46,7 @@ To publish a user site, you must create a repository owned by your user account
4546
The source files for a project site are stored in the same repository as their project. {% if currentVersion == "free-pro-team@latest" %}Unless you're using a custom domain, project sites are available at `http(s)://<username>.github.io/<repository>` or `http(s)://<organization>.github.io/<repository>`.{% elsif currentVersion == "github-ae@latest" %}Project sites are available at `http(s)://pages.<hostname>/<username>/<repository>/` or `http(s)://pages.<hostname>/<organization>/<repository>/`.{% endif %}
4647

4748
{% if currentVersion == "free-pro-team@latest" %}
48-
If you publish your site privately, the URL for your site will be different. For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
49+
If you publish your site privately, the URL for your site will be different. For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
4950
{% endif %}
5051

5152
{% if currentVersion == "free-pro-team@latest" %}

0 commit comments

Comments
 (0)