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: merge postgrest-docs into the core repository #3120

Merged
merged 5 commits into from
Feb 18, 2024

Conversation

laurenceisla
Copy link
Member

@laurenceisla laurenceisla commented Dec 16, 2023

Closes #2814

@laurenceisla laurenceisla changed the title Merge docs docs: merge postgrest-docs into the core repository Dec 16, 2023
@steve-chavez
Copy link
Member

Some extra things to consider:

  • The docs/default.nix and docs/shell.nix should be merged with the root ones. The docs have a postgrest-docs-* prefix so this should work ok, no clashes.
  • The readme and the docs should share the sponsor logos, right now they're duplicated.

@laurenceisla laurenceisla force-pushed the merge-docs branch 6 times, most recently from b9df86b to 8e6bfce Compare December 19, 2023 00:49
@laurenceisla laurenceisla marked this pull request as ready for review December 19, 2023 00:49
@laurenceisla
Copy link
Member Author

The readme and the docs should share the sponsor logos, right now they're duplicated.

I think it should be done in a different PR after merging, since a new Sponsor was added. Kinda scary to handle rebase conflicts here.


I tested a Read The Docs deploy using this branch and it seems to be working without issues:

https://postgrest-test.readthedocs.io/en/stable/

@laurenceisla
Copy link
Member Author

@wolfgangwalther WDYT? Did you manage to compare both strategies to merge the docs into the core repo?

@wolfgangwalther
Copy link
Member

Did you manage to compare both strategies to merge the docs into the core repo?

I did not, yet. It's on my list after #3169 and some more experiments with cross-compiling.

@wolfgangwalther
Copy link
Member

As a first step, I rebased this PR on the recent merge of the docs main branch. Will still go through the details of the nix setup etc. later.

wolfgangwalther and others added 5 commits February 17, 2024 20:33
This allows more flexible control over the working directory. Values for workingDir must always start
with a / and will then be relative to the repo root.
This is long overdue. We expect everyone contributing to postgrest to use the nix tools,
so it makes no sense to carry around external tools anymore.
@wolfgangwalther
Copy link
Member

Will still go through the details of the nix setup

Done.

The readme and the docs should share the sponsor logos, right now they're duplicated.

Done.

Will wait for CI to pass and then merge.

@wolfgangwalther wolfgangwalther marked this pull request as ready for review February 18, 2024 11:15
@wolfgangwalther wolfgangwalther merged commit b435f1b into PostgREST:main Feb 18, 2024
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Merge postgrest-docs with main repo
3 participants