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

Remove example configuration file #2422

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

brfrn169
Copy link
Collaborator

Description

This PR removes the example configuration file (conf/database.properties) because I don’t think we need to keep it for now. If anyone has any objections, I will close this PR.

Related issues and/or PRs

N/A

Changes made

  • Removed the example configuration file (conf/database.properties).

Checklist

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • Tests (unit, integration, etc.) have been added for the changes.
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

Release notes

N/A

Copy link
Contributor

@komamitsu komamitsu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

Copy link
Contributor

@Torch3333 Torch3333 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

@brfrn169 brfrn169 requested a review from josh-wong December 22, 2024 09:39
Copy link
Member

@josh-wong josh-wong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This conf/database.properties file is linked to in the following docs:

To avoid accidentally creating broken links, how about we delete the sentence For a sample properties file, see [`database.properties`](https://github.com/scalar-labs/scalardb/blob/master/conf/database.properties).?

@brfrn169
Copy link
Collaborator Author

This conf/database.properties file is linked to in the following docs:

@josh-wong Thank you for pointing that out! I didn't know the sample configuration file was referenced in some documents.

To avoid accidentally creating broken links, how about we delete the sentence For a sample properties file, see [`database.properties`](https://github.com/scalar-labs/scalardb/blob/master/conf/database.properties).?

Or, can we have the sample configuration file in the doc site?

@brfrn169 brfrn169 requested a review from josh-wong December 23, 2024 05:21
@josh-wong
Copy link
Member

@brfrn169

Or, can we have the sample configuration file in the doc site?

Actually, how about if we change the link to the database.properties file that exists in the scalardb-samples repository? That way, users can see the code nicely formatted in GitHub rather than as plaintext:

I think we have some docs that point to that properties file also.

Copy link
Contributor

@feeblefakie feeblefakie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you!

@feeblefakie
Copy link
Contributor

@josh-wong The database.properites deleted in this PR is different from the database.properties you mentioned.

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

Successfully merging this pull request may close these issues.

5 participants