Misc doc changes (#476)

List of changes:
* Fix image not showing in HTML page
* Use common source url
* Fix invalid SPDX license id
* Update license section
* Set and use latest ex_doc
* Fix markdown in changelog
* Badges and more badges!
* Fix typos
* Update gitignore
* Update formatter config
* Remove extra spaces
* Add logo

Author: kianmeng

.formatter.exs

@@ -1,3 +1,4 @@
+# Used by "mix format"
 [
-  inputs: [".formatter.exs", "mix.exs", "{config,lib,test}/**/*.{ex,exs}"]
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
 ]

.github/workflows/elixir.yml

@@ -36,7 +36,7 @@ jobs:
         with:
           name: deps_lock
           path: mix.lock
-  
+
   compile_dev:
     name: Compile Dev Environment
 
@@ -76,7 +76,7 @@ jobs:
         with:
           name: compile_dev
           path: _build/dev/
-  
+
   compile_docs:
     name: Compile Docs Environment
 
@@ -116,7 +116,7 @@ jobs:
         with:
           name: compile_docs
           path: _build/docs/
-  
+
   compile_test:
     name: Compile Test Environment (OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}})
 
@@ -162,7 +162,7 @@ jobs:
         with:
           name: compile_test-${{matrix.otp}}-${{matrix.elixir}}
           path: _build/test/
-  
+
   compile_prod:
     name: Compile Prod Environment
 
@@ -205,7 +205,7 @@ jobs:
 
   format:
     name: Check Formatting
-    
+
     runs-on: ubuntu-latest
 
     needs: ['deps']
@@ -397,4 +397,4 @@ jobs:
       - uses: actions/upload-artifact@v1
         with:
           name: docs
-          path: doc
+          path: doc

.gitignore

@@ -1,10 +1,31 @@
-/_build
-/deps
-/doc
-/docs
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
 erl_crash.dump
-mix.lock
+
+# Also ignore archive artifacts (built via "mix archive.build").
 *.ez
-/cover
+
+# Ignore package tarball (built via "mix hex.build").
+quantum-*.tar
+
+# Temporary files for e.g. tests.
+/tmp/
+
+# Misc.
+mix.lock
 /priv/plts/*.plt
-/priv/plts/*.plt.hash
+/priv/plts/*.plt.hash

CHANGELOG.md

@@ -68,7 +68,7 @@ Diff for [3.0.0-rc.2]
 
 ## 3.0.0-rc.1 - 2020-02-26
 
-## Changed
+### Changed
 
 - A lot of function that were not for public use have been undocumented. Those are now considered internal and may break at any point in time.
 - `Quantum.Scheduler` has been renamed to `Quantum`

README.md

@@ -1,24 +1,29 @@
 # Quantum
 
-[Cron](https://en.wikipedia.org/wiki/Cron)-like job scheduler for [Elixir](http://elixir-lang.org/).
-
-[![Financial Contributors on Open Collective](https://opencollective.com/quantum/all/badge.svg?label=financial+contributors)](https://opencollective.com/quantum) [![Hex.pm Version](http://img.shields.io/hexpm/v/quantum.svg)](https://hex.pm/packages/quantum)
-[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/quantum)
-![.github/workflows/elixir.yml](https://github.com/quantum-elixir/quantum-core/workflows/.github/workflows/elixir.yml/badge.svg)
+[![Financial Contributors on Open Collective](https://opencollective.com/quantum/all/badge.svg?label=financial+contributors)](https://opencollective.com/quantum)
+[![CI](https://github.com/quantum-elixir/quantum-core/workflows/.github/workflows/elixir.yml/badge.svg)](https://github.com/quantum-elixir/quantum-core/actions/workflows/elixir.yml)
 [![Coverage Status](https://coveralls.io/repos/quantum-elixir/quantum-core/badge.svg?branch=master)](https://coveralls.io/r/quantum-elixir/quantum-core?branch=master)
-[![Hex.pm](https://img.shields.io/hexpm/dt/quantum.svg)](https://hex.pm/packages/quantum)
+[![Module Version](https://img.shields.io/hexpm/v/quantum.svg)](https://hex.pm/packages/quantum)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/quantum/)
+[![Total Download](https://img.shields.io/hexpm/dt/quantum.svg)](https://hex.pm/packages/quantum)
+[![License](https://img.shields.io/hexpm/l/quantum.svg)](https://github.com/quantum-elixir/quantum-core/blob/master/LICENSE)
+[![Last Updated](https://img.shields.io/github/last-commit/quantum-elixir/quantum-core.svg)](https://github.com/quantum-elixir/quantum-core/commits/master)
 
 > **This README follows master, which may not be the currently published version**. Here are the
 [docs for the latest published version of Quantum](https://hexdocs.pm/quantum/readme.html).
 
+[Cron](https://en.wikipedia.org/wiki/Cron)-like job scheduler for [Elixir](http://elixir-lang.org/).
+
 ## Setup
 
-To use Quantum in your project, edit the `mix.exs` file and add Quantum to
+To use Quantum in your project, edit the `mix.exs` file and add `Quantum` to
 
 **1. the list of dependencies:**
 ```elixir
 defp deps do
-  [{:quantum, "~> 3.0"}]
+  [
+    {:quantum, "~> 3.0"}
+  ]
 end
 ```
 
@@ -90,10 +95,9 @@ More details on the usage can be found in the [Documentation](https://hexdocs.pm
 
 This project uses the [Collective Code Construction Contract (C4)](http://rfc.zeromq.org/spec:42/C4/) for all code changes.
 
-> "Everyone, without distinction or discrimination, SHALL have an equal right to become a Contributor under the
-terms of this contract."
+> "Everyone, without distinction or discrimination, SHALL have an equal right to become a Contributor under the terms of this contract."
 
-### tl;dr
+### TL;DR
 
 1. Check for [open issues](https://github.com/quantum-elixir/quantum-core/issues) or [open a new issue](https://github.com/quantum-elixir/quantum-core/issues/new) to start a discussion around [a problem](https://www.youtube.com/watch?v=_QF9sFJGJuc).
 2. Issues SHALL be named as "Problem: _description of the problem_".
@@ -106,31 +110,42 @@ terms of this contract."
 ### Code Contributors
 
 This project exists thanks to all the people who contribute.
-<a href="https://github.com/quantum-elixir/quantum-core/graphs/contributors"><img src="https://opencollective.com/quantum/contributors.svg?width=890&button=false" /></a>
+
+[![Contributors](https://opencollective.com/quantum/contributors.svg?width=890&button=false)](https://github.com/quantum-elixir/quantum-core/graphs/contributors)
 
 ### Financial Contributors
 
 Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/quantum/contribute)]
 
 #### Individuals
 
-<a href="https://opencollective.com/quantum"><img src="https://opencollective.com/quantum/individuals.svg?width=890"></a>
+[![Individuals](https://opencollective.com/quantum/individuals.svg?width=890)](https://opencollective.com/quantum)
 
 #### Organizations
 
 Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/quantum/contribute)]
 
-<a href="https://opencollective.com/quantum/organization/0/website"><img src="https://opencollective.com/quantum/organization/0/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/1/website"><img src="https://opencollective.com/quantum/organization/1/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/2/website"><img src="https://opencollective.com/quantum/organization/2/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/3/website"><img src="https://opencollective.com/quantum/organization/3/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/4/website"><img src="https://opencollective.com/quantum/organization/4/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/5/website"><img src="https://opencollective.com/quantum/organization/5/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/6/website"><img src="https://opencollective.com/quantum/organization/6/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/7/website"><img src="https://opencollective.com/quantum/organization/7/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/8/website"><img src="https://opencollective.com/quantum/organization/8/avatar.svg"></a>
-<a href="https://opencollective.com/quantum/organization/9/website"><img src="https://opencollective.com/quantum/organization/9/avatar.svg"></a>
-
-## License
-
-[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+[![Organization0](https://opencollective.com/quantum/organization/0/avatar.svg)](https://opencollective.com/quantum/organization/0/website)
+[![Organization1](https://opencollective.com/quantum/organization/1/avatar.svg)](https://opencollective.com/quantum/organization/1/website)
+[![Organization2](https://opencollective.com/quantum/organization/2/avatar.svg)](https://opencollective.com/quantum/organization/2/website)
+[![Organization3](https://opencollective.com/quantum/organization/3/avatar.svg)](https://opencollective.com/quantum/organization/3/website)
+[![Organization4](https://opencollective.com/quantum/organization/4/avatar.svg)](https://opencollective.com/quantum/organization/4/website)
+[![Organization5](https://opencollective.com/quantum/organization/5/avatar.svg)](https://opencollective.com/quantum/organization/5/website)
+[![Organization6](https://opencollective.com/quantum/organization/6/avatar.svg)](https://opencollective.com/quantum/organization/6/website)
+[![Organization7](https://opencollective.com/quantum/organization/7/avatar.svg)](https://opencollective.com/quantum/organization/7/website)
+[![Organization8](https://opencollective.com/quantum/organization/8/avatar.svg)](https://opencollective.com/quantum/organization/8/website)
+[![Organization9](https://opencollective.com/quantum/organization/9/avatar.svg)](https://opencollective.com/quantum/organization/9/website)
+
+## Copyright and License
+
+Copyright (c) 2015 Constantin Rack
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

assets/quantum-elixir-logo.svg

@@ -1,6 +1,6 @@
 defmodule Quantum.RunStrategy.All do
   @moduledoc """
-  Run job on all node of the node list
+  Run job on all node of the node list.
 
   If the node list is `:cluster`, all nodes of the cluster will be used.
 

lib/quantum/run_strategy/all.ex

@@ -1,6 +1,6 @@
 defmodule Quantum.Storage do
   @moduledoc """
-  Bahaviour to be implemented by all Storage Adapters.
+  Behaviour to be implemented by all Storage Adapters.
 
   The calls to the storage are blocking, make sure they're fast to not block the job execution.
   """

lib/quantum/storage.ex

@@ -3,6 +3,7 @@ defmodule Quantum.Mixfile do
 
   use Mix.Project
 
+  @source_url "https://github.com/quantum-elixir/quantum-core"
   @version "3.3.0"
 
   def project do
@@ -54,10 +55,10 @@ defmodule Quantum.Mixfile do
         "Jonatan Männchen"
       ],
       exclude_patterns: [~r[priv/plts]],
-      licenses: ["Apache License 2.0"],
+      licenses: ["Apache-2.0"],
       links: %{
-        "Changelog" => "https://github.com/quantum-elixir/quantum-core/blob/master/CHANGELOG.md",
-        "GitHub" => "https://github.com/quantum-elixir/quantum-core"
+        "Changelog" => "#{@source_url}/blob/master/CHANGELOG.md",
+        "GitHub" => @source_url
       }
     }
   end
@@ -66,13 +67,14 @@ defmodule Quantum.Mixfile do
     [
       main: "readme",
       source_ref: "v#{@version}",
-      source_url: "https://github.com/quantum-elixir/quantum-core",
+      source_url: @source_url,
+      logo: "assets/quantum-elixir-logo.svg",
       extras: [
-        "README.md",
         "CHANGELOG.md",
+        "README.md",
         "pages/supervision-tree.md",
         "pages/configuration.md",
-        "pages/runtime.md",
+        "pages/runtime-configuration.md",
         "pages/crontab-format.md",
         "pages/run-strategies.md",
         "pages/telemetry.md"
@@ -97,13 +99,12 @@ defmodule Quantum.Mixfile do
     [
       {:crontab, "~> 1.1"},
       {:gen_stage, "~> 0.14 or ~> 1.0"},
+      {:telemetry, "~> 0.4"},
       {:tzdata, "~> 1.0", only: [:dev, :test]},
-      {:earmark, "~> 1.0", only: [:dev, :docs], runtime: false},
-      {:ex_doc, "~> 0.19", only: [:dev, :docs], runtime: false},
+      {:ex_doc, ">= 0.0.0", only: [:dev, :docs], runtime: false},
       {:excoveralls, "~> 0.5", only: [:test], runtime: false},
       {:dialyxir, "~> 1.0-rc", only: [:dev], runtime: false},
-      {:credo, "~> 1.0", only: [:dev], runtime: false},
-      {:telemetry, "~> 0.4"}
+      {:credo, "~> 1.0", only: [:dev], runtime: false}
     ]
   end
 end

mix.exs

@@ -155,6 +155,3 @@ Timezones can also be configured on a per-job basis. This overrides the default
   timezone: "America/New_York"
 }
 ```
-
-## Telemetry Support
-