Skip to content

Fixing/restoring favicon to Player project website #2

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

quaid
Copy link

@quaid quaid commented Apr 21, 2025

I noticed the favicon was missing for the 'latest' version of the Player website, although it was present in the 'next' version.* Looking around it appears the index.html is the source of the problem for the website,although it's also clear the website is being built and deployed from inside of Intuit, and therefore the source of the error might be a different file or location. Hopefully this PR helps with an internal fix, if that's the case.

(BTW, the contributing and new-to-contributing documents were very good, I especially appreciated the help afforded to people new(er) to the GitHub paradigm. Well done!)

(BTW.2, I did my PR entirely through the GitHub web interface, as this kind of contribution didn't seem to be covered by the more involved setup in CONTRIBUTORS.md.)

  • Note that it's not clear from the interface or resulting pages what next, latest, and 0 mean, although my guess is the pages are being rendered through Player and this is Player functionality being demonstrated?!?

quaid added 2 commits April 21, 2025 10:59
It seems there was an error in building the webpage source for the 'latest' that didn't happen for 'next'.

In the case of 'latest' (and therefore how it is seen by default in the world), the favicon call is to `favicon.svg` of the 'type="image/x-icon"', which does not render in the browser (at least, not on Chrome on Linux.)

This PR simply reverts (or corrects) that change. I don't know that this PR can be merged to make the change, though, as it's evident these pages are built using an Intuit internal build system (a not uncommon situation -- maintaining an external build service is a PITA, ask me how I know.)

If there is something I can do from inside of Intuit now that I'm inside, let me know and also email [email protected] to point me in the right direction. Happy to do self-service, it's also a chance for me to have a "new contributor to Player"-experience. 😁
Oops, I forgot to change the path when I used the `/next/index.html` as reference content.
@KetanReddy
Copy link
Member

Hey! Thanks for the contribution and feedback @quaid. To address a couple points you raised:

it's also clear the website is being built and deployed from inside of Intuit

The website is actually built and deployed from the main Player UI repository during the deployment process here. This repository basically just holds the generated site for serving so it doesn't have to be tracked in the git history for Player.

Note that it's not clear from the interface or resulting pages what next, latest, and 0 mean, although my guess is the pages are being rendered through Player and this is Player functionality being demonstrated?!?

Thats actually a great call out and I created this ticket for us to better document the doc site strategy and release process. In essence though:

  • The next route correlates to the doc site generated by the latest build of Player.
    • Every PR merged into the main branch (unless opted out) will generate a next build so that functionality can be immediately consumed. Since these are in effect nightly/preview releases we wanted to split out a doc site to avoid confusion on what is available if someone was just to pull in Player.
  • The latest route correlates to the doc site generated from the last non-next release of Player.
    • These are releases that are we intentionally choose to cut and have a non-tagged semvar version.
  • The 0 route contains the docs for the last 0.x.x release which right now means its the same as the latest docs.
    • The idea was that for every major release we would preserve the doc site for the last version released for it to allow folks who can't upgrade immediately still have access to docs that are accurate for them.

@quaid
Copy link
Author

quaid commented Apr 21, 2025

Hey! Thanks for the contribution and feedback @quaid. To address a couple points you raised:

it's also clear the website is being built and deployed from inside of Intuit

The website is actually built and deployed from the main Player UI repository during the deployment process here. This repository basically just holds the generated site for serving so it doesn't have to be tracked in the git history for Player.

Oh, thank you! When I saw @intuit-svc doing deployments I jumped to a conclusion about the pattern I detected — it wasn't the "Legacy Buildsystem Pattern", it was the "Cloud Native CI/CD Pattern", so of course the docs and website are built and deployed as part of the primary code base.

Note that it's not clear from the interface or resulting pages what next, latest, and 0 mean, although my guess is the pages are being rendered through Player and this is Player functionality being demonstrated?!?

Thats actually a great call out and I created this ticket for us to better document the doc site strategy and release process. In essence though:

Thanks, that makes good sense conceptually and I like the interface.

In reading through your explanation it jumps out to me what was confusing and made the functionality less apparent for me — the namespace for the word "latest" is conflicted with the two meanings.

Not sure I have a better idea, but I'll offer them in the ticket you created, and PRs in the main repo that is the actual source for this static one.

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.

2 participants