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 documentation for tartiflette-starlette #230

Open
florimondmanca opened this issue May 24, 2019 · 6 comments
Open

Add documentation for tartiflette-starlette #230

florimondmanca opened this issue May 24, 2019 · 6 comments
Assignees

Comments

@florimondmanca
Copy link
Contributor

Request a feature

  • A part of the project could be improved

The ASGI adapter for Tartiflette is being developer at https://github.com/tartiflette/tartiflette-starlette.

We discussed adding documentation for tartiflette-starlette alongside tartiflette-aiohttp — see tartiflette/tartiflette-asgi#19 (comment).

A pre-requisite to this is to achieve feature parity between both packages (see tartiflette/tartiflette-asgi#20).

This issue is mostly here to track this task somewhere. :-) I will probably start working on it once feature parity has been rolled out.

@tsunammis
Copy link
Contributor

Thank you @florimondmanca I will have a look at it next week.

@tomchristie
Copy link

Thought: Might want to just call it tartiflette-asgi or something, and document it as mountable under Starlette, FastAPI, Responder, Bocadillo, Quart, or whatever else. (Possibly also the latest versions of Sanic, but I've not looked into that in any detail)

@florimondmanca
Copy link
Contributor Author

Fair point @tomchristie. tartiflette-asgi was the initial name, but seeing how much confusion the current seems to bring wrt to the Starlette dependency (“My framework is not based on Starlette so I can’t use this, right?”), I’d also be keen to revert.

(As for Sanic, someone’s trying out Sanic + tartiflette-starlette right now, but from at first glance it seems that Sanic misses the ASGI sub-mounting that allows integrating with other frameworks.)

@tsunnamis To catch up, has there been any progress I haven’t seen on documenting tartiflette-starlette in the official docs?

@AutumnalDream
Copy link

What's the status and is there anything I can help with on this?

@florimondmanca
Copy link
Contributor Author

florimondmanca commented Oct 27, 2019

@AutumnalDream I don't think there has been progress since the opening of this issue. Hints on how to contribute docs are here. I think the first step would be to rephrase the highlight on the landing page, e.g.:

### aiohttp / ASGI

In addition to the Tartiflette engine,
`tartiflette-aiohttp` and `tartiflette-starlette` allow you to
serve your GraphQL API over HTTP.

@tsunammis
Copy link
Contributor

@florimondmanca Hello, we didn't work on it. Do not hesitate to contribute to the documentation by creating a pull-request on tartiflette.io.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants