Skip to content

Fix - #27294 content updated#27464

Merged
isaacmbrown merged 3 commits intogithub:mainfrom
Shikha1234:fix/hello-world-commit-changes
Oct 2, 2023
Merged

Fix - #27294 content updated#27464
isaacmbrown merged 3 commits intogithub:mainfrom
Shikha1234:fix/hello-world-commit-changes

Conversation

@Shikha1234
Copy link
Contributor

@Shikha1234 Shikha1234 commented Aug 15, 2023

Issue:
#27294 Making and committing changes is different from the tutorial experience

Steps to Reproduce:

Navigate to the Hello World quickstart tutorial.
Observe the "Commit changes" box instead of the expected "Propose changes" box in the "Making and committing changes" section.
Description:

This pull request addresses the issue with the tutorial where the "Commit changes" box is displayed instead of the expected "Propose changes" box in the "Making and committing changes" section. The issue has been consistently observed across different browsers (Chrome and Safari) and whether logged in to GitHub in the browser or not.

Changes Made:
I have updated the tutorial content to ensure that the correct terminology, "Propose changes," is displayed in the "Making and committing changes" section, aligning it with the expected tutorial experience.

Closes: #27294

Checklist:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Edited the content from "Propose Changes " to "Commit Changes" in "Making and committing changes
" heading

Check off the following:

[Y] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

  • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [Y] For content changes, I have completed the self-review checklist.

@welcome
Copy link

welcome bot commented Aug 15, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 15, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 15, 2023

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
get-started/quickstart/hello-world.md fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae
fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

cmwilson21 commented Aug 15, 2023

@Shikha1234 Thanks for submitting this PR! I've edited your post to link your PR to your issue.

And thanks for the added detail and context around your changes! We really appreciate all the info and it makes it easier for us to review 💖

I'll get this triaged for review! ⚡

@cmwilson21 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 get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels Aug 15, 2023
@Shikha1234
Copy link
Contributor Author

@cmwilson21 Thank you very much for your help :)

@@ -89,8 +89,8 @@ You can make and save changes to the files in your repository. On {% data variab
1. In the editor, write a bit about yourself. Try using different Markdown elements.
{% ifversion code-search-code-view %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Shikha1234, I think we can simplify the versioning here to make it easier for people to see the logic

Can you modify lines 90-97 to the following?

{% ifversion code-search-code-view %}1. Click **Commit changes...**.{% endif %}
1. In the "Commit changes" box, write a commit message that describes your changes.
1. Click **Commit changes**.

Copy link

@callumjohnspiller callumjohnspiller Aug 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it the case that the lines:

1. In the "Propose changes" box, write a commit message that describes your changes.
1. Click **Propose changes**.

were left in erroneously? - I noticed this issue too and glad to see someone was working on a fix! I was struggling to see why there were two instances of the same message in @Shikha1234 's edit!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@callumjohnspiller, that's right, probably we changed the UI text to "Propose changes" at a certain point in the code search feature's development, then changed it back to "Commit changes" later

@cmwilson21
Copy link
Contributor

👋 @Shikha1234 Just checking in! Have you had a chance to review @isaacmbrown's suggested changes?

@Shikha1234
Copy link
Contributor Author

Hi Team, I have updated the changes mentioned in the comments. Please review and Let me know if any modifications required

Copy link
Contributor

@isaacmbrown isaacmbrown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Shikha1234! 🚀

@isaacmbrown isaacmbrown added this pull request to the merge queue Oct 2, 2023
Merged via the queue into github:main with commit e1fad80 Oct 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

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

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 get started Content related to "Getting Started" doc set waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Hello World - conditional content update - Making and committing changes section

4 participants