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

Update description for -es flag to make more sense to a novice user #125

Open
jordanpadams opened this issue Dec 31, 2024 · 3 comments · May be fixed by #129
Open

Update description for -es flag to make more sense to a novice user #125

jordanpadams opened this issue Dec 31, 2024 · 3 comments · May be fixed by #129

Comments

@jordanpadams
Copy link
Member

jordanpadams commented Dec 31, 2024

💡 Description

The current help information doesn't really make any sense:

-es <url>         Elasticsearch URL. Default is app:/connections/direct/localhost.xml

If this is supposed to be the XML config file, then let's just say that. I know there are ways around this using different URIs, but this does not make any sense to most people.

While making this update, let's clean up anything in the output run logs that says "Elasticsearch URL" and replace it with something more meaningful to an end user. "OpenSearch Config Path", "OpenSearch Config URI", etc.

⚔️ Parent Epic / Related Tickets

No response

@al-niessner
Copy link
Contributor

al-niessner commented Jan 2, 2025

@jordanpadams

What is says is semi accurate and precise. If you wish different text, then tell me what text you want it to say.

Should also change -es too as part of cleanup. Give me a list of old/new and we can change them all.

@jordanpadams
Copy link
Member Author

@al-niessner

Old:

-es <url>         Elasticsearch URL. Default is app:/connections/direct/localhost.xml

New:

-es <uri>         File URI to the configuration to connect to the OpenSearch Registry. For example, file:///home/user/.pds/mcp.xml. Default is app:/connections/direct/localhost.xml

Let's keep it -es because I don't think it is worth introducing a backwards incompatible change. If we really want to button this up, then:

-es <uri>         (deprecated) File URI to the configuration to connect to the OpenSearch Registry. For example, file:///home/user/.pds/mcp.xml. Default is app:/connections/direct/localhost.xml

-registry <uri>         (deprecated) File URI to the configuration to connect to the OpenSearch Registry. For example, file:///home/user/.pds/mcp.xml. Default is app:/connections/direct/localhost.xml

@tloubrieu-jpl thoughts?

@tloubrieu-jpl
Copy link
Member

Hi @jordanpadams , @al-niessner ,

I am good with option 2 with both -es and -registry (not deprecated though, compared to Jordan's comment above). I like the -registry because we could think of enriching the xml connection file, adding other databases (e.g. graphDB, ...) that harvest would update, if that is a route we want to take.

@al-niessner al-niessner linked a pull request Jan 14, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ToDo
Development

Successfully merging a pull request may close this issue.

3 participants