Add documentation website #112
Merged
Conversation
This file contains hidden or 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
Contributor
Author
|
Live preview at https://sourcegraph.github.io/lsif-java Just opening this PR to close my day and collect early feedback. I will review the change again tomorrow and likely clean up a few small things. |
Previously, lsif-java didn't have any documentation for end-users. We only had documentation for contributors. This commit adds a website that includes user-facing documentation on how to run lsif-java with automatic indexing and manual indexing.
olafurpg
force-pushed
the
documentation-website
branch
from
a8515fe to
0b8f679
Compare
Strum355
reviewed
Mar 4, 2021
Comment on lines
+127
to
+133
| | Build tool | Support | Tracking issue | | ||
| | ---------- | ------- | -------------------------------------------------------------------------------- | | ||
| | Gradle | ✅ | | | ||
| | Maven | ✅ | | | ||
| | Bazel | ❌ | [sourcegraph/lsif-java#88](https://github.com/sourcegraph/lsif-java/issues/88) | | ||
| | Buck | ❌ | [sourcegraph/lsif-java#99](https://github.com/sourcegraph/lsif-java/issues/99) | | ||
| | sbt | ❌ | [sourcegraph/lsif-java#110](https://github.com/sourcegraph/lsif-java/issues/110) | |
Strum355
reviewed
Mar 4, 2021
Strum355
reviewed
Mar 4, 2021
Strum355
reviewed
Mar 4, 2021
Strum355
reviewed
Mar 4, 2021
|
|
||
|  | ||
|
|
||
| ## Step 1: Add SemanticDB compiler plugin to the classpath |
Contributor
There was a problem hiding this comment.
Should we have consistent first letter capitalization or is this intentionally capitalized?
Contributor
Author
There was a problem hiding this comment.
I love your attention to details 👌 fixed
Strum355
approved these changes
Mar 4, 2021
Contributor
Strum355
left a comment
Strum355
left a comment
There was a problem hiding this comment.
Really like having this website, great idea 🎉
Some minor but not-really-blocking comments 🙂
olafurpg
commented
Mar 5, 2021
Contributor
Author
olafurpg
left a comment
olafurpg
left a comment
There was a problem hiding this comment.
Thank you for the review!
|
|
||
|  | ||
|
|
||
| ## Step 1: Add SemanticDB compiler plugin to the classpath |
Contributor
Author
There was a problem hiding this comment.
I love your attention to details 👌 fixed
olafurpg
force-pushed
the
documentation-website
branch
from
65c959b to
387826b
Compare
43 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Previously, lsif-java didn't have any documentation for end-users. We
only had documentation for contributors. This commit adds a website that
includes user-facing documentation on how to run lsif-java with
automatic indexing and manual indexing.