together-java / modernjava Goto Github PK

We just added a linter and it reports a lot of issues (obviously):

We should go through them and fix the issues and adjust the config file to our needs while doing so.

Folder: 6. Integers / 6.9. Operator Precedance

I noticed the following problems on example in this section:

• On "Following the order of operations:" we don't have a previous operation (without started).
• On the last operation "19 - 7", "7" was not in operation, maybe it had a mistake.

Initially, we use gh-pages to publish our website (https://together-java.github.io/ModernJava/). This is automatically deployed from the gh-pages branch.

Currently, we tried using an existing gh-action that, on pushes to master, builds the book and pushes it to the gh-pages branch. For some reason, the action fails:

https://github.com/Together-Java/ModernJava/actions/runs/3891853695

Either we investigate and fix the action, or we do it ourselves. mdBook actually has a guide for this: https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Pages

But essentially, all that has to be done is:

• download the mdbook CLI tool
• run mdbook build
• publish the content in book/ into gh-pages (a bit annoying, since the working tree has to be changed to there)

Pull request closing this issue should contain explanations of these topics

• What is a class
• How to declare a class
• Class naming conventions
• How to construct an object of a class
  • Constructors

The button on top right of the website isn't working because the link is expired.

There are for sure some useful GH-actions workflows out there, which we could add to our pipeline (besides deploying the website).

Some things that come to my mind would be:

• spelling/grammar checking
• markdown validation/linter (sonar? codeql? codefactor? ...)
• markdown formatting (spotless? ...)
• dead link checker
• (if possibly, some sort of code checking on snippets)
• maybe more?

Eventually, this book should be accessibly nicely via Google and by externals. Therefore, we should secure ourselves a proper domain and then publish the book there.

For example: modernjava.org or similar.

(please refrain from purchasing this privately, this would harm our project - we have to purchase it with our open-collective account: https://opencollective.com/together-java)

Added a basic preprocessor, but it will misbehave if conditions are nested. That isn't a problem right now but it might be worth tackling before someone foot guns

The current logo was just quickly hacked together:

We can probably make sth nicer.

The Wiki, currently empty, needs some basic intro pages, such as

• .../wiki/Contributing
• a guide how to publish locally (install mdbook, mdbook serve -open, link to the docs https://rust-lang.github.io/mdBook/guide/installation.html ...)
• a guide with our writing standards

We also need to adjust the README.md file:

• quick intro what it is
• guide for readers
• guide for writers
• entry point to the Wiki ...

Pretty much all codeboxes in 'src/boxed_primitives' are not formatted correctly.

Instead of:

void main() {
     Boolean b = null;
     System.out.println(b);
     b = true;
     System.out.println(true);
}

They are formatted without the tab before new line in method body:

void main() {
Boolean b = null;
System.out.println(b);
b = true;
System.out.println(true);
}

This is just ugly and bad for readability.

Before we really get started, we have to add:

• index / TOC
• some example content for some of those pages

and generally finalize the structure we want.

The playground repo for this was: https://github.com/bowbahdoe/javabook