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 favicon html content #1418

Merged
merged 28 commits into from
Jan 30, 2023

Conversation

that-cisco-guy
Copy link
Contributor

Description

Added information on html favicon (shortcut image) to html content folder.

Type of Change

  • Adding a new entry

Checklist

  • [x ] All writings are my own.
  • [x ] My entry follows the Codecademy Docs style guide.
  • [ x] My changes generate no new warnings.
  • [ x] I have performed a self-review of my own writing and code.
  • [ x] I have checked my entry and corrected any misspellings.
  • [x ] I have made corresponding changes to the documentation if needed.
  • [ x] I have confirmed my changes are not being pushed from my forked main branch.
  • [ x] I have confirmed that I'm pushing from a new branch named after the changes I'm making.
  • [ x] Under "Development" on the right, I have linked any issues that are relevant to this PR (write "Closes # in the "Description" above).

@CLAassistant
Copy link

CLAassistant commented Jan 2, 2023

CLA assistant check
All committers have signed the CLA.

@SSwiniarski SSwiniarski self-assigned this Jan 2, 2023
@SSwiniarski SSwiniarski added html HTML entries new entry New entry or entries status: under review Issue or PR is currently being reviewed labels Jan 2, 2023
Copy link
Contributor

@SSwiniarski SSwiniarski left a comment

Choose a reason for hiding this comment

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

@that-cisco-guy I did a first review and left a few comments. Most of the rephrasing is to avoid the direct address to the reader, which is not preferred in Docs.

@that-cisco-guy
Copy link
Contributor Author

I revised as per instruction but I'm not sure if I need to create a new pull request as I see my new commits at the end of the page. I apologize for the trouble, still getting Github down.

Copy link
Contributor

@SSwiniarski SSwiniarski left a comment

Choose a reason for hiding this comment

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

@that-cisco-guy No need for a new PR. The edits will appear in this one. Looks good for a second review.

@that-cisco-guy
Copy link
Contributor Author

Thank you @SSwiniarski I appreciate your time. Is there anything else I need to do? I see some of the 'checks' failed; is that something I messed up and need to fix?

@SSwiniarski
Copy link
Contributor

SSwiniarski commented Jan 3, 2023

@that-cisco-guy Running yarn format on the .md file will usually clear up these checks.

@yangc95 yangc95 added status: under review Issue or PR is currently being reviewed and removed status: ready for next review labels Jan 3, 2023
@that-cisco-guy that-cisco-guy requested a review from yangc95 January 4, 2023 18:28
@that-cisco-guy
Copy link
Contributor Author

@yangc95 All the files are updated as requested.

@that-cisco-guy
Copy link
Contributor Author

@yangc95 just checking in to see if there was anything else that needed to be done.

@that-cisco-guy that-cisco-guy requested review from Dusch4593 and removed request for yangc95 January 11, 2023 21:42
@Dusch4593 Dusch4593 added status: under review Issue or PR is currently being reviewed and removed status: waiting for author labels Jan 12, 2023
Copy link
Contributor

@Dusch4593 Dusch4593 left a comment

Choose a reason for hiding this comment

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

@that-cisco-guy Finished taking a look and left you some comments/suggestions 😄


Any image format that is supported by web browsers can be used as a favicon, but the most common format is `.ico`. An `.ico` file can be created using an image editor or online converter tool.

With the favicon file and the `link` element in the HTML, the favicon should be displayed in the browser's address bar and tab title for the website.
Copy link
Contributor

Choose a reason for hiding this comment

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

With the favicon file and the link element in the HTML, the favicon should be displayed in the browser's address bar and tab title for the website.

This really depends on the browser being used. It seems that most modern browsers only display the favicon next to the tab title for the website whereas an HTTPS "lock icon" is next to the address bar.

Could we possibly rewrite this line as a new "## Example" section that describes this distinction with the following:

  • An ```html code snippet with an image of the Codecademy logo as a favicon.
  • A screenshot of what the rendered output would look like on the browser (including the HTTPS lock icon)
    • Be sure to store this screenshot image in the media/ folder and use the following format for the markdown image: https://raw.githubusercontent.com/Codecademy/docs/main/media/filename.ext

@Dusch4593 Dusch4593 self-assigned this Jan 12, 2023
@Dusch4593 Dusch4593 added status: waiting for author and removed status: under review Issue or PR is currently being reviewed labels Jan 12, 2023
@SSwiniarski SSwiniarski dismissed Dusch4593’s stale review January 30, 2023 17:33

@Dusch4593 is no longer a maintainer on this repo.

@SSwiniarski
Copy link
Contributor

@that-cisco-guy, because of over two weeks of inactivity, and in the interest of getting this merged, I implemented @Dusch4593's suggestions.

@SSwiniarski SSwiniarski merged commit ec41377 into Codecademy:main Jan 30, 2023
@github-actions
Copy link

👋 @that-cisco-guy
You have contributed to Codecademy Docs, and we would like to know more about you and your experience.
Please take a minute to fill out this four question survey to help us better understand Docs contributions and how we can improve the experience for you and our learners.
Thank you for your help!

@SSwiniarski
Copy link
Contributor

Congrats @that-cisco-guy! Your entry is now live here: https://www.codecademy.com/resources/docs/html/favicon

It looks like you're currently anonymous:
image
If you'd like to become public, make sure to add your GitHub username to your Codecademy profile and set your visibility to everyone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants