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

[pages][tools]: Implement Tooling Analytics and Integrate Bowtie Report #858

Merged

Conversation

DarhkVoyd
Copy link
Member

What kind of change does this PR introduce?
This PR aims to provide some bug fixes, clean code refactor, enhanced code and add new enhancements such as implementation of analytics for tooling trends for the tooling page and integrate bowtie report in the current design.

Issue Number:

Screenshots/videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

@DarhkVoyd DarhkVoyd added the GSoC Google Summer of Code related label Aug 12, 2024
@DarhkVoyd DarhkVoyd requested a review from a team as a code owner August 12, 2024 12:21
Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

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

Added some comments.

data/tooling-data.yaml Show resolved Hide resolved
next.config.js Outdated Show resolved Hide resolved
@gregsdennis
Copy link
Member

I would also like a chance to review this from a UX perspective. I'm curious how the Bowtie integration looks.

Still waiting for a good build so that a preview is generated.

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

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

I pushed some small changes to improve the raise issues/bowtie buttons.

Everything else looks great! Amazing job. It is great to see this working!

Please make sure to fix conflicts and linting issues.

@DarhkVoyd DarhkVoyd force-pushed the add-tooling-insights branch from 5fe786a to aed7ddf Compare August 17, 2024 09:11
Copy link

codecov bot commented Aug 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (05d16e9) to head (39b73e4).
Report is 6 commits behind head on web-release-tooling.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           web-release-tooling      #858   +/-   ##
=====================================================
  Coverage               100.00%   100.00%           
=====================================================
  Files                        1         1           
  Lines                       20        20           
  Branches                    12        12           
=====================================================
  Hits                        20        20           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

github-actions bot commented Aug 17, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview 39b73e4

@DarhkVoyd
Copy link
Member Author

DarhkVoyd commented Aug 17, 2024

@benjagm Thanks! I have rebased the PR with latest changes, fixed conflicts and linting issues. The preview is not working as expected as the redirects takes us back to the previous implementations page, should I go ahead and remove it?

@benjagm
Copy link
Collaborator

benjagm commented Aug 17, 2024

Still waiting for a good build so that a preview is generated.

Now we have the preview here: #858 (comment)

@benjagm
Copy link
Collaborator

benjagm commented Aug 17, 2024

Now, we just need to add the backend API to complete the integration.

Let's do it!

@DarhkVoyd
Copy link
Member Author

I think we also need update the main nav link to /tools. Next router might not use the Cloudflare redirects.

@benjagm
Copy link
Collaborator

benjagm commented Aug 17, 2024

I think we also need update the main nav link to /tools. Next router might not use the Cloudflare redirects.

Yes. Better to change that link. You can also perform a search in the codebase looking for internal links pointing to "/implementations" because I am sure there will be some more.

@gregsdennis
Copy link
Member

gregsdennis commented Aug 17, 2024

What page is the change on? The preview link just takes me to the home page.

(We should probably ask this in the PR template.)

@DarhkVoyd
Copy link
Member Author

DarhkVoyd commented Aug 17, 2024

@gregsdennis I was just updating redirects and internal links, you can now easily preview changes on the tooling page after the new preview build.

@gregsdennis
Copy link
Member

Is this Bowtie "integration" just a link to the Bowtie site? From the description, I thought it'd be more.

@DarhkVoyd
Copy link
Member Author

DarhkVoyd commented Aug 17, 2024

@gregsdennis to utilise the space on the tooling table most optimally the tooling table has a outlink to bowtie for anyone interested, If you click on any tool it will display the tool with detailed information including bowie report and compliance in an information modal.

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

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

All good from my side. Thanks DV!!

@benjagm
Copy link
Collaborator

benjagm commented Aug 19, 2024

Is this Bowtie "integration" just a link to the Bowtie site? From the description, I thought it'd be more.

When you click over a tool, you see the details in a pop-up and when that tool is integrated with Bowtie you'll see all the badges.

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

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

This is ready from my side. Great job!!

@benjagm benjagm merged commit 7c58c79 into json-schema-org:web-release-tooling Aug 21, 2024
6 of 7 checks passed
benjagm added a commit that referenced this pull request Sep 4, 2024
* [data]: Data Preparation for Improved Data Model (#738)

* add validators to updated tooling data

* migrate hardcoded tooling data to updated model

* refine structure

* fix, clean, and add environment field

* add dependsOnValidators field

* remove empty fields

* conform to ecosystem tooling identification schema

* remove incorrect draft

* fix apache 2.0 license to spdx identifier

* [pages][tools]: Redesign UI/UX for Tooling Page (#808)

* initial redesign migration

* remove environments groupby

* add trigger update landscape tooling workflow (#838)

* [pages][tools]: Implement Tooling Analytics and Integrate Bowtie Report (#858)

* [pages][tools]: Prepare Tooling Page for Release

Closes: #780

* improve dropdownmenu and sidebar with svgr logo

better sidebar

better tooling table

* add ToolingTable

* fix sidebar and query params

* improve tooling data table

fix

* fix mobile responsive

* use css columns in modal

* use modal svgr icon

remove margins in tooling modal

* add initial analytics

* add sort by bowtie

* add analytics schema and fix sidebar bug

* fix CORS error

redirect follow is critical. Also, setting content-type header to
text/plain is critical, even if sending JSON, as "text/plain" does not
trigger the browser's preflight requests (which are unsupported by
Google here)

* update schema to remove source and homepage

* update yarn lock

* update call to action and issue template

* Pushed changes to improve style

* update dependencies

* fix json path types build error

* remove unused file

* update redirects

* update internal links

* fix linting errors

* add backend api

* fix bowtie api integration and add skeleton placeholder

* fix bowtie served over https

* sort toolingData drafts

* fix bowtie skeleton width style

* fix bowtie skeleton width

* add native title based tooltip

---------

Co-authored-by: Benjamin Granados <[email protected]>

* [data]: Sync and finalise tooling data (#899)

* sync tooling data

* add tooling data validation workflow and fix JSONSchemaTool interface

* fix undefined error

* use corepack and yarn in workflow

* fix tooling data

* fix tooling data draft

* Added 2 last tools

---------

Co-authored-by: Benjamin Granados <[email protected]>

* [web-release-tooling]: Minor fixes web tooling page (#913)

* add /implementations to /tools redirects

* fix /tools sidebar dropdown scrollbar

* fix nav link does not reset filters

* fix redirect typo

* update yarn lock

* fix redirects

* move wild card redirect to last

* fix dependencies problem

---------

Co-authored-by: Benjamin Granados <[email protected]>

* Removing old data files

* update the implementers workflow

---------

Co-authored-by: Benjamin Granados <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GSoC Google Summer of Code related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ Enhancement: Integrate Bowtie Reports ✨ Enhancement: Implement Tooling Trends Analytics
3 participants