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

Rails Pathway: Provide descriptive link text (multiple assignees) #28290

Closed
24 tasks done
MaoShizhong opened this issue Jun 27, 2024 · 73 comments
Closed
24 tasks done

Rails Pathway: Provide descriptive link text (multiple assignees) #28290

MaoShizhong opened this issue Jun 27, 2024 · 73 comments
Labels
Type: Accessibility Involves an accessibility feature or requires accessibility review Type: Epic This issue is a larger, unnamed project with several moving parts

Comments

@MaoShizhong
Copy link
Contributor

MaoShizhong commented Jun 27, 2024

Links in our lessons should be sufficiently descriptive to improve accessibility. As per the layout style guide, link text should both concisely describe its purpose (or where the link will redirect a user), and must not include the words this nor here.

Guidance

  • Comment on this issue to let us know you'd like to get a section assigned to you. You can also ask for a specific one.
  • Please wait until you are assigned by a maintainer before starting to work on this issue to avoid multiple people working on the same lessons.
  • When you have been assigned a section, please refer to the suggested link text changes spreadsheet for instructions on what changes need to be made for your assigned lesson(s).
    • For most of these, you should just be able to copy and paste the suggested text to replace the original text shown in the spreadsheet (which may be more than just the link itself). Any additional steps/clarifications will be noted by the appropriate link(s).
    • You are welcome to use a different wording from a given suggestion if you find a better one. If you do, you must ensure the link text is consistent if there are multiple instances of the same href in the same lesson.
    • Line numbers for the files should be mostly accurate. It's possible that I missed an unrelated PR for a file and some numbers are a little off, but you can always search the file for the relevant text as necessary.
    • You are not required to fix any unrelated, preexisting linting errors such as list styles/indentation. Existing linting errors may cause certain tests to fail when you open a PR. You can ignore this and a maintainer will let you know if further action is required.
  • Make sure to read the general contributing guide as well as the curriculum repo contributing guide before starting your first contribution.
  • Please add the following to your PR in the Issues section: Related to #28290. Since this issue is divided into sections, individual PRs should NOT INCLUDE the closes keyword next to an issue number.

Progress and assignees

Ruby

Databases

Ruby on Rails

@MaoShizhong MaoShizhong added Type: Good First Issue Good for beginner contributors Status: Help Wanted This issue can be assigned to other contributors labels Jun 27, 2024
@SeanAverS
Copy link
Contributor

Hi @MaoShizhong

I am interested on working on this and would like be assigned the Working with External APIS section please 😄

@MaoShizhong
Copy link
Contributor Author

Assigned!

@MaoShizhong MaoShizhong changed the title Rails Pathway: Provide descriptive link text Rails Pathway: Provide descriptive link text (multiple assignees) Jun 28, 2024
@mathdebate09
Copy link
Contributor

mathdebate09 commented Jun 28, 2024

Hey Mao, can you assign me the section on Websockets and Action Cable && Basic Messaging App (actioncable_lesson.md) && Project: Rails Final Project && Conclusion to me?

Edit: I just went through the provided spreadsheet, though I wasn't able to find out any guide for lessons, Websockets and Action Cable, Basic Messaging App and Project: Rails Final Project, incase it's under progress/already done, you can assign me any other topics as well :)

@MaoShizhong
Copy link
Contributor Author

@mathdebate09 They're in the Ruby on Rails sheet. Just checked it and can see them there.
Can you check again and see if they're there?

@mathdebate09
Copy link
Contributor

Ah silly me 😆, I can see them, you can assign it to me

@MaoShizhong
Copy link
Contributor Author

All good - assigned

@SumonGFC
Copy link
Contributor

Can assign me any of the Ruby ones.

@MaoShizhong
Copy link
Contributor Author

@SumonGFC I've assigned you to How This Course Will Work && Installing Ruby && Basic Data Types

@SumonGFC
Copy link
Contributor

@MaoShizhong Noob question: Single commit preferred? or one commit for each lesson?

@MaoShizhong
Copy link
Contributor Author

@MaoShizhong Noob question: Single commit preferred? or one commit for each lesson?

Ultimately, either is fine. Personally, if I was working on this myself, I'd make separate commits for each lesson because that's what feels most intuitive and maintainable to me.

@CJKbarts
Copy link
Contributor

I'm interested in contributing to this. Could you please assign me to any of the ruby sections except the last 2?

@MaoShizhong
Copy link
Contributor Author

@CJKbarts Assigned you Methods

@MaoShizhong MaoShizhong assigned CJKbarts and unassigned mathdebate09 and SumonGFC Jun 29, 2024
@CJKbarts
Copy link
Contributor

Thank you
I'll start working on it today

@SumonGFC
Copy link
Contributor

I can do another one if it is fine for us to do more than one.

@MaoShizhong
Copy link
Contributor Author

I can do another one if it is fine for us to do more than one.

Appreciate the enthusiasm. As with previous similar issues, to encourage wider participation, we're limiting to one per person for now. These changes aren't urgent, so we're not in a rush to get them done as soon as possible.

@MaoShizhong MaoShizhong added Type: Epic This issue is a larger, unnamed project with several moving parts Type: Accessibility Involves an accessibility feature or requires accessibility review labels Jun 29, 2024
@TheSeagullDev
Copy link
Contributor

I'm willing to take a section.

@guskirb
Copy link
Contributor

guskirb commented Jul 18, 2024

I'd like to work on any of them if that's okay

@MaoShizhong
Copy link
Contributor Author

Assigned you to APIs and Building Your Own @guskirb

@yuliana-r
Copy link
Contributor

@MaoShizhong opened a PR for my sections, however it's failing the markdown lint tests - let me know if anything else is needed! Apologies for the delay.

@Victor-M-Giraldo
Copy link
Contributor

I'm also open to working on any of these.

@thatsthat
Copy link
Contributor

Hi, I'd like to contribute if there is any task still available

@ItsTosh
Copy link
Contributor

ItsTosh commented Jul 23, 2024

Hi! I’d like to contribute if possible, I’m fine with any section.

@charu5673
Copy link

Hello! I'd like to contribute, if there's any sections left

@MaoShizhong
Copy link
Contributor Author

@Victor-M-Giraldo assigned you to Project: Kittens API && Project: Flickr API && JS Bundling

@thatsthat assigned you to Turbo && Stimulus && Mailers && Project: Sending Confirmation Emails

@ItsTosh assigned you to Advanced Topics

@charu5673 sorry, just assigned the last lesson group! Do take a look round other issues though, as there might be others that need help and may be suitable for you.

@MaoShizhong MaoShizhong removed Type: Good First Issue Good for beginner contributors Status: Help Wanted This issue can be assigned to other contributors labels Jul 23, 2024
JoshDevHub pushed a commit that referenced this issue Jul 24, 2024
* Rails Pathway: Advanced topic (#28290)

added more descriptive texts for links

* Rails Pathway: Advanced topic - Fix linting (#28290)
@MaoShizhong
Copy link
Contributor Author

Thank you everyone who contributed to this 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Accessibility Involves an accessibility feature or requires accessibility review Type: Epic This issue is a larger, unnamed project with several moving parts
Projects
None yet
Development

No branches or pull requests