feat: add a link to the developer guide

[closingin]

Signed-off-by: closingin [email protected]

Description

As discussed in this forum thread, we need to add documentation about the required configuration changes when running a development OpenSearch Dashboards on a dockerized OpenSearch, this PR adds it! 🙂

Issues Resolved

N/A

Check List

• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[dblock]

Should we put this into https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md instead?

[closingin]

I actually thought about it, but I feel like the developer guide is more about coding style than setting up your environment. I also instinctively went to the documentation when I was searching for this information, so I ended up writing it there.

Tell me 🙂

[dblock]

I actually thought about it, but I feel like the developer guide is more about coding style than setting up your environment. I also instinctively went to the documentation when I was searching for this information, so I ended up writing it there.

Tell me 🙂

Traditionally we want to keep dev docs closer to the code, so I'd prefer this to be in the developer guide, which should have a clear getting started. This would also match what we do in OpenSearch engine.

We can/should link the source from the public documentation and help developers find it.

WDYT?

[closingin]

I guess I could port the changes to the developer guides, and maybe add a link to it in the "External links" section of the documentation ? Like just "Developer Guide".

[dblock]

I guess I could port the changes to the developer guides, and maybe add a link to it in the "External links" section of the documentation ? Like just "Developer Guide".

That sounds good!

[closingin]

Hello @dblock, I opened the PR in OSD's repo. I'll wait for it to be accepted before making changes to this PR 🙂

[closingin]

Hey there. As #710 has been merged, I updated this PR to just link to the developer guide, instead of putting its content directly in the docs!

[aetter]

Hey @closingin, I'm going to merge this and tweak a couple things in a subsequent commit, since I think we want to be specific that it's the "Dashboards developer guide" rather than just "Developer Guide." Thanks a bunch!

[closingin]

You're definitely right @aetter , I didn't even think about it! Thanks for the merge.