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

Add a couple of inline links to the Reusables and variables section of content-style-guide.md #2732

Closed
hamirmahal opened this issue Jan 9, 2021 · 9 comments · Fixed by #2751
Labels
contributing docs Content related to our contributing docs help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@hamirmahal
Copy link
Contributor

What article on docs.github.com is affected?

This issue actually isn't in relation to an issue with docs.github.com. I'd like to improve the "Reusables and variables" section of contributing/content-style-guide.md by adding a couple of inline links for convenience.

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

I would like to change the final sentence of the section I just mentioned,

For more information, see the data directory in the github/docs repository and the “Product names” section of this document.

so that "data directory" and "Product names" have links to the appropriate sections for faster access.

Additional information

I think this would make it easier for first-time contributors to this repository to find the information they need. I may have a fix for this.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 9, 2021
@chiedo chiedo added triage Do not begin working on this issue until triaged by the team and removed triage Do not begin working on this issue until triaged by the team labels Jan 11, 2021
@janiceilene janiceilene added the contributing docs Content related to our contributing docs label Jan 11, 2021
@chiedo
Copy link
Contributor

chiedo commented Jan 11, 2021

@hamirmahal Thanks for opening an issue! Triaging this now so someone can dig in!

@emilyistoofunky emilyistoofunky added the help wanted Anyone is welcome to open a pull request to fix this issue label Jan 11, 2021
@emilyistoofunky
Copy link
Member

👍🏻 Thanks @hamirmahal! You or anyone else are welcome to open a PR to make this improvement. 🔧

@ramizackaryshamir
Copy link

ramizackaryshamir commented Jan 12, 2021

Hello @emilyistoofunky, @chiedo, and @janiceilene! I made the suggested changes and opened a pull request for this issue. This is only my second time opening a pull request, so please let me know if there's anything I could do better next time. Thanks so much! -Rami

ramizackaryshamir pushed a commit to ramizackaryshamir/docs that referenced this issue Jan 12, 2021
Why:
Line 279: link 'data directory' to data repository and 'Product names' to product names section for faster access. Issue github#2732

What's being changed:
Line 279: Linked 'data directory' to data repository and 'Product names' to product names section.
@chiedo
Copy link
Contributor

chiedo commented Jan 12, 2021

Thank you @MeetYourCreator!

We appreciate you hopping in and opening a pull request for the first time.

It looks like you opened the Pull Request on your fork rather than on this repo. Can you give it another shot but this time open the Pull Request here instead (using your repo as a base)?

More docs on Pull requests if they're helpful!

@ramizackaryshamir
Copy link

Hi @chiedo! Thanks so much for the quick reply. And thank you for being patient and understanding. I think I did it correctly this time. My pull request number is #2828.

Please let me know if I need to make any additional changes. Thanks again @chiedo ! -Rami

@chiedo
Copy link
Contributor

chiedo commented Jan 12, 2021

I responded in the PR!

@ramizackaryshamir
Copy link

Hi @chiedo, Let me start by saying THANK YOU THANK YOU THANK YOU for being so patient and helpful. I looked over the pull request documentation again, and opened up a new pull request #2829. I double-checked to make sure that I was trying to merge to the main branch for gitub-docs and that there were Files showing in the Files tab:

Screen Shot 2021-01-12 at 2 54 58 PM

I really hope I got it right this time. Thank you so much for helping to guide me along :)

@emilyistoofunky
Copy link
Member

Hi @MeetYourCreator! Thanks so much for taking a look at this issue - it looks like the author of this issue opened a PR (#2751) earlier than you did, so we're going to merge that one. We appreciate you getting set up to contribute to this repo and look forward to working with you on future issues. ⚡

@ramizackaryshamir
Copy link

Hi @emilyistoofunky! Thanks so much for letting me know. And thanks again @chiedo for the very helpful guidance :)

janiceilene added a commit that referenced this issue Jan 14, 2021
Add a couple of inline links for convenience to close #2732
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributing docs Content related to our contributing docs help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants