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

[FEATURE] Document custom folders #756

Closed
dblock opened this issue Jul 5, 2022 · 10 comments
Closed

[FEATURE] Document custom folders #756

dblock opened this issue Jul 5, 2022 · 10 comments
Assignees
Labels
Closed - Duplicate or Cancelled Issue: Nothing to be done
Milestone

Comments

@dblock
Copy link
Member

dblock commented Jul 5, 2022

Is your feature request related to a problem?

Document changes in opensearch-project/OpenSearch#848

@dblock dblock added enhancement New feature or request untriaged labels Jul 5, 2022
@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started configuration and removed untriaged enhancement New feature or request labels Jul 11, 2022
@Naarcha-AWS Naarcha-AWS added this to the 2022-Q3 milestone Jul 11, 2022
@JeffHuss JeffHuss self-assigned this Aug 16, 2022
@JeffHuss
Copy link

Taking a look at this.

@JeffHuss JeffHuss assigned JeffHuss and unassigned JeffHuss Aug 16, 2022
@JeffHuss JeffHuss added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Aug 16, 2022
@JeffHuss
Copy link

Seeking feedback on where this would live and how it should be covered. Based on my understanding of the related PR (from the core product) this sounds like guidance for plugin developers rather than OpenSearch users. Bearing that in mind I'm not quite sure where this would go.

@JeffHuss
Copy link

In the original issue (opensearch-project/OpenSearch#686) the developer stated that they would work on documentation. In addition to pinging dblock I've also pinged the developer to see what I can learn.

@JeffHuss
Copy link

@dblock

@dblock
Copy link
Member Author

dblock commented Aug 16, 2022

@VachaShah see @JeffH-AWS's questions above

@VachaShah
Copy link
Contributor

I think the documentation was added in this commit opensearch-project/opensearch-plugins@d0c019c, the file has changed over time.

I think this would go in a place where we have user documentation for plugins in general - https://opensearch.org/docs/latest/opensearch/install/plugins/. This looks to be a nice place to add documentation for building custom plugins or modify the plugin-descriptor file to add custom folder name and then install/remove using the custom folder name.

@JeffHuss
Copy link

@VachaShah can you please link me to the design doc for this? How does an OpenSearch user interact with this setting?

@JeffHuss JeffHuss added Needs SME Waiting on input from subject matter expert 1 - Backlog Issue: The issue is unassigned or assigned but not started and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Aug 17, 2022
@JeffHuss
Copy link

Putting this ticket on the backlog again pending follow-up from someone familiar with the functionality.

@JeffHuss
Copy link

Reached out to Vacha again.

@JeffHuss
Copy link

JeffHuss commented Oct 3, 2022

I still have not gotten any engagement from Vacha.

Based on re-reviewing the content in the linked commit, this does not seem to belong in the OpenSearch user documentation. These steps seem to be pretty clearly aimed at developers who are customizing or altogether building plugins. The references to changes include Java classes which are not relevant to the operation or use of OpenSearch.

If I'm misunderstanding something please feel free to raise a new issue. At a bare minimum, the issue should include:

  • A description of the feature - what does it do?
  • Relevancy - why would someone use it?
  • Who is the target audience?
  • Usage details - how would someone use it?
  • Notes including detailed steps on how to enable the feature and verify that it is working as expected

@JeffHuss JeffHuss closed this as completed Oct 3, 2022
@JeffHuss JeffHuss removed 1 - Backlog Issue: The issue is unassigned or assigned but not started configuration Needs SME Waiting on input from subject matter expert labels Oct 3, 2022
@JeffHuss JeffHuss added the Closed - Duplicate or Cancelled Issue: Nothing to be done label Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed - Duplicate or Cancelled Issue: Nothing to be done
Projects
None yet
Development

No branches or pull requests

4 participants