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

docs(sample): add guide for integrating with azure functions #1637

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

Mingyang-Li
Copy link

@Mingyang-Li Mingyang-Li commented Feb 21, 2024

Hi, I noticed we don't have any guides on how to integrate this library with Azure Functions, so I wrote a Medium article about it.

This PR involves adding a new page on the documentation website (v2.0.0-beta.6), plus a link to my article on how we can implement the integration, hopefully this will help more people

Update (2024-02-27)

  1. Added a compact guide for integrating with azure functions
  2. Added example project for No.1

@carlocorradini
Copy link
Contributor

@Mingyang-Li Can you add an example in the examples directory?
Thanks 👍🙏

@MichalLytek
Copy link
Owner

I don't see any point of advertising medium article in the project docs.

It would make much more sense to copy/compact the article and add it as a proper doc page here (and maybe also add example as @carlocorradini said).

Doc section with link to article is just like typing "TypeGraphQL Azure Functions" in Google.

@Mingyang-Li Mingyang-Li changed the title docs(sample): add article on for integrating with azure functions docs(sample): add guide for integrating with azure functions Feb 27, 2024
@MichalLytek MichalLytek force-pushed the ml/doc-integrate-with-azure-functions branch from 61efbf6 to 305ae1f Compare May 7, 2024 09:11
@MichalLytek
Copy link
Owner

@Mingyang-Li
I had to remove the example as it's only about config related to all Azure functions + index file, so docs should be sufficient for integrating TypeGraphQL by users.
The example was using own package.json + a build step, so it's not easy to run as our other examples.

Copy link

codecov bot commented May 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.50%. Comparing base (be33fd4) to head (a1758b2).
Report is 26 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1637   +/-   ##
=======================================
  Coverage   95.50%   95.50%           
=======================================
  Files         113      113           
  Lines        1847     1847           
  Branches      364      351   -13     
=======================================
  Hits         1764     1764           
  Misses         83       83           

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community 👨‍👧 Something initiated by a community Documentation 📖 Issues about docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants