mongo_fdw icon indicating copy to clipboard operation
mongo_fdw copied to clipboard

Published 20 hours ago • verified publisher icon EnterpriseDB

Refactor README.md for PGXN

Open mkgrgis opened this issue 2 years ago • 7 comments

Add separate INSTALL.md. Other changes in README.md for unifying with https://github.com/pgspider FDW documentation template and by https://github.com/ibarwick/firebird_fdw/blob/master/README.md example of advanced FDW documentation.

mkgrgis avatar Oct 04 '23 06:10 mkgrgis

Thanks, @mkgrgis for patch. I did more changes like fixing spelling mistakes, deleting duplicate code, indentation, etc.

Find revised patch. Please find difference between patch provided by you and me. If you're agree with the changes then post this patch or point out the changes you are NOT agree. Thanks. v2-Refactor-README.md-for-PGXN.txt

vaibhavdalvi93 avatar Oct 04 '23 11:10 vaibhavdalvi93

Thanks for the patch, @vaibhavdalvi93 , I am studying the changes.

mkgrgis avatar Oct 05 '23 03:10 mkgrgis

@vaibhavdalvi93, SQL indent in Examples in case of CREATE SERVER + CREATE USER MAPPING FOR + CREATE FOREIGN TABLE is common tradition for https://github.com/pgspider/influxdb_fdw#examples , https://github.com/pgspider/sqlite_fdw#examples , and https://github.com/pgspider/griddb_fdw#examples etc. There is no such tradition for UPDATE or DELETE commands. What will better for our README.md? Could you please comment directly in https://github.com/EnterpriseDB/mongo_fdw/pull/168/files (select a line of code and write a question or review)?

Note: I have viewed your patch during https://github.com/mkgrgis/mongo_fdw/commit/92280f51cbfde2500cd68ce0d85dbc2ca18ca07f

mkgrgis avatar Oct 05 '23 04:10 mkgrgis

@mkgrgis , Thanks for your comment on v2 patch provided by me.

Could you please comment directly in https://github.com/EnterpriseDB/mongo_fdw/pull/168/files (select a line of code and write a question or review)?

As there are quite more changes I have done in my patch, I am not finding myself comfortable pointing or commenting out each change directly on files. Do you have any other comment than below one on patch [v2-Refactor-README.md-for-PGXN.txt]? If yes, could you please share here otherwise I will make it ready for committer after doing some more changes.

SQL indent in Examples in case of CREATE SERVER + CREATE USER MAPPING FOR + CREATE FOREIGN TABLE is common tradition for https://github.com/pgspider/influxdb_fdw#examples , https://github.com/pgspider/sqlite_fdw#examples , and https://github.com/pgspider/griddb_fdw#examples etc. There is no such tradition for UPDATE or DELETE commands.

Thanks.

vaibhavdalvi93 avatar Dec 11 '23 04:12 vaibhavdalvi93

I am not finding myself comfortable pointing or commenting out each change directly on files.

No problem, @vaibhavdalvi93 ! Unfortunately in your previous message "patch" is not URL for downloading. If you are about this version https://github.com/EnterpriseDB/mongo_fdw/files/12802661/v2-Refactor-README.md-for-PGXN.txt , I have no other comments. You can discuss this patch with commiter. Anyway I can open new PR after this if there will be some new README.md improvements.

mkgrgis avatar Dec 11 '23 15:12 mkgrgis

Okay. Thank you for your response. I will take it further to the commiter. Thanks, again.

vaibhavdalvi93 avatar Dec 12 '23 06:12 vaibhavdalvi93

Thanks, @vaibhavdalvi93! Could you please begin 2nd round of review? I have seen small differences between our branches and propose a changes.

mkgrgis avatar Jan 17 '24 13:01 mkgrgis