docs: update development environment setup guide #5060
Merged
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
MMaiero
reviewed
Dec 14, 2023
docs/java-application-development/development-environment-setup.md
Outdated
Show resolved
Hide resolved
docs/java-application-development/development-environment-setup.md
Outdated
Show resolved
Hide resolved
docs/java-application-development/development-environment-setup.md
Outdated
Show resolved
Hide resolved
docs/java-application-development/development-environment-setup.md
Outdated
Show resolved
Hide resolved
docs/java-application-development/development-environment-setup.md
Outdated
Show resolved
Hide resolved
MMaiero
reviewed
Dec 14, 2023
Co-authored-by: Matteo Maiero <[email protected]>
Co-authored-by: Matteo Maiero <[email protected]>
MMaiero
approved these changes
Dec 14, 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-docs-release-5.4 docs-release-5.4
# Navigate to the new working tree
cd .worktrees/backport-docs-release-5.4
# Create a new branch
git switch --create backport-5060-to-docs-release-5.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 1de976d1bdc1f490f3282d06c363d702b31d9c24
# Push it to GitHub
git push --set-upstream origin backport-5060-to-docs-release-5.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-docs-release-5.4Then, create a pull request where the |
mattdibi
added a commit
that referenced
this pull request
Dec 14, 2023
* docs: add first draft for new DevEnv setup guide * refactor: removed old images, moved images in correct folder * refactor: rename images * refactor: rename images * refactor: restore old guide * refactor: clear distinction between "User" and "Developer" develpment environment * refactor: some wording * refactor: remove unnecessary files * refactor: remove reference to Oomph installer that we don't know if works * feat: clearly distinguis core development from add-on develpment * style: Kura -> Eclipse Kura * fix: missing comma * fix: missing comma * style: missing "the" * docs: Kura -> Eclipse Kura Co-authored-by: Matteo Maiero <[email protected]> * docs: Kura -> Eclipse Kura Co-authored-by: Matteo Maiero <[email protected]> * docs: Kura -> Eclipse Kura --------- Co-authored-by: Matteo Maiero <[email protected]>
MMaiero
added a commit
that referenced
this pull request
Dec 14, 2023
…se-5.4] (#5069) docs: update development environment setup guide (#5060) * docs: add first draft for new DevEnv setup guide * refactor: removed old images, moved images in correct folder * refactor: rename images * refactor: rename images * refactor: restore old guide * refactor: clear distinction between "User" and "Developer" develpment environment * refactor: some wording * refactor: remove unnecessary files * refactor: remove reference to Oomph installer that we don't know if works * feat: clearly distinguis core development from add-on develpment * style: Kura -> Eclipse Kura * fix: missing comma * fix: missing comma * style: missing "the" * docs: Kura -> Eclipse Kura * docs: Kura -> Eclipse Kura * docs: Kura -> Eclipse Kura --------- Co-authored-by: Matteo Maiero <[email protected]>
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.
This PR updates the Development Environment Setup guide. In addition to that I tried to clearly distinguish between the "User" installation (i.e. Kura Workspace setup which only installs the APIs and the examples) and the "Developer" installation (i.e. Development Environment Setup).
I set the Oomph installer as our preferred installation method since it sets all the required plugins and formatters that we expect.
@MMaiero I'm still a little confused about our documentation: the section is named "Java Application Development" and seems to be geared towards the development of application running inside Kura not Kura itself but, in the current "Development Environment Setup" guide, we have a section dedicated to Oomph which can be used to setup the environment for Kura itself. Not to mention the contributing section.
Should we have a dedicated section for the dev env setup for contributing to Kura? Should this be in the Wiki?
Update: after a brief offline discussion we decided to keep the guide here to benefit from the versioning provided by MkDocs. We also decided to clearly distinguish between core development environment setup and add-on development environment setup.