Adding correct Github project links

[KhushbuB]

Resolves issue #2104
Correct Link : https://docs.github.com/en/enterprise-server@2.22/github/working-with-github-pages/creating-a-github-pages-site

[waylan]

That link is specifically for GitHub's enterprise server. Shouldn't we be linking to the docs for free pro team?

Note, I have not yet reviewed the content of the linked page and therefore have not confirmed that it is the correct page regardless of which GitHub serve is linked.

[ktomk]

Reported this upstream and it is already fixed with a redirect in place:

$ curl -Ls -o /dev/null -w '%{url_effective}\n' https://help.github.com/articles/creating-project-pages-manually/ 
https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/creating-a-github-pages-site

Fix: github/docs@5536f92
PR: github/docs#1097
Ref: https://github.com/github/docs/discussions/1071

[waylan]

Shouldn't this be changed to https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/creating-a-github-pages-site?

[ktomk]

From the conversation and the change-set upstream, my understanding is that the URI should be changed to:

• https://docs.github.com/github/working-with-github-pages/creating-a-github-pages-site

[waylan]

I took a look at the content of the new page and it is not at all the same content as we linked to before. According to the wayback machine, most recently the link forwarded to Creating Project Pages Using the Command Line, which is nearly identical to the old page from when the link was first created: Creating Project Pages manually.

The content of the old page is not too long. I suspect it would make more sense to simply replicate the instructions from the old page in our own documentation. Of course, we should adapt it to be MkDocs specific and be careful not to just copy the old text.

[ktomk]

Yes, good thinking to use wayback machine for this, didn't check that.

And I'm seeing that on the index it is giving pointers for hosting products (GitHub Pages and Amazon S3), I'd suggest to turn "GitHub project pages" into "GitHub Pages" (wording) as it looks like the correct name to me. It is also in use in Mkdocs docs already: https://www.mkdocs.org/user-guide/deploying-your-docs/#github-pages .

Instead of giving command line instructions about git (e.g. how to create a branch) an alternative that looks good to me is to link
to the product page for GitHub Pages, of which I could gather two:

• "true" product page: https://pages.github.com/
• docs canonical: https://docs.github.com/github/working-with-github-pages/getting-started-with-github-pages

Can't say which of those two would be the better choice for Mkdocs visitors, maybe the one from the docs?

And when doing so, promoting Mkdocs built-in gh-pages command with a link to the "Deploying your Docs" page. So it's not all only to the outside when there is Mkdocs content about GitHub Pages support.

[waylan]

I just realized this link is at the end of the "Getting Started" guide. I thought this was on the deployment docs page. That being the case, yes, a more generic link pointing to the product page (https://pages.github.com/) makes more sense. For details users can follow the link from there to Deploying your Docs.