-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Fix generate-readme script, refresh examples.json and README.md #703
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
Conversation
domdomegg
commented
May 26, 2022
pgrzesik
commented
May 27, 2022
Hello @domdomegg - sorry for late response. This is a massive change and we're currently in the process of rethinking how we should handle the examples repository. It also includes potential breaking changes and I'm not sure if we will have the bandwidth to properly evaluate the changes in the coming days.
What do you think @mnapoli ?
mnapoli
commented
Jun 30, 2022
Sorry for the delay, yeah this is a massive PR, I wouldn't be confident merging this, especially with how these files are used to generate pages on serverless.com
Maybe if this was all split in smaller pull requests it might be easier? Not sure though 😕
At a high-level, this fixes up the examples repository. Currently, both the
npm run docsandnpm run lintscripts don't even run.⚡ This PR
package.jsondefinitions, and generates examples.json from them. This allowsnpm run docsto run successfully.npm run lintto run (but it doesn't pass at the moment, given lots of examples have noncompliant code... but figured fixing all these was for another day)⚠ Potentially breaking changes
framework,authorLink,authorName,authorAvatarfrom examples.json. It isn't used in this repository, and I don't think any of them are necessary for the Serverless examples site but as it's not open-source AFAIK I'm unable to know for sure they're unused.🔮 Future work