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

docs: replace Bazel and Intellij documentation with SBT and VSCode (DEV-607) #2035

Merged
merged 19 commits into from Apr 5, 2022

Conversation

BalduinLandolt
Copy link
Collaborator

@BalduinLandolt BalduinLandolt commented Apr 4, 2022

Resolves DEV-607

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Copy link
Collaborator

@irinaschubert irinaschubert left a comment

LGTM, just minor stuff

docs/05-internals/development/third-party.md Outdated Show resolved Hide resolved
@@ -0,0 +1,37 @@
# Setup Visual Studio Code for development of DSP-API

To have full functionality, the "Scala (Metals)" plugin should be installed.
Copy link
Collaborator

@irinaschubert irinaschubert Apr 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To have full functionality, the "Scala (Metals)" plugin should be installed.
To have full functionality, the [Scala Metals](https://scalameta.org/metals/) plugin should be installed.

Copy link
Collaborator Author

@BalduinLandolt BalduinLandolt Apr 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I generally didn't add too many links all over the place. Do you think I should? (So far, this seems to be pretty common in the docs, but I feel a bit silly for example to add a link to each instance of "VSCode" in the text...)

docs/05-internals/development/vscode-config.md Outdated Show resolved Hide resolved
docs/05-internals/development/vscode-config.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@mpro7 mpro7 left a comment

Please have a look to my suggestions.

README.md Outdated Show resolved Hide resolved
docs/05-internals/development/third-party.md Outdated Show resolved Hide resolved
docs/05-internals/development/third-party.md Outdated Show resolved Hide resolved
docs/05-internals/development/vscode-config.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
subotic
subotic approved these changes Apr 5, 2022
@BalduinLandolt BalduinLandolt requested a review from mpro7 Apr 5, 2022
@sonarcloud
Copy link

@sonarcloud sonarcloud bot commented Apr 5, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

mpro7
mpro7 approved these changes Apr 5, 2022
@BalduinLandolt BalduinLandolt merged commit 603efef into main Apr 5, 2022
11 checks passed
@BalduinLandolt BalduinLandolt deleted the wip/DEV-607-docs-replace-bazel-with-sbt branch Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants