Subham-KRLX opened a new pull request, #2114: URL: https://github.com/apache/sedona/pull/2114
This PR introduces a new documentation page, 'docs/community/vscode-development-guide.md', detailing the steps to set up Apache Sedona for development in VSCode. It covers environment prerequisites, recommended VSCode extensions, project import, building with Maven, and running tests. This aims to streamline the developer onboarding process for VSCode users and addresses the request in issue #1742. ## Did you read the Contributor Guide? - [x] Yes, I have read the [Contributor Rules](https://sedona.apache.org/latest/community/rule/) and [Contributor Development Guide](https://sedona.apache.org/latest/community/develop/) - [ ] No, I haven't read it. ## Is this PR related to a ticket? - [ ] Yes, and the PR name follows the format `[SEDONA-XXX] my subject`. - [x] Yes, and the PR name follows the format `[GH-XXX] my subject`. Closes #1742 - [ ] No: - [ ] this is a documentation update. The PR name follows the format `[DOCS] my subject` - [ ] this is a CI update. The PR name follows the format `[CI] my subject` ## What changes were proposed in this PR? This PR proposes adding a new Markdown file at `docs/community/vscode-development-guide.md` which provides a step-by-step guide for setting up an Apache Sedona development environment using Visual Studio Code, covering both Java and Scala. It also updates `mkdocs.yml` to include this new page in the documentation navigation under "Community -> Contributor Guide". ## How was this patch tested? This patch was tested by: 1. Creating the `docs/community/vscode-development-guide.md` file with the content for the VSCode development guide. 2. Updating `mkdocs.yml` to include the new documentation page in the navigation. 3. Running `mvn spotless:apply` to ensure all files, including the new Markdown and updated YAML, adhere to the project's code style and license headers. 4. Previewing the local documentation site to verify the new page appears correctly in the navigation and its content renders as expected. 5. The proposed guide itself describes development setup, and its accuracy was verified by following the steps outlined within it to set up a local VSCode development environment. ## Did this PR include necessary documentation updates? - [ ] Yes, I am adding a new API. I am using the [current SNAPSHOT version number](https://github.com/apache/sedona/blob/99239524f17389fc4ae9548ea88756f8ea538bb9/pom.xml#L29) in `vX.Y.Z` format. - [x] Yes, I have updated the documentation. - [ ] No, this PR does not affect any public API so no need to change the documentation. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
