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

[Backport 1.3] [Manual Backport 1.x] docs(DEVELOPER_GUIDE): Make getting started comprehensive and reorgan… #3564

Merged
merged 1 commit into from
Mar 8, 2023

Conversation

opensearch-trigger-bot[bot]
Copy link
Contributor

Backport 905b714 from #3562.

…ize (#3421) (#3562)

* docs(DEVELOPER_GUIDE): Make getting started comprehensive and reorganize

Enhance getting started guide for new contributors
- Add key technology breakdown with links to code guidelines
- Add robust prerequisite guide
- Clarify forking workflow
- Explain bootstrapping
- Distinguish between recommended and optional/alternative steps
- Add OS-specific guidance
- Add tarball usage instructions

Make other developer guide improvements:
- Update TOC
- Remove callout linking to EUI docs
- Reorder code guidelines
- Standardize header capitalization and make usage guide headers imperative

fixes #3396

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: Miki <amoo_miki@yahoo.com>
(cherry picked from commit 5af9a43)
(cherry picked from commit 905b714)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@joshuarrrr joshuarrrr added v1.3.9 autocut Skip the changelog verification check on backports labels Mar 8, 2023
@joshuarrrr
Copy link
Member

ignoring failed whitesource check

@joshuarrrr joshuarrrr merged commit 9344b10 into 1.3 Mar 8, 2023
@joshuarrrr joshuarrrr deleted the backport/backport-3562-to-1.3 branch March 8, 2023 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autocut Skip the changelog verification check on backports v1.3.9
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants