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

Feedback for /docs/quarks/quarks-getting-started/ #13

Open
mnwone opened this issue Feb 16, 2016 · 3 comments
Open

Feedback for /docs/quarks/quarks-getting-started/ #13

mnwone opened this issue Feb 16, 2016 · 3 comments

Comments

@mnwone
Copy link

mnwone commented Feb 16, 2016

Minor:
'Setting up your environment' section:
The reference to 'quarks/java8/lib' indicate the setup is on LInux.
However, the Eclipse screenshots appear to be on windows - Location: c:\Users\IBM_ADMIN....

Suggestion - make instructions consistent for one platform and indicate analogous steps apply to the other platform.

@wmarshall484
Copy link
Contributor

This was done entirely on windows. When the release is extracted, the java8 jars are in quarks/java8/lib. Which part of this is platform specific?

@mnwone
Copy link
Author

mnwone commented Feb 17, 2016

To me, '/' is Linux and '' is Windows.

BTW
The steps work ok on both Linux and Windows.
I cut and pasted the first two code snippets into a new Eclipse class and noticed that on statement:
public class TempSensor implements Supplier {
there is warning:
'The serializable class TempSensor does not declare a static final serialVersionUID field of type long'.

@juliabamford
Copy link
Contributor

@mnwone Using a forward slash when you're not referring to a specific operating system is pretty standard. I think we are OK to leave the slashes as they are. Unless we need to refer to the full path, it seems like overkill to provide the analogous steps for Windows and Linux.

Based on my experience, a Windows user is more likely to browse to the folder than specify the path, so the direction of the slashes is pretty irrelevant in that context.

@wmarshall484 Do we need to do anything about the warning that @mnwone is seeing?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants