Refactor README.md #54

mkgrgis · 2023-01-02T15:12:23Z

By https://github.com/ibarwick/firebird_fdw/blob/master/README.md example of advanced FDW documentation

t-kataym · 2023-01-17T01:46:18Z

Thank you for the pull request.
I found there are 2 types of update in the pull request.

One is the addition of useful information. It is grateful and we would like to take it in.
Another is the movement of description. The updated format is inconsistent with the other modules in our PGSpider project. We need to consider what format should be for our project.

Therefore, we would like to apply the 1st one.
Could you create a pull request for it?

mkgrgis · 2023-01-17T14:27:29Z

The updated format is inconsistent with the other modules in our PGSpider project. We need to consider what format should be for our project.

@t-kataym, what about my PRs with refactoring of this files step-by-step ?

https://github.com/pgspider/jdbc_fdw/blob/main/README.md
https://github.com/pgspider/influxdb_fdw/blob/master/README.md
https://github.com/pgspider/dynamodb_fdw/blob/main/README.md
https://github.com/pgspider/parquet_s3_fdw/blob/main/README.md
https://github.com/pgspider/griddb_fdw/blob/master/README.md

https://github.com/EnterpriseDB/mongo_fdw/blob/master/README.md
https://github.com/EnterpriseDB/mysql_fdw/blob/master/README.md

What about merging of this PR after it will be completed other PRs?

t-kataym · 2023-01-18T08:54:54Z

Thank you for your proposal.
We need to consider what is ideal format because we may get another Pull Request in the future.

Is there standard format as Readme of FDW?

Could you tell me the reason why you referred firebird_fdw as an example?

mkgrgis · 2023-01-18T16:30:56Z

Is there standard format as Readme of FDW?

I think no. There is only more or less detailed READMEs. For ex. mysql_fdw and oracle_fdw is very popular, but only README by @laurenz for the last is well-structured.

Could you tell me the reason why you referred firebird_fdw as an example?

Order of topics look like natural : Features (do we need?), Supported platforms (cat it run on?), Installation (how to install?), Usage (quick start), Functions (additional features), technical details (Identifier case handling, Generated columns, Character set handling) etc., Limitations, ... Development roadmap, Useful links.
README of firebird_fdw is more detailed than other (except https://github.com/laurenz/oracle_fdw/blob/master/README.oracle_fdw ) and completed.

t-kataym · 2023-01-20T08:54:06Z

Thank you for your response.

What about merging of this PR after it will be completed other PRs?
Yes, I agree with you.

Following modules are original of PGSpider project (or upstream project is no longer maintained).

Could you create PRs of above FDWs?
Once they are completed, then I would like to merge this PR.

Following modules are forked from upstream project.
If the upstream is updated, it will be taken in our project.
I hope you to try to create PRs for upstream projects.

PGSpider project	Upstream
https://github.com/pgspider/odbc_fdw	https://github.com/CartoDB/odbc_fdw
https://github.com/pgspider/oracle_fdw	https://github.com/laurenz/oracle_fdw
https://github.com/pgspider/parquet_s3_fdw	https://github.com/adjust/parquet_fdw
https://github.com/pgspider/mongo_fdw	https://github.com/EnterpriseDB/mongo_fdw
https://github.com/pgspider/mysql_fdw	https://github.com/EnterpriseDB/mysql_fdw

mkgrgis · 2023-01-20T11:13:45Z

pgspider/jdbc_fdw#14 done.

https://github.com/pgspider/pgspider_ext is an independent extension, not a foreign data wrapper, but

an extension to construct High-Performance SQL Cluster Engine for distributed big data

fdw documentation example isn't applicable to https://github.com/pgspider/pgspider_ext.

Features - Install - Usage yet structured.

mkgrgis · 2023-01-20T14:53:34Z

pgspider/griddb_fdw#37 done

mkgrgis · 2023-01-20T16:03:28Z

pgspider/dynamodb_fdw#5 done

mkgrgis · 2023-01-20T17:19:58Z

pgspider/influxdb_fdw#35 done. All PR need carefully reading.

mkgrgis · 2023-01-20T19:55:40Z

EnterpriseDB/mysql_fdw#262 done, it seems this repository isn't very active https://github.com/EnterpriseDB/mysql_fdw/pulls.

mkgrgis · 2023-01-21T07:31:08Z

CartoDB/odbc_fdw#139 done

mkgrgis · 2023-01-21T08:25:19Z

adjust/parquet_fdw#64 done

mkgrgis · 2023-01-21T10:53:44Z

EnterpriseDB/mongo_fdw#165 done. All PRs has been made. https://github.com/laurenz/oracle_fdw have got well-structured documentation now. I think no need refactoring just now, but it will be reason if all other PRs will merged, because README from firebird_fdw will be standard de facto.

t-kataym · 2023-01-25T08:24:18Z

Thank you for creating PRs. I will confirm the PR of sqlite_fdw.

By https://github.com/ibarwick/firebird_fdw/blob/master/README.md example of advanced FDW documentation. Add about functions, encodings, identifiers, FDW options and types of options, refactor features, notes and limitations.

t-kataym

I confirmed the PR. Could you confirm my comments?

README.md

Thanks to https://github.com/t-kataym (author of review) pgspider#54 (review)

mkgrgis · 2023-01-30T06:22:47Z

I confirmed the PR. Could you confirm my comments?

Please verify if all is OK or not.

son-phamngoc

I have some comments. Please help me to check them.

README.md

Thanks to https://github.com/son-phamngoc

Add about OS permissions

mkgrgis · 2023-02-05T16:18:39Z

@t-kataym, I decided to stop the changes in README.md. This PR is very complicated because I still not work with git very well. Since this time I'll save a new changes in README.md for other PR.

README.md

t-kataym · 2023-02-06T04:49:21Z

@mkgrgis Thank you for your update.

I decided to stop the changes in README.md ... Since this time I'll save a new changes in README.md for other PR.
Yes, please modify the file for only a fix based on review comment,
and modify new changes (which is not related to review comment) as another PR.

It is unnecessary to squash commits to one.

mkgrgis · 2023-02-06T07:54:43Z

It is unnecessary to squash commits to one.

Look like this sentence is for "Contributing" in README.md ;-)

mkgrgis · 2023-02-07T03:42:35Z

All problems are fixed, @t-kataym

t-kataym · 2023-02-08T01:23:44Z

@mkgrgis Thank you so much for your PR. I will merge it.

mkgrgis · 2023-02-08T02:56:49Z

Thank you for your reviews, @t-kataym !

mkgrgis · 2023-04-01T09:36:44Z

@t-kataym , what about my README patches to dynamodb_fdw and influxdb_fdw ? I can parallelly improve documentation and test changes in other pull requests.

t-kataym · 2023-04-03T00:56:12Z

@mkgrgis , we are sorry for no reply. I ask contact persons.

mkgrgis · 2023-05-06T08:07:16Z

@t-kataym , still no reaction around of https://github.com/pgspider/influxdb_fdw/pull/37/files
In sqlite_fdw is usefully addition to README.md without reaction too https://github.com/pgspider/sqlite_fdw/pull/70/files
Also I'll resolve conflicts in pgspider/jdbc_fdw#14 and actualise this PR to pgspider original documentation.

t-kataym · 2023-05-08T05:03:34Z

@t-kataym , still no reaction around of https://github.com/pgspider/influxdb_fdw/pull/37/files
In sqlite_fdw is usefully addition to README.md without reaction too https://github.com/pgspider/sqlite_fdw/pull/70/files

We are so sorry for no response.
For influxdb_fdw, I contacted to and asked the maintainer weiting1lee to response it, and assigned him as Reviewers of the PR.
For sqlite_fdw PR#70, Thank you for letting me know. I missed it and will confirm it.

Also I'll resolve conflicts in pgspider/jdbc_fdw#14 and actualise this PR to pgspider original documentation.

Yes, thank you for your contribution.

mkgrgis · 2023-05-13T08:53:38Z

@t-kataym , I saw there is no topic tags in pgspider repositories. I think it's bad and owners of repositories can add this tags. This tags can improve thematic github searching for a new contributors and gives some PRs. See good example of tags in https://github.com/ibarwick/firebird_fdw

mkgrgis · 2023-05-13T12:08:29Z

@t-kataym , what about auto RPM build during https://github.com/pgspider/sqlite_fdw/pull/39/files ? I think it will be usefully not only for for PGXN https://pgxn.org/tag/fdw/

t-kataym · 2023-05-15T05:47:22Z

@mkgrgis Thank you for your advice and notification.

We will consider to set topics and confirm the PR#39.

mkgrgis · 2023-05-26T11:42:45Z

@t-kataym , what is the difference between https://github.com/adjust/parquet_fdw and https://github.com/pgspider/parquet_s3_fdw ? Repository from "adjust" tree look like slow-refreshed, but not deprecated. My README PR comes to adjust/parquet_fdw#64 but not to https://github.com/pgspider/parquet_s3_fdw , is it normal? Should I create PR with README to pgspider version of parquet_fdw?

mkgrgis · 2024-01-31T11:41:44Z

@t-kataym , look like https://github.com/pgspider/parquet_s3_fdw is completely independent fork of https://github.com/adjust/parquet_fdw and Ajust GmbH does not support initial FDW very good (see adjust/parquet_fdw#64 ).

Does it means I can write a new PR directly to https://github.com/pgspider/parquet_s3_fdw ? This FDW is only with old README.

mkgrgis mentioned this pull request Jan 4, 2023

Missing license #53

Closed

t-kataym assigned mkgrgis Jan 17, 2023

mkgrgis force-pushed the patch-1 branch from 1aa6200 to 1902a2b Compare January 26, 2023 16:16

mkgrgis closed this Jan 27, 2023

mkgrgis force-pushed the patch-1 branch from 6a98999 to 31133bd Compare January 27, 2023 15:40

Refactor README.md

c45dade

By https://github.com/ibarwick/firebird_fdw/blob/master/README.md example of advanced FDW documentation. Add about functions, encodings, identifiers, FDW options and types of options, refactor features, notes and limitations.

mkgrgis reopened this Jan 27, 2023

t-kataym requested changes Jan 30, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

mkgrgis added 2 commits January 30, 2023 09:20

Update README.md by PR-review

f4d6fb4

Thanks to https://github.com/t-kataym (author of review) pgspider#54 (review)

README.md pg versions fix

a8b3050

mkgrgis added 2 commits January 30, 2023 10:00

REDME.md fix indent

3d24ec9

README.md fix SQL indent

39ba546

son-phamngoc suggested changes Jan 30, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

mkgrgis added 2 commits January 30, 2023 10:25

Add about tests

25c24c6

Fix README.md by review

1dc10cc

Thanks to https://github.com/son-phamngoc

mkgrgis reopened this Feb 4, 2023

mkgrgis added 2 commits February 4, 2023 23:31

README.md

d0d0471

Add about OS permissions

Fix README.md

dbaacc5

mkgrgis force-pushed the patch-1 branch from ba78270 to dbaacc5 Compare February 5, 2023 16:13

t-kataym requested changes Feb 6, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

mkgrgis added 4 commits February 6, 2023 08:31

CHANGELOG Add some history points

6112b4e

README.md, by review

3cafb2f

Delete CHANGELOG

4fe3a02

Remove CHANGELOG

9cd90f8

mkgrgis requested a review from t-kataym February 6, 2023 08:04

mkgrgis added 2 commits February 7, 2023 06:33

Fix about NaN, +Infinity and -Infinity

4154f2d

Fix about special values

b6e8660

t-kataym approved these changes Feb 8, 2023

View reviewed changes

t-kataym merged commit 8847933 into pgspider:master Feb 8, 2023

mkgrgis deleted the patch-1 branch February 8, 2023 02:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor README.md #54

Refactor README.md #54

mkgrgis commented Jan 2, 2023

t-kataym commented Jan 17, 2023

mkgrgis commented Jan 17, 2023

t-kataym commented Jan 18, 2023

mkgrgis commented Jan 18, 2023 •

edited

Loading

t-kataym commented Jan 20, 2023

mkgrgis commented Jan 20, 2023 •

edited

Loading

mkgrgis commented Jan 20, 2023

mkgrgis commented Jan 20, 2023

mkgrgis commented Jan 20, 2023

mkgrgis commented Jan 20, 2023 •

edited

Loading

mkgrgis commented Jan 21, 2023

mkgrgis commented Jan 21, 2023

mkgrgis commented Jan 21, 2023

t-kataym commented Jan 25, 2023

t-kataym left a comment

mkgrgis commented Jan 30, 2023

son-phamngoc left a comment

mkgrgis commented Feb 5, 2023

t-kataym commented Feb 6, 2023

mkgrgis commented Feb 6, 2023

mkgrgis commented Feb 7, 2023

t-kataym commented Feb 8, 2023

mkgrgis commented Feb 8, 2023

mkgrgis commented Apr 1, 2023 •

edited

Loading

t-kataym commented Apr 3, 2023

mkgrgis commented May 6, 2023

t-kataym commented May 8, 2023

mkgrgis commented May 13, 2023

mkgrgis commented May 13, 2023

t-kataym commented May 15, 2023

mkgrgis commented May 26, 2023

mkgrgis commented Jan 31, 2024

Refactor README.md #54

Refactor README.md #54

Conversation

mkgrgis commented Jan 2, 2023

t-kataym commented Jan 17, 2023

mkgrgis commented Jan 17, 2023

t-kataym commented Jan 18, 2023

mkgrgis commented Jan 18, 2023 • edited Loading

t-kataym commented Jan 20, 2023

mkgrgis commented Jan 20, 2023 • edited Loading

mkgrgis commented Jan 20, 2023

mkgrgis commented Jan 20, 2023

mkgrgis commented Jan 20, 2023

mkgrgis commented Jan 20, 2023 • edited Loading

mkgrgis commented Jan 21, 2023

mkgrgis commented Jan 21, 2023

mkgrgis commented Jan 21, 2023

t-kataym commented Jan 25, 2023

t-kataym left a comment

Choose a reason for hiding this comment

mkgrgis commented Jan 30, 2023

son-phamngoc left a comment

Choose a reason for hiding this comment

mkgrgis commented Feb 5, 2023

t-kataym commented Feb 6, 2023

mkgrgis commented Feb 6, 2023

mkgrgis commented Feb 7, 2023

t-kataym commented Feb 8, 2023

mkgrgis commented Feb 8, 2023

mkgrgis commented Apr 1, 2023 • edited Loading

t-kataym commented Apr 3, 2023

mkgrgis commented May 6, 2023

t-kataym commented May 8, 2023

mkgrgis commented May 13, 2023

mkgrgis commented May 13, 2023

t-kataym commented May 15, 2023

mkgrgis commented May 26, 2023

mkgrgis commented Jan 31, 2024

mkgrgis commented Jan 18, 2023 •

edited

Loading

mkgrgis commented Jan 20, 2023 •

edited

Loading

mkgrgis commented Jan 20, 2023 •

edited

Loading

mkgrgis commented Apr 1, 2023 •

edited

Loading