Collection of docs fixes #3234
Collection of docs fixes #3234
Conversation
The build is here, but it doesn't work as I had hoped. The version number is set after the title is already created, and thus we still have "PostgREST devel" being shown there. This might still work, we will just need to update the version number accordingly on our release branches. |
wolfgangwalther
force-pushed
the
low-hanging-docs
branch
2 times, most recently
from
e750f8d
to
4f7273a
Compare
|
Have you had a look at the version number stuff, @steve-chavez? Is this prominently enough displayed, WDYT? Also, did you go through all other commits, too - or not, yet? If the tutorial/port issue is the only change we don't have agreement on, then I will just leave that out for the moment. Just let me know. |
Yeah, it looks good.
Sorry, should have been more explicit. Yes, I checked all the commits. The only observations I had where the ones above. All the rest LGTM. |
…rver Some users connect PostgREST to the wrong PostgreSQL instance - likely because they are not even aware that another instance is running. By using the standard port 5432 instead of 5433, we avoid this problem. The user will be made aware very early that they have another postgresql instance running - and can solve the problem at this stage. If they decide to change the port, they are much more likely to remember that in the later stages of the tutorial, too. Resolves PostgREST/postgrest-docs#304
We don't have any justification to add this hint anywhere. Resolves PostgREST/postgrest-docs#399
The obviously wrong statement is, that PostgREST does not support asymmetric keys, while it does. Extending on this type of attack is not necessary, because it is in fact covered by the paragraph before - reading the algorithm from the JWT header is the problem in that case, too. We don't do that. This leaves us with the sentence about how the chosen library is the most important part. While that is correct, the hint about high quality libraries for use on the *client* side is mis- leading: The important part here is the library we choose to implement PostgREST with, not the client-side lib. Thus, removing the whole paragraph is the best thing to do here. Resolves PostgREST/postgrest-docs#123
As mentioned in PostgREST#3088 rules and hooks are not available to new tenants anymore, so the note is not helpful anymore. Resolves PostgREST#3088 Resolves PostgREST/postgrest-docs#85 Resolves PostgREST/postgrest-docs#715
The examples in this sections were in seemingly random order before.
Not all examples on this page are strictly using string representation, especially bytea.
wolfgangwalther
force-pushed
the
low-hanging-docs
branch
from
4f7273a
to
83a36c5
Compare
wolfgangwalther
force-pushed
the
low-hanging-docs
branch
from
83a36c5
to
dbabf94
Compare
…release branches easily
wolfgangwalther
force-pushed
the
low-hanging-docs
branch
from
dbabf94
to
15a1842
Compare
|
I pushed the version number change to all back branches to have the version number show up on readthedocs everywhere. |
After going through all the open issues in the postgrest-docs repo and closing many of them, I came up with the following list of issues, which I should be able to solve quickly:
audwill still be accepted with ajwt-audsetting postgrest-docs#479The last commit / issue, about the version number, still needs to be tested in CI / readthedocs. All others should be good from my side.