[Backport 2.x] docs(DEVELOPER_GUIDE): Make getting started comprehensive and reorganize #3499
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![opensearch-trigger-bot[bot]](https://avatars.githubusercontent.com/u/80134844?s=60&v=4){kind=small}
…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
kavilla
added
the
Skip-Changelog
kavilla
approved these changes
Feb 27, 2023
manasvinibs
approved these changes
Feb 27, 2023
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-1.x 1.x
# Navigate to the new working tree
pushd ../.worktrees/backport-1.x
# Create a new branch
git switch --create backport/backport-3499-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 b4427df634f49f2198c04469ff242b5fae6d1d1e
# Push it to GitHub
git push --set-upstream origin backport/backport-3499-to-1.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.xThen, create a pull request where the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport 5af9a43 from #3421.