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

Clearer instructions #4419

Merged
merged 3 commits into from
Apr 1, 2021
Merged

Clearer instructions #4419

merged 3 commits into from
Apr 1, 2021

Conversation

kwinkunks
Copy link
Contributor

Why: I was unclear on how to upload a file and found the instructions oddly worded (the section on creating gists started with 'You can also...', but I wasn't clear on the main idea yet).

I also fixed a missing word in 3rd 'About gists' bullet point.

Closes [issue link]

What's being changed: Added a word, added an intro sentence, and moved a sentence.

Check off the following:

  • [ x ] I have reviewed my changes in staging. (look for the deploy-to-heroku link in your pull request, then click View deployment)
  • [ x ] For content changes, I have reviewed the localization checklist
  • [ x ] For content changes, I have reviewed the Content style guide for GitHub Docs.

I was unclear on how to upload a file and found the instructions oddly worded. Also fixed a missing word in 3rd 'About gists' bullet point.
@welcome
Copy link

welcome bot commented Mar 9, 2021

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.

@janiceilene
Copy link
Contributor

@kwinkunks Thanks so much for opening a PR! I'll get this triaged for review ✨

@janiceilene janiceilene added waiting for review Issue/PR is waiting for a writer's review writing on github labels Mar 16, 2021
@@ -70,7 +70,7 @@ You can also create a gist using the {% data variables.product.prodname_cli %}.
3. Type an optional description and name for your gist.
![Gist name description](/assets/images/help/gist/gist_name_description.png)

4. Type the text of your gist into the gist text box.
4. Type the text of your gist into the gist text box. Alternatively, you can drag and drop a text file from your desktop directly into the editor.
Copy link
Contributor

@saritai saritai Mar 24, 2021

Choose a reason for hiding this comment

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

Please move the sentence about drag and drop to the note above that contains the CLI information. Let us know when you make the change and we will review again!

Copy link
Contributor

Choose a reason for hiding this comment

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

I've gone ahead and made this change! The rest looks good so we will merge!

@saritai saritai removed the waiting for review Issue/PR is waiting for a writer's review label Mar 24, 2021
@saritai saritai dismissed stale reviews from ghost via f098026 April 1, 2021 14:59
@saritai saritai merged commit 075facb into github:main Apr 1, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2021

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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants