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.

Sign up for GitHub

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

Jump to bottom

📝 docs: replace SVG badges with dynamic JSON badges in README.md #95

Closed
3 tasks done
chriskyfung opened this issue Jan 30, 2024 · 0 comments · Fixed by #87 or #97
Closed
3 tasks done

📝 docs: replace SVG badges with dynamic JSON badges in README.md #95

chriskyfung opened this issue Jan 30, 2024 · 0 comments · Fixed by #87 or #97
Assignees
@chriskyfung
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request
Milestone
2024-02-05 Librar...

Comments

@chriskyfung
Copy link
Owner

chriskyfung commented Jan 30, 2024 •
edited
Loading

Description

The status badges in the README.md file are currently using SVG images that are hosted on Google Drive and require manual updates. However, due to the issue mentioned in the Google Sites support thread at https://support.google.com/sites/thread/253003338, the badges are not displayed correctly and show broken links.

To resolve this issue, I propose to replace the SVG badges with Shields.io dynamic JSON badges that query the status of the project from a custom Google Apps Script web app. The new badges will be hosted on Shields.io and do not depend on Google Drive. They will also update automatically based on the project status.

The changes will involve:

  • Creating a Google Apps Script web app that returns the project status as a JSON object
  • Updating the badge URLs and labels in the README.md file to use the Shields.io Dynamic JSON badges
  • Testing the badges to ensure they show the correct status and work as expected

For more information on how to create and customize dynamic badges, see Dynamic JSON Badge | Shields.io.

Task list:

  • Create a Google Apps Script web app that returns the project status as a JSON object
  • Update the badge URLs and labels in the README.md file to use the Shields.io dynamic JSON badges
  • Test the badges to ensure they show the correct status and work as expected
@chriskyfung chriskyfung self-assigned this Jan 30, 2024
@chriskyfung chriskyfung added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 30, 2024
@chriskyfung chriskyfung added this to the Library v9 milestone Jan 30, 2024
@chriskyfung chriskyfung mentioned this issue Jan 30, 2024
Merged
16 tasks
@chriskyfung chriskyfung added the bug Something isn't working label Jan 30, 2024
chriskyfung added a commit that referenced this issue Jan 30, 2024
@chriskyfung
📝 docs: replace SVG badges with dynamic JSON badges in README.md
6c0346a 
This commit resolves the broken links of the status badges in the
README.md file, which resulted from the issue mentioned in the Google
Sites support thread at <https://support.google.com/sites/thread/253003338>.

The solution involves using Shields.io dynamic JSON badges instead of
SVG badges. The new badges:

- Are hosted on Shields.io and do not depend on Google Drive
- Use a custom Google Apps Script web app to fetch the project status
- Have updated URLs and labels in the README.md file

The changes ensure that the badges show the correct status and work as
expected.

For more information on how to create and customize dynamic badges, see
<https://shields.io/badges/dynamic-json-badge>.

Fixs #95
chriskyfung added a commit that referenced this issue Feb 2, 2024
@chriskyfung
📝 docs: replace SVG badges with dynamic JSON badges
5b928d9 
This commit resolves the broken links of the status badges on the project
landing page, which resulted from the issue mentioned in the Google
Sites support thread at <https://support.google.com/sites/thread/253003338>.

The solution involves using Shields.io dynamic JSON badges instead of
SVG badges. The new badges:

- Are hosted on Shields.io and do not depend on Google Drive
- Use a custom Google Apps Script web app to fetch the project status
- Have updated URLs and labels in the `README.md` and `docs/index.md` files

The changes ensure that the badges show the correct status and work as
expected.

For more information on how to create and customize dynamic badges, see
<https://shields.io/badges/dynamic-json-badge>.

Fixs #95
chriskyfung added a commit that referenced this issue Feb 2, 2024
@chriskyfung
📝 docs: replace SVG badges with dynamic JSON badges
72d2ca3 
This commit resolves the broken links of the status badges on the project
landing page, which resulted from the issue mentioned in the Google
Sites support thread at <https://support.google.com/sites/thread/253003338>.

The solution involves using Shields.io dynamic JSON badges instead of
SVG badges. The new badges:

- Are hosted on Shields.io and do not depend on Google Drive
- Use a custom Google Apps Script web app to fetch the project status
- Have updated URLs and labels in the `README.md` and `docs/index.md` files

The changes ensure that the badges show the correct status and work as
expected.

For more information on how to create and customize dynamic badges, see
<https://shields.io/badges/dynamic-json-badge>.

Fixs #95
chriskyfung added a commit that referenced this issue Feb 2, 2024
@chriskyfung
📝 docs: replace SVG badges with dynamic JSON badges
7655356 
This commit resolves the broken links of the status badges on the project
landing page, which resulted from the issue mentioned in the Google
Sites support thread at <https://support.google.com/sites/thread/253003338>.

The solution involves using Shields.io dynamic JSON badges instead of
SVG badges. The new badges:

- Are hosted on Shields.io and do not depend on Google Drive
- Use a custom Google Apps Script web app to fetch the project status
- Have updated URLs and labels in the `README.md` and `docs/index.md` files

The changes ensure that the badges show the correct status and work as
expected.

For more information on how to create and customize dynamic badges, see
<https://shields.io/badges/dynamic-json-badge>.

Fixs #95
@chriskyfung chriskyfung linked a pull request Mar 15, 2024 that will close this issue
🏗 Development for V10 #97
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chriskyfung chriskyfung

Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
2024-02-05 Library v9
1 participant
@chriskyfung