Make images more useful in GitHub Pages Quickstart #18280

thispsj · 2022-05-27T08:37:03Z

Why:

Closes #18165

What's being changed:

Changes the image while navigating to repo settings.
Adds a quick note about repo visibility and it's effect on GitHub Pages.

Check off the following:

I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
For content changes, I have completed the self-review checklist.

github-actions · 2022-05-27T08:37:25Z

Thanks for submitting a PR to the GitHub Docs project!

In order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, see the documentation.

github-actions · 2022-05-27T08:38:08Z

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source	Preview	Production	What Changed
`pages/quickstart.md`	fpt ghec ghes@ 3.5 3.4 3.3 3.2 ghae	fpt ghec ghes@ 3.5 3.4 3.3 3.2 ghae

Ready for a review !

cmwilson21 · 2022-05-31T14:55:45Z

@thispsj Thanks for opening this PR! I'll get this triaged for review ⚡

ghost

Looks Good!

I've removed this note, as the information is covered in the product callout at the top of the article.

jules-p

Hey @thispsj 👋🏻 thanks so much for opening this pull request, we really appreciate your contribution ✨

I've requested a couple of changes, so feel free to re-request my review once those updates have been made. In the meantime, let me know if you have any questions about the changes I've requested.

jules-p · 2022-07-13T09:16:21Z

content/pages/quickstart.md

@@ -25,7 +25,8 @@ This guide will lead you through creating a user site at `username.github.io`.
 {% data reusables.repositories.create_new %}
 1. Enter `username.github.io` as the repository name. Replace `username` with your {% data variables.product.prodname_dotcom %} username. For example, if your username is `octocat`, the repository name should be `octocat.github.io`.
   ![Repository name field](/assets/images/help/pages/create-repository-name-pages.png)
-{% data reusables.repositories.sidebar-settings %}
+2. Under your repository name, click **{% octicon "gear" aria-label="The gear icon" %} Settings**.


I think it would be worth updating this image across the whole docs site, so let's re-add the content of lines 28 and 29 back into the {% data reusables.repositories.sidebar-settings %} reusable.

jules-p · 2022-07-13T09:20:45Z

content/pages/quickstart.md

@@ -25,7 +25,8 @@ This guide will lead you through creating a user site at `username.github.io`.
 {% data reusables.repositories.create_new %}
 1. Enter `username.github.io` as the repository name. Replace `username` with your {% data variables.product.prodname_dotcom %} username. For example, if your username is `octocat`, the repository name should be `octocat.github.io`.
   ![Repository name field](/assets/images/help/pages/create-repository-name-pages.png)
-{% data reusables.repositories.sidebar-settings %}
+2. Under your repository name, click **{% octicon "gear" aria-label="The gear icon" %} Settings**.
+   ![Repository settings button](/assets/images/help/pages/quickstart-settings-nav.png)


The content of this image definitely makes more sense, and is a valuable update. It looks as though the brightness on your screen may have been turned down when you made the screenshot, and the resulting screenshot could be problematic from an accessibility standpoint. Would you mind creating a new screenshot with the same content, but ensuring that it is as bright as the original screenshot? For reference:

thispsj · 2022-07-13T17:01:57Z

@jules-p I'm working on this and will complete it by tomorrow.

ghost

It looks good so far. Keep up the good work.

thispsj · 2022-07-18T16:46:44Z

@jules-p as per your request I have done the changes and changed the image to have less opacity to increase brightness.

jules-p · 2022-07-25T09:38:54Z

Hi @thispsj, thanks for making those changes ✨ the image background is still a bit too dark. Feel free to use this one 👇🏻 and then we'll be able to get those changes merged 🎉

* Change separation layer from black to white * Make appropriate changes to drop shadow to match github/docs-team style.

thispsj · 2022-07-25T14:06:39Z

@jules-p I made appropriate changes to the image. Please take a look and let me know if its good to go.

jules-p

This looks great! Thanks for your patience with me on this, @thispsj 🚀 ✨

github-actions · 2022-07-27T05:52:29Z

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

TODO

a91753b

github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 27, 2022

thispsj added 4 commits May 29, 2022 10:03

Add new image

74e322a

Update quickstart.md

1f7b5ee

Added note

65372cc

Ready for a review !

Merge branch 'main' into pages-image-fix

4e1ef4f

thispsj marked this pull request as ready for review May 29, 2022 06:04

thispsj and others added 2 commits May 29, 2022 11:45

Fix note

2783a73

Merge branch 'github:main' into pages-image-fix

d8fae97

cmwilson21 added content This issue or pull request belongs to the Docs Content team 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 May 31, 2022

thispsj added 2 commits May 31, 2022 20:35

Merge branch 'main' into pages-image-fix

756479a

Merge branch 'main' into pages-image-fix

26e1d25

ghost reviewed Jun 25, 2022

View reviewed changes

thispsj and others added 2 commits June 26, 2022 07:18

Merge branch 'main' into pages-image-fix

da1d310

Removing note

f3bd00f

I've removed this note, as the information is covered in the product callout at the top of the article.

jules-p requested changes Jul 13, 2022

View reviewed changes

ghost reviewed Jul 13, 2022

View reviewed changes

thispsj added 5 commits July 18, 2022 19:50

Revert to reusable

3fc2419

Remove image for replacement

32cc87d

Add new image

9b8c0d4

Add files via upload

7380259

Merge branch 'main' into pages-image-fix

56cef13

thispsj requested a review from jules-p July 18, 2022 16:46

Merge branch 'main' into pages-image-fix

fcdcd71

thispsj added 2 commits July 25, 2022 19:34

Made appropriate changes

8aaa450

* Change separation layer from black to white * Make appropriate changes to drop shadow to match github/docs-team style.

Merge branch 'main' into pages-image-fix

4f20d75

Merge branch 'main' into pages-image-fix

32ad24b

jules-p approved these changes Jul 27, 2022

View reviewed changes

jules-p enabled auto-merge July 27, 2022 05:48

jules-p merged commit 0b985b1 into github:main Jul 27, 2022

thispsj deleted the pages-image-fix branch July 27, 2022 08:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Make images more useful in GitHub Pages Quickstart #18280

Make images more useful in GitHub Pages Quickstart #18280

Uh oh!

thispsj commented May 27, 2022 •

edited

Loading

Uh oh!

github-actions bot commented May 27, 2022

Uh oh!

github-actions bot commented May 27, 2022 •

edited

Loading

Uh oh!

cmwilson21 commented May 31, 2022

Uh oh!

ghost left a comment

Uh oh!

jules-p left a comment

Uh oh!

jules-p Jul 13, 2022

Uh oh!

jules-p Jul 13, 2022

Uh oh!

thispsj commented Jul 13, 2022

Uh oh!

ghost left a comment

Uh oh!

thispsj commented Jul 18, 2022

Uh oh!

jules-p commented Jul 25, 2022

Uh oh!

thispsj commented Jul 25, 2022

Uh oh!

jules-p left a comment

Uh oh!

github-actions bot commented Jul 27, 2022

Uh oh!

Uh oh!

Make images more useful in GitHub Pages Quickstart #18280

Make images more useful in GitHub Pages Quickstart #18280

Uh oh!

Conversation

thispsj commented May 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why:

What's being changed:

Check off the following:

Uh oh!

github-actions bot commented May 27, 2022

Uh oh!

github-actions bot commented May 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automatically generated comment ℹ️

Content directory changes

Uh oh!

cmwilson21 commented May 31, 2022

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

jules-p left a comment

Choose a reason for hiding this comment

Uh oh!

jules-p Jul 13, 2022

Choose a reason for hiding this comment

Uh oh!

jules-p Jul 13, 2022

Choose a reason for hiding this comment

Uh oh!

thispsj commented Jul 13, 2022

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

thispsj commented Jul 18, 2022

Uh oh!

jules-p commented Jul 25, 2022

Uh oh!

thispsj commented Jul 25, 2022

Uh oh!

jules-p left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jul 27, 2022

Uh oh!

Uh oh!

thispsj commented May 27, 2022 •

edited

Loading

github-actions bot commented May 27, 2022 •

edited

Loading