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

Config Name Is Incorrect For Data Source In Documentation #189

Closed
truly-indian opened this issue Jun 21, 2024 · 5 comments · Fixed by dekart-xyz/www#35 · May be fixed by #190
Closed

Config Name Is Incorrect For Data Source In Documentation #189

truly-indian opened this issue Jun 21, 2024 · 5 comments · Fixed by dekart-xyz/www#35 · May be fixed by #190

Comments

@truly-indian
Copy link

The name of the config is incorrect in the documentation if you want to provide PG Data source. We should fix the name in the documentation.

@truly-indian truly-indian changed the title Config Name In Correct For Data Source In Documentation Config Name Is Incorrect For Data Source In Documentation Jun 21, 2024
@Tsovak
Copy link
Contributor

Tsovak commented Jun 21, 2024

hello @truly-indian , thanks for opening issue.
we have Dekart database for storing metadata and DEKART_POSTGRES_DATA_CONNECTION to manage only data to visualize.
what do you mean it is incorrect?
as I understood, you want to extend the name from DEKART_POSTGRES_DATA_CONNECTION to DEKART_POSTGRES_DATASOURCE_CONNECTION

@truly-indian
Copy link
Author

@Tsovak As you mentioned you have DEKART_POSTGRES_DATA_CONNECTION to manage only data to visualize. What I am saying is that in the code where you are connecting to PG you are using the config name as DEKART_POSTGRES_DATASOURCE_CONNECTION and in the documentation you are stating the config to be used as DEKART_POSTGRES_DATA_CONNECTION which is misleading and wasting a lot of developer time.

Please refer this line of code. The config name used here for pg connection is wrongly mentioned in the documentation.

dbConnStr := os.Getenv("DEKART_POSTGRES_DATASOURCE_CONNECTION")

@Tsovak
Copy link
Contributor

Tsovak commented Jun 22, 2024

@Tsovak As you mentioned you have DEKART_POSTGRES_DATA_CONNECTION to manage only data to visualize. What I am saying is that in the code where you are connecting to PG you are using the config name as DEKART_POSTGRES_DATASOURCE_CONNECTION and in the documentation you are stating the config to be used as DEKART_POSTGRES_DATA_CONNECTION which is misleading and wasting a lot of developer time.

Please refer this line of code. The config name used here for pg connection is wrongly mentioned in the documentation.

dbConnStr := os.Getenv("DEKART_POSTGRES_DATASOURCE_CONNECTION")

I see. It's my mistake.
In the code, it calls DATASOURCE_CONNECTION in the env variable called DATA_CONNECTION in documentation as well.

it should be called DATASOURCE to keep a naming convention consistent with other parts of the project.
Thanks a lot for contributing to the project.

@Tsovak
Copy link
Contributor

Tsovak commented Jun 22, 2024

the related PR opened to fix the documentation dekart-xyz/www#35

@delfrrr
Copy link
Contributor

delfrrr commented Jun 24, 2024

Great, merged doc PR, thank @Tsovak , @truly-indian

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

Successfully merging a pull request may close this issue.

3 participants