search

pgmoneta / pgmoneta_ext

PostgreSQL extension for pgmoneta
BSD 3-Clause "New" or "Revised" License
4 stars 3 forks source link

[#20] Manuals for 0.1.0 #21

Closed GuChad369 closed 1 month ago

GuChad369 commented 1 month ago

Initial version for the 0.1.0 manual:

jesperpedersen commented 1 month ago

You have 2.6 Verify success that can be moved to 3 Quick start.

And, in 3 Quick start you can remove all the compile commands

jesperpedersen commented 1 month ago

You have the postgresql.conf requirement in chapter 2 instead of chapter 3.

And, you don't need a section in chapter 3 - everything can be in one

GuChad369 commented 1 month ago

Could you specify the file you're referring to, instead of using chapter names? I'm a bit confused right now.

GuChad369 commented 1 month ago

You have 2.6 Verify success that can be moved to 3 Quick start.

And, in 3 Quick start you can remove all the compile commands

For this part, have I achieved the desired output correctly?

You have the postgresql.conf requirement in chapter 2 instead of chapter 3.

And, you don't need a section in chapter 3 - everything can be in one

For this part, I thought you wanted to move all Configuration in the file dev-01-config.md into the file 02-installation.md section.

jesperpedersen commented 1 month ago

As above,

jesperpedersen commented 1 month ago

Put on your user hat - Chapter 1. What is the extension ? Chapter 2. How do I install it, and maybe compile it ? Chapter 3. How do I configure it, and test it ?

Put on your developer hat - what does a developer who would like to help out need to know, so the developer guide can be more "hard-core"

GuChad369 commented 1 month ago

I moved all tests under the developer manual.

For users, they only need the functionality of the extension; they don't need to run tests. If some functions don't work, they can manually test them according to the user-02-functions.md file.

For developers, who may need to modify the code, the test suite is designed specifically for them.

And the container test suite will always work successfully, so it is not necessary for users to run it.

jesperpedersen commented 1 month ago

There are some issues with the links in https://github.com/pgmoneta/pgmoneta_ext/blob/main/doc/manual/dev-02-git.md#git-guide in initial part

jesperpedersen commented 1 month ago

Merged.

Thanks for your contribution !