Skip to content

Commit

Permalink
Make GitHub Pages content a top-level doc set (github#18480)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
emilyistoofunky authored Apr 1, 2021
1 parent d928580 commit fbc8361
Show file tree
Hide file tree
Showing 40 changed files with 127 additions and 110 deletions.
16 changes: 8 additions & 8 deletions .pa11yci
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address",
"http://localhost:4001/en/github/authenticating-to-github/configuring-two-factor-authentication",
"http://localhost:4001/en/rest",
"http://localhost:4001/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site",
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site",
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile",
Expand All @@ -36,17 +36,17 @@
"http://localhost:4001/en/github/authenticating-to-github/testing-your-ssh-connection",
"http://localhost:4001/en/github/getting-started-with-github/fork-a-repo",
"http://localhost:4001/en/graphql",
"http://localhost:4001/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site",
"http://localhost:4001/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site",
"http://localhost:4001/en/developers",
"http://localhost:4001/en/github/getting-started-with-github/supported-browsers",
"http://localhost:4001/en/github/managing-your-work-on-github/about-project-boards",
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork",
"http://localhost:4001/en/github/working-with-github-pages/creating-a-github-pages-site",
"http://localhost:4001/en/pages/getting-started-with-github-pages/creating-a-github-pages-site",
"http://localhost:4001/en/github/authenticating-to-github/working-with-ssh-key-passphrases",
"http://localhost:4001/en/github/authenticating-to-github",
"http://localhost:4001/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages",
"http://localhost:4001/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site",
"http://localhost:4001/en/github/working-with-github-pages/about-github-pages",
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site",
"http://localhost:4001/en/pages/getting-started-with-github-pages/about-github-pages",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile",
"http://localhost:4001/en/actions/getting-started-with-github-actions/about-github-actions",
"http://localhost:4001/en/github/getting-started-with-github",
Expand Down Expand Up @@ -75,7 +75,7 @@
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/changing-your-github-username",
"http://localhost:4001/en/github/getting-started-with-github/create-a-repo",
"http://localhost:4001/en/github/working-with-github-pages/getting-started-with-github-pages",
"http://localhost:4001/en/pages/getting-started-with-github-pages",
"http://localhost:4001/en/github/administering-a-repository/deleting-a-repository",
"http://localhost:4001/en/actions/configuring-and-managing-workflows/using-environment-variables",
"http://localhost:4001/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets",
Expand All @@ -86,7 +86,7 @@
"http://localhost:4001/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue",
"http://localhost:4001/en/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates",
"http://localhost:4001/en/github/authenticating-to-github/about-two-factor-authentication",
"http://localhost:4001/en/github/working-with-github-pages/about-custom-domains-and-github-pages",
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages",
"http://localhost:4001/en/github/searching-for-information-on-github/searching-code",
"http://localhost:4001/en/github/getting-started-with-github/configuring-git-to-handle-line-endings",
"http://localhost:4001/en/github/getting-started-with-github/getting-changes-from-a-remote-repository",
Expand All @@ -95,7 +95,7 @@
"http://localhost:4001/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository",
"http://localhost:4001/en/github/getting-started-with-github/verifying-your-email-address",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile/personalizing-your-profile",
"http://localhost:4001/en/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll",
"http://localhost:4001/en/pages/setting-up-a-github-pages-site-with-jekyll",
"http://localhost:4001/en/github/managing-subscriptions-and-notifications-on-github",
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork"
]
Expand Down
2 changes: 1 addition & 1 deletion content/admin/overview/github-ae-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ With auto-merge, pull requests can be set to merge automatically when all merge
#### Developer changes

- [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.
- 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).
- 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).
- 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`.
- 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.
- 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 "#".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When you rename a repository, all existing information, with the exception of pr
* Stars
* Followers

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)."
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)."

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:

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

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

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)."
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)."

{% endif %}

Expand Down
1 change: 0 additions & 1 deletion content/github/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ versions:

{% link_in_list /extending-github %}

{% link_in_list /working-with-github-pages %}
{% link_in_list /supporting-the-open-source-community-with-github-sponsors %}
{% link_in_list /finding-talent-with-github-jobs %}
{% link_in_list /working-with-github-support %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ topics:
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)."
{% endif %}

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)."
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)."

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

### Further reading

- "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)"
- "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)"
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Commits will appear on your contributions graph if they meet **all** of the foll
- In the repository's default branch
- In the `gh-pages` branch (for repositories with project sites)

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)."
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)."

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

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

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)."
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)."

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:
- [Open a pull request](/articles/creating-a-pull-request) to have your changes merged into the default branch or the `gh-pages` branch.
Expand Down

This file was deleted.

47 changes: 0 additions & 47 deletions content/github/working-with-github-pages/index.md

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /articles/about-supported-custom-domains/
- /articles/custom-domain-redirects-for-your-github-pages-site/
- /articles/about-custom-domains-and-github-pages
- /github/working-with-github-pages/about-custom-domains-and-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ redirect_from:
- /articles/setting-up-a-custom-domain-with-pages/
- /articles/setting-up-a-custom-domain-with-github-pages/
- /articles/configuring-a-custom-domain-for-your-github-pages-site
- /github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site
product: '{% data reusables.gated-features.pages %}'
mapTopic: true
versions:
free-pro-team: '*'
topics:
- pages
---

{% link_in_list /about-custom-domains-and-github-pages %}
{% link_in_list /managing-a-custom-domain-for-your-github-pages-site %}
{% link_in_list /troubleshooting-custom-domains-and-github-pages %}
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ redirect_from:
- /articles/adding-a-cname-file-to-your-repository/
- /articles/setting-up-your-pages-site-repository/
- /articles/managing-a-custom-domain-for-your-github-pages-site
- /github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /articles/custom-domain-isn-t-working/
- /articles/troubleshooting-custom-domains/
- /articles/troubleshooting-custom-domains-and-github-pages
- /github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ redirect_from:
- /articles/mime-types-on-github-pages/
- /articles/should-i-rename-usernamegithubcom-repositories-to-usernamegithubio/
- /articles/about-github-pages
- /github/working-with-github-pages/about-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
Expand All @@ -27,7 +28,7 @@ You can host your site on {% data variables.product.prodname_dotcom %}'s `github
{% endif %}

{% if currentVersion == "free-pro-team@latest" %}
{% 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)."
{% 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)."
{% endif %}

To get started, see "[Creating a {% data variables.product.prodname_pages %} site](/articles/creating-a-github-pages-site)."
Expand All @@ -45,7 +46,7 @@ To publish a user site, you must create a repository owned by your user account
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 %}

{% if currentVersion == "free-pro-team@latest" %}
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)."
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)."
{% endif %}

{% if currentVersion == "free-pro-team@latest" %}
Expand Down
Loading

0 comments on commit fbc8361

Please sign in to comment.