Skip to content

Commit

Permalink
docs(DEVELOPER_GUIDE): Make getting started comprehensive and reorgan…
Browse files Browse the repository at this point in the history
…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>
  • Loading branch information
joshuarrrr and AMoo-Miki authored Feb 25, 2023
1 parent 5176187 commit 5af9a43
Show file tree
Hide file tree
Showing 2 changed files with 283 additions and 138 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- [Doc] Add readme for global query persistence ([#3001](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3001))
- Updates NOTICE file, adds validation to GitHub CI ([#3051](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3051))
- [Doc] Add current plugin persistence implementation readme ([#3081](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3081))
- [Doc] Improve DEVELOPER_GUIDE to make first time setup quicker and easier ([#3421](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3421))
- Correct copyright date range of NOTICE file and notice generator ([#3308](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3308))

### 🛠 Maintenance
Expand Down
Loading

0 comments on commit 5af9a43

Please sign in to comment.