-
Notifications
You must be signed in to change notification settings - Fork 14
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
Documentation improvement #60
Comments
Prepared PR #63 that replaces openjade/latex tools with fop. The PR also introduces some more changes:
To compile the doc the same tools should be installed as for postgresql (https://www.postgresql.org/docs/current/docguide-toolsets.html). @msdemlei, @esabol, @df7cb: Could you please be so kind to consider this PR? Thank you in advance. |
TODO from @msdemlei: |
TODO: https://gist.github.com/MichaelCurrin/a698731096f78240f653faf9a9127cba https://github.com/marketplace/actions/deploy-to-github-pages |
TODO: Line 39 in fb93eb4
Line 22 in fb93eb4
These both need to be updated to reflect the current minimum (10.0?). I suppose one could define a variable for this in The only other instance of this minimum supported PostrgeSQL version is in the |
@esabol I temporary removed appendixes.sgm from the doc. This file is skipped in doc generation now. I propose to remote release notes from the doc because they are already shown on the github page. In my last PR I also removed minimal version from the install.sgm as @msdemlei suggested. I think it is a reasonable compromise. In my opinion, we should try to support all the versions if needed if it reasonable and doesn't complicate the development process significantly. |
I also would like to reformat the sources the same way as in the postgresql (identation with 1 space). It allows to place more text on the line. I'm going to prepare a separate PR with only changes in the format, if no objections. The example from postgres: |
One more suggestion is to put all doc rules into the top level makefile and to remove doc/Makefile and Makefile.common.mk. It allows to have the only Makefile and to utilize postgres doc installlation functionality (via DOCS variable). Now, there is README.pg_sphere and COPYRIGHT.pg_sphere are only installed when using make install. There are some difficulties to install pdf or html when doc rules are in a separate Makefile. |
There are some proposed tasks:
The text was updated successfully, but these errors were encountered: