Docs: Improve backup restore + fix warnings #554

Open
ilja wants to merge 2 commits from ilja/akkoma:docs_db_create_in_separate_commands into develop
Contributor

CREATE DATABASE was running in a transaction block with CREATE USER. Someone in the chat had problems with this because this isn't allowed (any more?). This is now two separate commands. I also did some other touch-ups to this file, including

  • making it OTP-first,
  • add backup of static directory because this contains e.g. custom emoji, and
  • remove the suggestion for using the setup_db.psql file. The reason is because I fear it causes more confusion than what it's worth.
    • Firstly, OTP installations won't have this file because it's created in /tmp.
    • Secondly, the instance has been reinstalled and thus a new setup_db.psql with different password will have been created, causing only more confusion.

When building the docs, I noticed two warnings, these are now also fixed.

  • One was a link to a file in the source code that didn't exist as far as mkdocs is concerned. This now links to the file in the git repo.
  • The other was because one of the font files wasn't found. I think it first tries to load them from your own system (which may explain why I only had an error on one of them, but I didn't check deeper), so it's possible that some people won't see changes, but those who didn't have the font on their system (like me), will see it.
CREATE DATABASE was running in a transaction block with CREATE USER. Someone in the chat had problems with this because this isn't allowed (any more?). This is now two separate commands. I also did some other touch-ups to this file, including * making it OTP-first, * add backup of static directory because this contains e.g. custom emoji, and * remove the suggestion for using the setup_db.psql file. The reason is because I fear it causes more confusion than what it's worth. * Firstly, OTP installations won't have this file because it's created in /tmp. * Secondly, the instance has been reinstalled and thus a new setup_db.psql with different password will have been created, causing only more confusion. When building the docs, I noticed two warnings, these are now also fixed. * One was a link to a file in the source code that didn't exist as far as mkdocs is concerned. This now links to the file in the git repo. * The other was because one of the font files wasn't found. I think it first tries to load them from your own system (which may explain why I only had an error on one of them, but I didn't check deeper), so it's possible that some people won't see changes, but those who didn't have the font on their system (like me), will see it.
ilja force-pushed docs_db_create_in_separate_commands from 74f95ec156 to 3947012691 2023-05-29 07:10:17 +00:00 Compare
Oneric approved these changes 2024-04-27 00:11:20 +00:00
Oneric left a comment
Member

Seems good to me and according to Forgejo still applies cleanly

Seems good to me and according to Forgejo still applies cleanly
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u docs_db_create_in_separate_commands:ilja-docs_db_create_in_separate_commands
git checkout ilja-docs_db_create_in_separate_commands
Sign in to join this conversation.
No description provided.