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

Give Bloop more visibility on the website. #1053

Merged
merged 1 commit into from Nov 8, 2019
Merged

Conversation

@olafurpg
Copy link
Member

olafurpg commented Nov 8, 2019

Previously, the website made it appear as if Bloop was an implementation
detail of Metals. Now, the website tries to give Bloop more visibility
and advertise it as an essential part of the Metals user experience (low
latency diagnostics, testing, running, soon debugging).

Metals still continues to work with other BSP servers. Nothing changes on the implementation side.

Screenshot 2019-11-08 at 07 11 43

Screenshot 2019-11-08 at 07 13 18

Previously, the website made it appear as if Bloop was an implementation
detail of Metals. Now, the website tries to give Bloop more visibility
and advertise it as an essential part of the Metals user experience (low
latency diagnostics, testing, running, soon debugging).

This change doesn't mean that Metals doesn't work with other BSP
servers. Given that >99% of Metals users use Bloop as the build server,
the new documentation only tries to make it clearer to users how
Metals work and how they can make the most of it.
@olafurpg olafurpg requested a review from jvican Nov 8, 2019
@gabro
gabro approved these changes Nov 8, 2019
Copy link
Member

gabro left a comment

🚀

[Bloop JSON files](https://scalacenter.github.io/bloop/docs/configuration-format/)
are populated with `*-sources.jar`.

## Find references

**Automatic**: it is possible to find all references to a symbol in the project

**Semi-automatic**: it is possible to 'Find symbol references' as soon the SemanticDB compiler plugin is manually enabled in the build, check separate build tool pages for details.
**Semi-automatic**: it is possible to 'Find symbol references' as soon the
SemanticDB compiler plugin is manually enabled in the build, check separate

This comment has been minimized.

Copy link
@ckipp01

ckipp01 Nov 8, 2019

Member

Super nitpicky. but the comma should be a period and Check separate build tool pages for details. should be its own sentence.

This comment has been minimized.

Copy link
@olafurpg

olafurpg Nov 8, 2019

Author Member

Can you open a separate PR? This paragraph is unchanged in this PR, only formatting changes.

@jvican
jvican approved these changes Nov 8, 2019
Copy link
Collaborator

jvican left a comment

Thanks for making these changes and advertising Bloop as a foundational piece of the Metals experience! 🙏 I believe this extra visibility boost can be positive for the Bloop project.

The Build Tools overview reads good to me, I think it illustrates well what's powered by Bloop and what works out-of-the-box and it doesn't. I believe that as other BSP servers are implemented and start to pick up in adoption, we can gradually remove Bloop from the focus, if that makes sense.

@olafurpg olafurpg merged commit ae6f677 into scalameta:master Nov 8, 2019
9 checks passed
9 checks passed
Windows unit tests
Details
Linux unit tests
Details
Sbt integration
Details
Maven integration
Details
Gradle integration
Details
Mill integration
Details
Slow tests
Details
Scala cross tests
Details
Scalafmt/Scalacheck/Docs
Details
@olafurpg olafurpg deleted the olafurpg:bloop branch Nov 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.