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

Automate Connection Property Docs #1687

Open
sehrope opened this issue Jan 30, 2020 · 2 comments
Open

Automate Connection Property Docs #1687

sehrope opened this issue Jan 30, 2020 · 2 comments
Assignees

Comments

@sehrope
Copy link
Member

sehrope commented Jan 30, 2020

Once #1686 is merged we'll have all the metadata for generating the connection properties docs available in a structured format (the enum values themselves). Would be good to have the connection property docs be automatically generated from those structured fields so that:

  1. They're always in sync with what's actually supported.
  2. Typos and updates are managed in one place.
  3. We never have to remember to document new fields.

I'm not sure what the best approach for the doc generation itself but I'm adding this issue to track the overall idea of automatic doc generation.

@davecramer
Copy link
Member

@sehrope how's this coming ? :) We have gradle now so you can do this in groovy, or kotlin or ?

@sehrope
Copy link
Member Author

sehrope commented Jun 23, 2020

Hopefully some time soon. A good first step would be deleting the 9X directories: https://github.com/pgjdbc/pgjdbc/tree/master/docs/documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants