Skip to content
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.

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

Pages publishing source visibility #34002

Closed
1 task done
janbrasna opened this issue Jul 17, 2024 · 6 comments · Fixed by #34103
Closed
1 task done

Pages publishing source visibility #34002

janbrasna opened this issue Jul 17, 2024 · 6 comments · Fixed by #34103
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue pages Content related to GitHub Pages SME reviewed An SME has reviewed this issue/PR

Comments

@janbrasna
Copy link
Contributor

janbrasna commented Jul 17, 2024

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#about-publishing-sources

(these are all reusables, so it should be considered in all its occurrences…)

What part(s) of the article would you like to see updated?

Warning

Warning: GitHub Pages sites are publicly available on the internet, even if the repository for the site is private. If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "About repositories."

This is actually slightly outdated, as free private repos can't publish at all, and paid private repos have the choice as noted elsewhere:

Note

Note: Organization owners can restrict the publication of GitHub Pages sites from repositories owned by the organization. For more information, see "Managing the publication of GitHub Pages sites for your organization."

Additional information

More info about the visibility/settings: https://docs.github.com/en/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization

@janbrasna janbrasna added the content This issue or pull request belongs to the Docs Content team label Jul 17, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 17, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review pages Content related to GitHub Pages and removed triage Do not begin working on this issue until triaged by the team labels Jul 17, 2024
@nguyenalex836
Copy link
Contributor

@janbrasna Thanks so much for opening an issue! I'll get this triaged for review ✨

@felicitymay felicitymay added needs SME This proposal needs review from a subject matter expert and removed waiting for review Issue/PR is waiting for a writer's review labels Jul 19, 2024
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@nguyenalex836
Copy link
Contributor

@janbrasna Thank you for your patience while our SME team reviewed! You are correct - that warning is outdated. You, or anyone else, is welcome to submit a PR to remove that warning 💛

@nguyenalex836 nguyenalex836 added help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR and removed needs SME This proposal needs review from a subject matter expert labels Jul 26, 2024
@janbrasna
Copy link
Contributor Author

Just to be sure the options are clear, does this breakdown sound correct?

  • Free can publish only public repos to public pages.
  • Pro can publish both public and private repos only as public pages?
  • Team can publish both public and private repos only as public pages?
  • Enterprise Cloud has (as the only plan?) the option to publish pages with restricted access, so that private repos can be published privately, only for collaborator access.
  • Enterprise Serverno idea here TBH.

So basically, for most of the plans, the warning is rather reasonable, as even private repos would only publish the sites privately. It just sounds it always deploys public sites, while under some GHEC settings the published sites can be private…

@janbrasna
Copy link
Contributor Author

In which case the current reusables are correct, the Managed Users are covered in https://docs.github.com/en/enterprise-cloud@latest/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#about-publishing-sources GHEC version of this.

So in reality the FPT warning just somewhat reads as the private-to-public publishing is a feature of FPT, while for Free it has to be public repo. That was maybe the only bit that puzzled me, otherwise all is stated correctly.

So my only nitpick would be adding a note along the lines of:

"Warning: GitHub Pages sites are publicly available on the internet, even if the repository for the site is private (if your plan or organization allows it)."

(copyedit at will…)

@nguyenalex836
Copy link
Contributor

@janbrasna You are correct regarding the breakdown, and that note you added looks perfect 💛 @gagan-bhullar-tech has submitted a PR to address to update the warning, which I will be merging shortly ✨ thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue pages Content related to GitHub Pages SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants