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: explain form handling using Netlify Adapter #1481

Merged

Conversation

kvn-shn
Copy link
Contributor

@kvn-shn kvn-shn commented May 17, 2021

Extended the Netlify Adapter readme to (better) explain how Netlitfy forms can be used in SvelteKit: #942 (comment)

@swyxio
Copy link
Contributor

swyxio commented May 17, 2021

i dont have a say bc im not a maintainer but i'm a fan of dropping all the related netlify tips on to the readme here 👍🏽

@benmccann
Copy link
Member

benmccann commented May 17, 2021

I'm not quite sure what the best path forward is here. I think that this is adding a lot of steps without explanation as to why you're following those steps. I like that the original article has more context - though we don't usually link to unofficial sources from the official readmes or docs. I'd be curious if the other maintainers have suggestions

@kvn-shn kvn-shn force-pushed the feat/netlify-adapter-explain-form-handling branch from 7ed79c2 to c2140d6 Compare May 17, 2021 21:44
@kvn-shn
Copy link
Contributor Author

kvn-shn commented May 17, 2021

@benmccann I thought of it less like a tutorial and more like a "Netlify forms are not working in SvelteKit what do I have to do?" troubleshooting section. In my opinion it makes sense to put it right there (when I was first encountering this issue I was actually checking the readme first if it's already explained ;) )

@swyxio
Copy link
Contributor

swyxio commented May 17, 2021

ya exactly. @ben - i appreciate that policy is ill defined where external integrations with svelte are concerned.

i'm happy to take on this maintenance work inside of the sveltesociety repo if you just wanna send people there instead... but either way we're all just trying to help future folks get up and running by placing hints in the first places we'd look.

@benmccann
Copy link
Member

benmccann commented May 17, 2021

yeah, definitely agree we need to figure out how to make this discoverable. sveltesociety might not be a bad place to put it. the nice thing about putting it in github vs an article is that if something's outdated then anyone can send a PR to update

@pngwn
Copy link
Member

pngwn commented May 17, 2021

I think the core of this issue is that we have an official package that is for a proprietary service. I think the readme probably is the right place for these docs, no-one made us support netlify directly. If we do support netlify then there is an expectation that the netlify ecosystem will be usable in some way and we need to inform users one way or the other, if the netlify docs will not cover those features in the context of kit.

The trick is how to we get those services to maintain the adapters? They have a vested interest and more capacity to keep things useful, relevant and up-to-date.

@swyxio
Copy link
Contributor

swyxio commented May 18, 2021

the straight answer is that netlify never will do that, because realistically svelte doesnt register as a high enough priority for them... this is where we just have to be realistic that we can do more on our end than they can do on theirs. as a former netlify employee i'm happy to offer my help, even tho i'm not the best responder but i'll do it eventually!!

@benmccann
Copy link
Member

I don't mind having more docs here in the README. It is a very reasonable place to put them. The main concern I had is that it was just taking the steps from the article without providing any context around why you'd be doing these things, in what cases, etc.

@swyxio
Copy link
Contributor

swyxio commented May 18, 2021

ok, got you, yeah the balance of how much context to offer is tricky. i do like leaving links for further investigation: https://github.com/sveltejs/kit/pull/1481/files#diff-3eebbc3ad3070317b85447ad5cf803ef738eea1f2ad774f1d5506300efeb0388R62

@kvn-shn
Copy link
Contributor Author

kvn-shn commented May 18, 2021

I don't mind having more docs here in the README. It is a very reasonable place to put them. The main concern I had is that it was just taking the steps from the article without providing any context around why you'd be doing these things, in what cases, etc.

@benmccann I guess you didn't mean it like that but believe it or not I've really put some time into it and didn't simply copy it over from the article. (btw, thanks again @sw-yx for pointing me in the right direction.)

As I said, my idea was to simply help out others who are facing the same issues I've encountered regarding SvelteKit and Netlify forms. Thus I'm assuming that someone who's troubleshooting that, already has ~90% setup and is just looking for the necessary minor tweak. For a broader overview we already have Netlify docs etc.

@benmccann benmccann added the documentation Improvements or additions to documentation label May 18, 2021
@kvn-shn kvn-shn force-pushed the feat/netlify-adapter-explain-form-handling branch from c2140d6 to 99b9982 Compare May 18, 2021 21:06
@kvn-shn
Copy link
Contributor Author

kvn-shn commented May 18, 2021

As suggested in #1484 (comment) I also added readme changes regarding the redirect rules here.

@kvn-shn kvn-shn force-pushed the feat/netlify-adapter-explain-form-handling branch from 99b9982 to b8f5875 Compare May 19, 2021 06:13
@benmccann benmccann merged commit e144771 into sveltejs:master May 19, 2021
@benmccann
Copy link
Member

thanks for this!

andyburke pushed a commit to andyburke-forks/kit that referenced this pull request May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants