search

opensearch-project / opensearch-oci-object-storage

OpenSearch Repository Plugin For Oci Object Storage
Apache License 2.0
7 stars 19 forks source link

[FEATURE] Separate `README.md` to a user and developer guide #46

Open samuel-oci opened 1 year ago

samuel-oci commented 1 year ago

Is your feature request related to a problem?

Currently there is a single README.md file that contains both info for developers and users. It is recommended to have a separate more in-depth developer guide that will focus on debugging/development guidelines and separate from the mostly user oriented documentation currently in the README.

What solution would you like?

Add a DEVELOPER.md in addition to README.md content and move developer guidelines to DEVELOPER.md

What alternatives have you considered?

none

dblock commented 3 months ago

[Triage -- attendees 1, 2, 3, 4, 5, 6, 7]

Good suggestion, want to take a stab at this @samuel-oci?