search

opensearch-project / security-dashboards-plugin

🔐 Manage your internal users, roles, access control, and audit logs from OpenSearch Dashboards
https://opensearch.org/docs/latest/security-plugin/index/
Apache License 2.0
71 stars 158 forks source link

[BUG] Repo name doesn't adhere to plugins naming convention #1232

Open mnkugler opened 1 year ago

mnkugler commented 1 year ago

This repo is named "security-dashboards-plugin"

As per https://github.com/opensearch-project/opensearch-plugins/blob/main/CONVENTIONS.md#opensearch-plugins, the repo name should not include the word "plugin", and the name should be prefixed with "dashboards-".

Referred to here: https://github.com/opensearch-project/opensearch-plugins/issues/174

mnkugler commented 1 year ago

Hi, I wanted to follow-up on this issue. Can someone provide a status update?

davidlago commented 1 year ago

Hi @mnkugler! We have not yet dedicated time to look into this one.

@RyanL1997 could you please take a look at a rough level of effort for this rename? are we talking about a few hours of search-replace work, or is this more involved?

If it turns out to not be too bad, we can try to slot in as time permits so that it goes in by 3.0. If on the other hand this is a non-trivial change, we can bring this back and have the discussion with the teams for whether the "juice is worth the squeeze" for existing plugins, or we could potentially grandfather them in.

RyanL1997 commented 1 year ago

Hi @mnkugler, thanks for follow this up. I just had a rough look and it seems like this one is not too bad for renaming. However, question from my side is that if we rename this one should we also rename the other associated directory such as in functional test repo? In generally, I agree with @davidlago. Since we don't have enough bandwidth for now, we can try to make that into 3.0.

davidlago commented 1 year ago

Thanks for the quick turnaround, @RyanL1997! For consistency's sake, I think it makes sense to rename the functional test repo as well (plus of course make the appropriate changes there after the rename of the plugin itself).

Do you have a high level bullet list of all the places we will have to change with this rename? not looking for the places in the code, but more at a high level like 1/ file names 2/ code references 3/ build/CI scripts 4/ functional testing repo...