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 2.6] docs(DEVELOPER_GUIDE): Make getting started comprehensive and reorganize #3575

Merged
merged 1 commit into from
Mar 9, 2023

Conversation

opensearch-trigger-bot[bot]
Copy link
Contributor

Backport 5af9a43 from #3421.

…ize (#3421)

* 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)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md
@opensearch-trigger-bot opensearch-trigger-bot bot requested a review from a team as a code owner March 9, 2023 21:05
@kavilla kavilla added the Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry label Mar 9, 2023
@AMoo-Miki AMoo-Miki added autocut Skip the changelog verification check on backports and removed Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry labels Mar 9, 2023
@joshuarrrr
Copy link
Member

ignoring failed whitesource check for docs only change.

@joshuarrrr joshuarrrr merged commit 8af38e6 into 2.6 Mar 9, 2023
@joshuarrrr joshuarrrr deleted the backport/backport-3421-to-2.6 branch March 9, 2023 21:47
@joshuarrrr joshuarrrr added the not in release PRs backported to already shipped releases with no future release planned label Mar 10, 2023
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 not in release PRs backported to already shipped releases with no future release planned
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants