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

Updated with title attributes and ALT tags #201

Merged
merged 27 commits into from Apr 4, 2023
Merged

Updated with title attributes and ALT tags #201

merged 27 commits into from Apr 4, 2023

Conversation

ghost
Copy link

@ghost ghost commented Mar 23, 2023

Summary

Updated README.md:
Added title attribute tags to profile links
Added title attribute tags to other links
Added ALT image tags where required

Updated CONTRIBUTING.md:
Added title attribute tags to links

Updated CODE_OF_CONDUCT.md:
Added title attribute tags to links

Type of change

  • Updated documentation (updated the readme, templates, or other repo files)

How Has This Been Tested?

  • Checked changes made for spelling
  • Checked links work
  • Checked profile pages still using feature
  • Reported some profiles are not linking back to repository or demo site

Additional Information

I physically checked all profile links to make sure the example profiles were still using this feature. Positively, all profiles still use this feature but some are not linking back to the repository or demo site.

The following are using but not linking back as per the source link code provided:

https://github.com/jcs090218 - Tree Profile Image
https://github.com/yousafesaeed - CRT Monitor Image
https://github.com/HectorSaldes - White Shirt Glasses Image
https://github.com/Maagnitude - Guy Beard Grey Top Image
https://github.com/quiet-node - Smiling Guy Black Jacket Image
https://github.com/wiz64 - White Cat Image
https://github.com/thakurballary - Guy Black Beard & Hair White Top Image
https://github.com/BenjaminMichaelis - Guy Smiling Red Cap
https://github.com/PROxZIMA - Guy Black Hair & Top Glasses
https://github.com/angelofallars - Guy Red Profile Image
https://github.com/tavignesh - Never Settle with Hat Image
https://github.com/Tarun-Kamboj - Black & White Eternal Image
https://github.com/8BitJonny - Dark Face Mask Glasses Image

This is a result of 13/41 meaning on average, 32% or 1/3rd of users do not actively provide a link back to the repository. Seems a shame to use a feature and not really give credit to the developer.

ProfCyberNaught added 6 commits March 23, 2023 21:58
Added title attributes to profile links, additional title attributes to other links, and ALT tag to images that had it missing.
Added title attribute tags to links. Left some out because the layout and content design does not warrant them.
Correction to a profile link
Corrections to profile links
Added title attributes.
Added title attributes and ALT tags where needed.
@ghost
Copy link
Author

ghost commented Mar 23, 2023

Should be able to close Issue #200 when merged.

Copy link
Owner

@DenverCoder1 DenverCoder1 left a comment

Choose a reason for hiding this comment

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

Thanks for working on this, however it seems that most of these instances of added title text are redundant or otherwise intentionally omitted. Note that for SEO purposes, search engines take into account both the link text and the title text and there is no reason to add title text if it just duplicating the link text. Additionally, I prefer to not put title text in the example code since it's not functionally required and may confuse some users. Users may choose to add it on their own if they wish.

To summarize, I am fine with adding alt text to the image on line 7 of the readme, and adding title text to the GitHub profile links, but the other instances don't seem to have much meaningful impact on the content or searchability so I think they should be reverted.

Feel free to let me know what you think.

README.md Outdated Show resolved Hide resolved
CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
DenverCoder1 and others added 21 commits April 4, 2023 12:57
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
Co-authored-by: Jonah Lawrence <[email protected]>
@ghost
Copy link
Author

ghost commented Apr 4, 2023

This is your repository and indeed your choice moving forward. I don't fully agree with your comments regarding title tags as some search engine do use them, some categorisations stored in databases use them to find keywords, and screen readers would certainly look out for them. However, I do accept if the title tag data is duplicating the element data, there would be no point. However, I certainly was not going to start adding more content and replacing your ideal element descriptions without clearing anything with you first 😄 I have accepted your reversion changes and do appreciate the time taken to address the concerns and changes made. This should be good to merge having accepted the suggested reversions made above.

@DenverCoder1 DenverCoder1 linked an issue Apr 4, 2023 that may be closed by this pull request
Copy link
Owner

@DenverCoder1 DenverCoder1 left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for making this contribution and for the extra effort. It is much appreciated 👍

@DenverCoder1 DenverCoder1 merged commit debaf8e into DenverCoder1:main Apr 4, 2023
@ghost
Copy link
Author

ghost commented Apr 4, 2023

Not a problem. I am glad to help the project out. Was a little concerning collecting the statics regarding the link-backs and a third of users wanting profile links do not even honour you with a link back to the repo or demo site. Very disappointing to have found those statistics ☹️

@ghost ghost deleted the update-profile-links branch April 4, 2023 23:28
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.

README.md needs URL Title Attributes for SEO
1 participant