Skip to content

Commit 034fd16

Browse files
akaromlakaroml
authored
Getting Started - FAQ (#185)
Signed-off-by: Rome Li <[email protected]>
1 parent c547b32 commit 034fd16

File tree

3 files changed

+53
-13
lines changed

3 files changed

+53
-13
lines changed

‎src/assets/vscode.scss‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
$body-bg: var(--vscode-editor-background);
2-
$body-color: var(--vscode-foreground);
1+
$body-bg: var(--vscode-welcomePage-background);
2+
$body-color: var(--vscode-editor-foreground);
33
$link-color: var(--vscode-textLink-foreground) !default;
44
$link-hover-color: $link-color;
55
$link-hover-decoration: none !default;

‎src/getting-started/assets/index.html‎

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,23 +59,17 @@ <h1 class="font-weight-light">Java Getting Started</h1>
5959
</p>
6060
<h3 class="font-weight-light">Setup the Workspace</h3>
6161
<p>
62-
To setup the workspace, simply open a folder by:
63-
<dl class="row">
64-
<dt class="col-sm-3">Windows</dt>
65-
<dd class="col-sm-9">File > <a href="command:workbench.action.files.openFileFolder">Open Folder...</a></dd>
66-
<dt class="col-sm-3">Mac</dt>
67-
<dd class="col-sm-9">File > <a href="command:workbench.action.files.openFileFolder">Open...</a></dd>
68-
</dl>
62+
VS Code Java works directly with <strong>folders</strong> that have source code. To setup the workspace, simply open a folder using File > <a href="command:workbench.action.files.openFileFolder" data-os="win">Open Folder...</a><a href="command:workbench.action.files.openFileFolder" data-os="mac">Open...</a>
6963
</p>
7064
<blockquote class="card-body">
7165
<h5 class="font-weight-light">No Import Needed</h5>
7266
<p class="mb-0">
73-
VS Code Java works directly with <strong>folders</strong> that have source code. If the folder you open has project/build configuration files like <code>pom.xml</code> or <code>build.gradle</code>, they will be picked up automatically and the folder will be treated as a project.
67+
If the folder you open has project/build configuration files like <code>pom.xml</code> or <code>build.gradle</code>, they will be picked up automatically and the folder will be treated as a project.
7468
</p>
7569
</blockquote>
7670
<h3 class="font-weight-light">Create a Class</h3>
7771
<p>
78-
A program needs an entry and a Java program needs a class to host its entry. To create a class for our quick-start program, <a href="command:explorer.newFile">create a file</a> and set its name to <code>QuickStart.java</code>.<br/>
72+
A program needs an entry and a Java program needs a class to host its entry. To create a class for our quick-start program, <a href="command:explorer.newFile">Create a File</a> and set its name to <code>QuickStart.java</code>.<br/>
7973
Now you can put the code in the new file:
8074
</p>
8175
<blockquote class="card-body">
@@ -229,7 +223,53 @@ <h3 class="font-weight-light">Next Steps</h3>
229223

230224
<!-- FAQ -->
231225
<div class="tab-pane fade" id="faq-panel" role="tabpanel" aria-labelledby="faq-tab">
232-
<p>Frequently asked questions</p>
226+
<blockquote class="card-body">
227+
<h5 class="font-weight-light">Feedback Channels</h5>
228+
<p>
229+
VS Code Java is new, and we are here to help.
230+
</p>
231+
<dl class="row mb-0">
232+
<dt class="col-sm-3"><a href="https://gitter.im/redhat-developer/vscode-java">Ask Questions</a></dt>
233+
<dd class="col-sm-9"><a href="https://gitter.im/redhat-developer/vscode-java">vscode-java</a> Gitter channel is recommended to ask for help</dd>
234+
<dt class="col-sm-3"><a href="https://github.com/microsoft/vscode-java-pack/issues">Open Issues</a></dt>
235+
<dd class="col-sm-9"><a href="https://github.com/microsoft/vscode-java-pack/issues">vscode-java-pack</a> GitHub repo is recommended for openning bugs</dd>
236+
<dt class="col-sm-3"><a href="https://twitter.com/search?q=vscodejava">Other Feedback</a></dt>
237+
<dd class="col-sm-9"><a href="https://twitter.com/VSCodeJava">@VSCodeJava</a> is the handle to mention on twitter</dd>
238+
</dl>
239+
</blockquote>
240+
<h3 class="font-weight-light">Why do I see the JDK errors?</h3>
241+
<p>
242+
<strong><code>JDK 8+</code> is required</strong> to run VS Code Java! You see this error because we failed to find one on your machine. The <a href="command:java.runtime">JDK Acquisition Guide</a> can help you understand how JDK path is searched and provides download links if you need to install one.
243+
</p>
244+
<h3 class="font-weight-light">Why do I see tons of problems and red squiggles?</h3>
245+
<p>
246+
The problems are from VS Code Java when it tries to compile and build your codebase. If you experience this on your first use, it's possibly because of <strong>missing dependencies</strong>. To fix it, you probably want to start from fixing the project configuration files, e.g. <code>pom.xml</code> and <code>build.gradle</code>. After you make changes to those files, try <a href="command:java.projectConfiguration.update">Update Project Configuration</a> and <a href="command:java.workspace.compile">Force Compilation</a>.
247+
</p>
248+
<p>
249+
It can also happen after you work with one project for a while. Try <a href="command:java.clean.workspace">Clean Workspace</a> to get rid of any intermidiate output from the language server.
250+
</p>
251+
<p>
252+
If the problem persists, follow the <a href="https://github.com/redhat-developer/vscode-java/wiki/Troubleshooting">Troubleshooting Guide</a>. For advanced users, the <a href="command:java.open.clientLog">Client Logs</a> and <a href="command:java.open.serverLog">Server Logs</a> will definitely help you understand what is going on.
253+
</p>
254+
<h3 class="font-weight-light">Why can't I see any IntelliSense suggestions?</h3>
255+
<p>
256+
VS Code Java needs to compile your code before it can provide suggestions. When it's working, you should see a spinning 🔄 on the right end of the status bar. And it will show 👍 when it's done. And you should be able to use all the features.
257+
</p>
258+
<p>
259+
It could take longer for the language server to load a project which references lots of dependencies. Those dependencies need to be resolved and downloaded from the internet. So the network connection plays a critical role in the process.
260+
</p>
261+
<h3 class="font-weight-light">Why do I see a little ⭐ in some of the IntelliSense suggestions?</h3>
262+
<p>
263+
This is because <a href="https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode">Visual Studio IntelliCode</a> is working. IntelliCode ranks the suggestions using the model trained from the source code of popular open source projects. The items with the stars are the ones that fit the current context the most.
264+
</p>
265+
<h3 class="font-weight-light">Can I use Lombok?</h3>
266+
<p>
267+
Yes. You'll need to install the <a href="https://marketplace.visualstudio.com/items?itemName=GabrielBB.vscode-lombok">Lombok</a> extension, which enables VS Code to process Lombok annotations. To learn more about alternatives and details, visit <a href="https://github.com/redhat-developer/vscode-java/wiki/Lombok-support">this page</a>.
268+
</p>
269+
<h3 class="font-weight-light">Can I develop Android apps using VS Code Java?</h3>
270+
<p class="mb-0">
271+
Sorry, it's not supported now.
272+
</p>
233273
</div>
234274
</div>
235275
</div>

‎src/getting-started/assets/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ if (navigator.platform.toLowerCase().indexOf("mac") === 0) {
1515
}
1616

1717
const osToHide = os === "win" ? "mac" : "win";
18-
$(`kbd[data-os=${osToHide}]`).hide();
18+
$(`[data-os=${osToHide}]`).hide();

0 commit comments

Comments
 (0)