Skip to content
This repository has been archived by the owner on Feb 24, 2024. It is now read-only.

Update providing-html-content-using-htmx.rst #691

Closed
wants to merge 1 commit into from
Closed

Update providing-html-content-using-htmx.rst #691

wants to merge 1 commit into from

Conversation

joaofelipecb
Copy link

Included information about configuration of raw-media-types. Without this configuration the example doesn't work correctly.

Included information about configuration of raw-media-types
@steve-chavez
Copy link
Member

Thanks @joaofelipecb.

We're actually trying to improve the DX of that tutorial, so we've removed raw-media-types on the master branch of postgrest (PostgREST/postgrest#2825) in preference of the DOMAIN media types. Note that this are the latest docs.

How about if instead we put a warning mentioning that the tutorial only works on the master branch and perhaps link a nightly release there?

@joaofelipecb
Copy link
Author

joaofelipecb commented Nov 5, 2023

I understand the worry with DX and in the future the nightly version will become stable so the tutorial will work in a stable version.

Unfortunately, I spend 2h to figure out why this was not working, and despite the high quality of the project, this harmed my own developer experience, as I almost quit the tutorial.

Since I want more developers to try PostgRest, I think the better solution is to provide a troubleshooting section and insert the error message of prior versions and the solution. What do you think?

@steve-chavez
Copy link
Member

Unfortunately, I spend 2h to figure out why this was not working, and despite the high quality of the project, this harmed my own developer experience, as I almost quit the tutorial.

Sorry about that @joaofelipecb. We'll definitely be more careful about publishing how-tos that rely on master from now on.

Since I want more developers to try PostgRest, I think the better solution is to provide a troubleshooting section and insert the error message of prior versions and the solution. What do you think?

How about doing having tabs on the code snippets? Like we do for HTTP/Curl examples on https://postgrest.org/en/latest/references/api/tables_views.html).

For this we could have a tab for v11 and previous and latest (which later will become v12). What do you think?

@steve-chavez
Copy link
Member

Now that v12 is released the tutorial is stable: https://postgrest.org/en/stable/how-tos/providing-html-content-using-htmx.html

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants