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

Move release notes pages to github releases #644

Closed
steve-chavez opened this issue Jun 14, 2023 · 3 comments · Fixed by #666
Closed

Move release notes pages to github releases #644

steve-chavez opened this issue Jun 14, 2023 · 3 comments · Fixed by #666
Labels

Comments

@steve-chavez
Copy link
Member

steve-chavez commented Jun 14, 2023

Just saw QuestDB release page. Really cool, made me remember we have full markdown support there.

How about if we deprecate the docs release notes and move them to GH release page? https://postgrest.org/en/stable/releases/v11.1.0.html

Advantages

  • DRY. We no longer have to duplicate the CHANGELOG entries. Features can be linked to docs sections.
  • Users get notifications on releases

Notes

Seeing the QuestDB page, I realize it's better to have frequent releases. That way the release post overview can be focused.

@steve-chavez steve-chavez pinned this issue Jun 14, 2023
@steve-chavez
Copy link
Member Author

@laurenceisla @wolfgangwalther WDYT?

@laurenceisla
Copy link
Member

I like the idea, there could be a single Release page in the docs that redirects to each of the GH releases. A thing to keep in mind is that we must add links to the docs for the relevant features, changes, etc. so we should keep the docs up to date for that reason (even if the release page can be updated later).

steve-chavez added a commit to steve-chavez/postgrest-docs that referenced this issue Aug 5, 2023
steve-chavez added a commit to steve-chavez/postgrest-docs that referenced this issue Aug 5, 2023
steve-chavez added a commit that referenced this issue Aug 10, 2023
steve-chavez added a commit that referenced this issue Aug 10, 2023
@steve-chavez
Copy link
Member Author

I believe the end result looks better: https://github.com/PostgREST/postgrest/releases/tag/v11.2.0

That being said, it was a bit of pain having to sync the docs with core. Doing PostgREST/postgrest#2814 should make this easier.

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

Successfully merging a pull request may close this issue.

2 participants