Rework the "About the Java Track" page - #347#959
Conversation
Page re-written to be more friendly and accessible.
exercism#347 - Rework the "About the Java Track" page
Rework the "About the Java Track" page Page re-written to be more friendly and accessible.
FridaTveit
left a comment
There was a problem hiding this comment.
Thanks for tackling this @RhuanKrum :) I've left a few comments, but it's looking really good :)
Also, just a tip for next time, it's a good idea to do your PR work on a separate branch from your master branch. Any other commit you now push on your master branch will appear in this PR so it's easy to accidentally push things you didn't intend to. And it makes it harder to keep working on other things while this PR is open.
But that's just a minor thing to bear in mind for the future, this PR is looking really good :)
| @@ -1,35 +1,7 @@ | |||
| [Java](https://go.java/index.html) is among the most popular available programming languages, thanks to its versatility and compatibility. It is widely used for software development, mobile applications, and large systems development. | |||
There was a problem hiding this comment.
Maybe and developing larger systems. I also don't think there should be a comma before the and. But I'm no expert on comma rules, so feel free to correct me if I'm wrong :)
There was a problem hiding this comment.
Also, as part of the Exercism documentation guidelines, each sentence should start on a new line :)
There was a problem hiding this comment.
I fixed the English mistakes as you suggested. Sorry about that.
I didn't find the guideline mentioning I should start each sentence in on a new line :(
Should it be here? https://github.com/exercism/docs/blob/master/language-tracks/documentation/introductory-copy.md
I adapted my file now by following the other pages, so I hope it is in the correct format now :)
There was a problem hiding this comment.
@FridaTveit the last comma before the and, is usually known as a serial or oxford comma. There's quite a bit of controversy around it. Grammarly has a short blog post about it here
There was a problem hiding this comment.
@RhuanKrum I remember there was a long discussion about it in the docs repo I think. But saying that, I can't find it now! So it's probably not very important :)
Thanks @Smarticles101 :)
| 1. [Concurrent](https://en.wikipedia.org/wiki/Concurrent_computing) | ||
| 2. [Class-Based](https://en.wikipedia.org/wiki/Class-based_programming) | ||
| 3. [Object-Oriented](https://en.wikipedia.org/wiki/Object-oriented_programming) | ||
| Besides it is not that young as the fresh languages out there, Java which was born in 1995 and is maintained by [Oracle](https://www.oracle.com/index.html) was designed to be fast, secure, reliable, beginner-friendly and highly portable. This portability perk exists as it must be execute through a cross-platform compatible [Java Virtual Machine - JVM](https://en.wikipedia.org/wiki/Java_virtual_machine). Android apps are also developer using Java, since the [Android Operating System](https://en.wikipedia.org/wiki/Android_(operating_system)) runs on a Java language environment. |
There was a problem hiding this comment.
These sentences don't quite make sense in English. I would suggest something like:
"
Java was born in 1995 and is maintained by Oracle. Despite the fact that it isn't as young as some of the fresh languages out there, Java is still really popular now. It was designed to be fast, secure, reliable, beginner-friendly and highly portable. This portability perk exists because Java is executed on a cross-platform compatible Java Virtual Machine - JVM. Android apps are also developed using Java, since the Android Operating System runs on a Java language environment.
"
There was a problem hiding this comment.
I fixed the English mistakes as you suggested.
Again, sorry for that. I'll take better care of this kind of situations :(
| Besides it is not that young as the fresh languages out there, Java which was born in 1995 and is maintained by [Oracle](https://www.oracle.com/index.html) was designed to be fast, secure, reliable, beginner-friendly and highly portable. This portability perk exists as it must be execute through a cross-platform compatible [Java Virtual Machine - JVM](https://en.wikipedia.org/wiki/Java_virtual_machine). Android apps are also developer using Java, since the [Android Operating System](https://en.wikipedia.org/wiki/Android_(operating_system)) runs on a Java language environment. | ||
|
|
||
| Java applications are typically compiled to [bytecode](https://en.wikipedia.org/wiki/Bytecode) that can run on any [Java virtual machine](https://en.wikipedia.org/wiki/Java_virtual_machine) (JVM) regardless of computer architecture. | ||
| The Java community size is huge (GitHub for example has over 1.5 million Java projects, also mentioning that Java has the second larger community in [StackOverflow](https://stackoverflow.com/questions/tagged/java))! This is important because the larger a programming language community is, the more support you'd be likely to get. |
There was a problem hiding this comment.
This also doesn't really make sense in English. You could slightly rephrase it to:
"
The Java community is huge. GitHub for example has over 1.5 million Java projects. It's also worth mentioning that Java has the second largest community in StackOverflow! This is important because the larger a programming language community is, the more support you'd be likely to get.
"
|
|
||
| - Java has rich APIs: | ||
| Java has built-in [application programming interfaces](https://en.wikipedia.org/wiki/Application_programming_interface) (APIs) for I/O, networking, data structures, concurrency, and many other functions. | ||
| Standard libraries can be supplemented by open source libraries like Apache Commons, Google Guava, Netty and others. |
There was a problem hiding this comment.
I think this bit about the Java API is quite important. Java has a really good API with really good documentation which makes it a lot easier to use. So it might be worth mentioning something about that, possibly linking to the API docs as well: https://docs.oracle.com/javase/8/docs/api/ :)
There was a problem hiding this comment.
I added a paragraph about the APIs as you suggested. My bad for not including it before, thanks for that!
| If you need to write a web/enterprise app, or you need data persistence or you need to do cryptography, no problem! | ||
| Java is all you require. | ||
| There are many standard tools/practices that extend the Java ecosystem, thanks to the [Java Community Process](https://www.jcp.org/en/introduction/overview) (JCP)! | ||
| From laptops to datacenters, game consoles to scientific supercomputers, cell phones to the Internet, [Java is everywhere](https://en.wikipedia.org/wiki/Write_once,_run_anywhere)! There are lots of applications and websites that will not work unless you have Java installed (yes, we are talking about that lovely orange icon who always ask to update itself time to time!). |
There was a problem hiding this comment.
I would take out this last sentence. I'm not sure it adds anything very useful and the previous sentence is a really good one to end on :)
There was a problem hiding this comment.
Agreed! I'll take care of reading it several times before applying it next time. :)
Rework the "About the Java Track" page. Page re-written to be more friendly and accessible, included suggestions made by FridaTveit.
…"-page-v2 Rework the "about the java track" page
|
File updated! could you kindly review it again, please? About making commits into the master branch, I had a branch where I was working on, but in some point I got a bit confused and commited in the master branch by mistake without noticing it. I'll take better care about it too! Thanks! |
FridaTveit
left a comment
There was a problem hiding this comment.
This looks great! Thank you so much for putting in the effort to improve this @RhuanKrum :)
Page re-written to be more friendly and accessible.
Ps. This is my rework proposal for this page. Feel free to suggest changes or improvements. Thanks!
Reviewer Resources:
Track Policies