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

[DOC] Update the CONVENTIONS.md with solid guidance of plugin naming convention #200

Closed
ruanyl opened this issue Feb 10, 2023 · 3 comments
Closed
Labels
documentation Improvements or additions to documentation enhancement New feature or request untriaged

Comments

@ruanyl
Copy link
Member

ruanyl commented Feb 10, 2023

For the team that is new to the plugin development, the current documentation of repo name and package name naming convention is a bit unclear.

It would be nice to add clarifications on the naming conventions of:

  1. GitHub repo name of OpenSearch/OpenSearch-Dashboards plugin
  2. Package name of OpenSearch-Dashboards plugin (name in package.json)
@ruanyl ruanyl added enhancement New feature or request untriaged labels Feb 10, 2023
@joshuarrrr joshuarrrr added the documentation Improvements or additions to documentation label Feb 10, 2023
@dblock
Copy link
Member

dblock commented Feb 13, 2023

👍 please help contribute a PR! you might find #174 relevant

@ruanyl
Copy link
Member Author

ruanyl commented Feb 14, 2023

Hi @dblock @joshuarrrr, drafting a PR for it #204

Based on the current documentation and my observations, the dashboard plugin repo name should have prefix dashboards, however, the plugin name and id generally have dashboards as suffix. Do you see this as misalignment due to historical reason or was it by intention?

@dblock
Copy link
Member

dblock commented Feb 15, 2023

Resolved via #204

@dblock dblock closed this as completed Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request untriaged
Projects
None yet
Development

No branches or pull requests

3 participants