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

Update README.md with relative rather than absolute URL for ScubaGear logo #1576

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ahuynhMITRE
Copy link
Collaborator

@ahuynhMITRE ahuynhMITRE commented Feb 17, 2025

🗣 Description

@schrolla noted that when viewing the readme on GitHub pages the ScubaGear logo is currently broken. This PR will removed the current absolute URL to accurately show up on GitHub pages.

💭 Motivation and context

change is required for the GitHub pages to show the ScubaGear logo.
closes issue #1575

🧪 Testing

created a fork with the changes added to main and published to a new GitHub pages site.
link to GitHub pages site: https://ahuynhmitre.github.io/ScubaGearlogoupdate/
screenshot linked below.
Screenshot 2025-02-17 at 12 30 13 PM

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant functional tests passed.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

  • Demonstrate changes to the team for questions and comments.
    (Note: Only required for issues of size Medium or larger)

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@ahuynhMITRE ahuynhMITRE added the documentation This issue or pull request improves or adds to documentation label Feb 17, 2025
@ahuynhMITRE ahuynhMITRE added this to the Marlin milestone Feb 17, 2025
@ahuynhMITRE ahuynhMITRE self-assigned this Feb 17, 2025
@ahuynhMITRE ahuynhMITRE marked this pull request as ready for review February 17, 2025 18:01
Copy link
Collaborator

@schrolla schrolla left a comment

Choose a reason for hiding this comment

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

Updated relative URI without the additional '/' seems good. Renders properly in the Markdown view of the README.md and included screenshot shows that GitHub Pages will render the new link properly as well.
Nicely done, looks good to me.

Copy link
Collaborator

@james-garriss james-garriss left a comment

Choose a reason for hiding this comment

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

Looks good. Nice work on creating the test repo.

@ahuynhMITRE
Copy link
Collaborator Author

@nanda-katikaneni good to merge!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update broken ScubaGear logo to fix view in GitHub pages view of the readme
3 participants