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 repository node to json #438

Merged
merged 3 commits into from
Aug 16, 2023

Conversation

MacFJA
Copy link
Collaborator

@MacFJA MacFJA commented Aug 15, 2023

  • Add repository information to components, tools, templates data
  • Add repository node to json files when needed
  • Remove stars node from json (as it's only read from stars.json)
  • Add link to repository on component card
  • Update stars.json
  • Update the submission page

@MacFJA MacFJA requested a review from benmccann August 15, 2023 13:12
@netlify
Copy link

netlify bot commented Aug 15, 2023

Deploy Preview for sveltesociety-preview ready!

Name Link
🔨 Latest commit db0a59b
🔍 Latest deploy log https://app.netlify.com/sites/sveltesociety-preview/deploys/64dd333c3b954a0008de55e4
😎 Deploy Preview https://deploy-preview-438--sveltesociety-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@benmccann
Copy link
Collaborator

This is great! Thank you so much!

Do you think we could move the github URLs to always be contained within the repository field? I.e. use the the url field only if an entry has both a site url and repository URL present. We could probably write a little Node script to transform it or maybe use jq (I don't have any experience with the latter)

@MacFJA
Copy link
Collaborator Author

MacFJA commented Aug 15, 2023

Do you think we could move the github URLs to always be contained within the repository field? I.e. use the the url field only if an entry has both a site url and repository URL present.

So swap the behavior ?

  • repository is the required field
  • url is an (optional) "superset" to add a specificity
  • the link of the component/tool/template card is repository unless url is defined

But:

  • what about package that don't have public source?
    • don't make any URL mandatory ?
      • What happen is a package don't have a repository nor an URL?

@MacFJA
Copy link
Collaborator Author

MacFJA commented Aug 15, 2023

We could probably write a little Node script to transform it or maybe use jq (I don't have any experience with the latter)

It's a one time action to do ;
so it can be easily be done by

  • jq
  • a node script
  • sed
  • an IDE/TextEditor seach/replace

@benmccann
Copy link
Collaborator

So swap the behavior ?
repository is the required field
url is an (optional) "superset" to add a specificity
the link of the component/tool/template card is repository unless url is defined

Yep, that's what I was thinking

what about package that don't have public source?

Do we have any? I suppose we could make neither URL mandatory in that case

What happen is a package don't have a repository nor an URL?

We should at the very least require one of the two fields to be present

an IDE/TextEditor seach/replace

Duh. That's obviously the easiest 😆

@MacFJA MacFJA requested a review from benmccann August 16, 2023 20:39
@benmccann benmccann merged commit 60bb47f into svelte-society:main Aug 16, 2023
5 checks passed
@benmccann
Copy link
Collaborator

Amazing! Thank you!! This along with the autoupdate script is such a huge improvement!

@MacFJA MacFJA deleted the add-repository-node branch August 16, 2023 20:41
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