Add lots and lots of content written throughout the last couple of months. (#5)

Author: fredrikekre

Manifest.toml

@@ -1,5 +1,10 @@
 # This file is machine-generated - editing it directly is not advised
 
+[[ANSIColoredPrinters]]
+git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
+uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
+version = "0.0.1"
+
 [[AbstractTrees]]
 git-tree-sha1 = "03e0550477d86222521d254b741d470ba17ea0b5"
 uuid = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
@@ -31,17 +36,15 @@ uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
 
 [[DocStringExtensions]]
 deps = ["LibGit2"]
-git-tree-sha1 = "a32185f5428d3986f47c2ab78b1f216d5e6cc96f"
+git-tree-sha1 = "b19534d1895d702889b219c382a6e18010797f0b"
 uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
-version = "0.8.5"
+version = "0.8.6"
 
 [[Documenter]]
-deps = ["Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
-git-tree-sha1 = "5626820ef21a7787b20b9084c90205bdc4103673"
-repo-rev = "fe/non-versioned-docs"
-repo-url = "https://github.com/JuliaDocs/Documenter.jl.git"
+deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
+git-tree-sha1 = "f425293f7e0acaf9144de6d731772de156676233"
 uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-version = "0.27.2"
+version = "0.27.10"
 
 [[Downloads]]
 deps = ["ArgTools", "LibCURL", "NetworkOptions"]
@@ -50,11 +53,22 @@ uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 [[FileWatching]]
 uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
 
+[[FilesystemDatastructures]]
+git-tree-sha1 = "22983924e485b0c5278467304e45c7bb01f2ac41"
+uuid = "89f0c457-83d8-4998-bfff-8b4a338c9833"
+version = "1.1.0"
+
+[[Gzip_jll]]
+deps = ["Libdl", "Pkg"]
+git-tree-sha1 = "906040639c56fd5671c86b7d0660f2702cab30f4"
+uuid = "be1be57a-8558-53c3-a7e5-50095f79957e"
+version = "1.10.0+0"
+
 [[HTTP]]
-deps = ["Base64", "Dates", "IniFile", "MbedTLS", "NetworkOptions", "Sockets", "URIs"]
-git-tree-sha1 = "86ed84701fbfd1142c9786f8e53c595ff5a4def9"
+deps = ["Base64", "Dates", "IniFile", "Logging", "MbedTLS", "NetworkOptions", "Sockets", "URIs"]
+git-tree-sha1 = "14eece7a3308b4d8be910e265c724a6ba51a9798"
 uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3"
-version = "0.9.10"
+version = "0.9.16"
 
 [[IOCapture]]
 deps = ["Logging", "Random"]
@@ -72,17 +86,23 @@ version = "0.5.0"
 deps = ["Markdown"]
 uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 
+[[JLLWrappers]]
+deps = ["Preferences"]
+git-tree-sha1 = "642a199af8b68253517b80bd3bfd17eb4e84df6e"
+uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
+version = "1.3.0"
+
 [[JSON]]
 deps = ["Dates", "Mmap", "Parsers", "Unicode"]
-git-tree-sha1 = "81690084b6198a2e1da36fcfda16eeca9f9f24e4"
+git-tree-sha1 = "8076680b162ada2a031f707ac7b4953e30667a37"
 uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
-version = "0.21.1"
+version = "0.21.2"
 
 [[JSON3]]
 deps = ["Dates", "Mmap", "Parsers", "StructTypes", "UUIDs"]
-git-tree-sha1 = "a61b471557f4cf73bc1047aef9c6aa941d115320"
+git-tree-sha1 = "7d58534ffb62cd947950b3aa9b993e63307a6125"
 uuid = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
-version = "1.8.2"
+version = "1.9.2"
 
 [[LeftChildRightSiblingTrees]]
 deps = ["AbstractTrees"]
@@ -111,9 +131,9 @@ uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
 
 [[LiveServer]]
 deps = ["Crayons", "FileWatching", "HTTP", "Pkg", "Sockets", "Test"]
-git-tree-sha1 = "4db4abb8b7d8dadff178b8311e540c86dffcf97d"
+git-tree-sha1 = "99990da121ad310875b3c4dba5954eba54df8cfd"
 uuid = "16fef848-5104-11e9-1b77-fb7a48bbb589"
-version = "0.6.6"
+version = "0.7.0"
 
 [[LogCompose]]
 deps = ["Logging", "Pkg"]
@@ -123,9 +143,9 @@ version = "0.2.1"
 
 [[LogRoller]]
 deps = ["CodecZlib", "Dates", "JSON", "Logging"]
-git-tree-sha1 = "93e808ce285f26cc9fd88c891f123dec6599c597"
+git-tree-sha1 = "c2346c7aec3c910f0e2fc977ba05c30f98b2b1f3"
 uuid = "c41e01d8-14e5-11ea-185b-e7eabed7be4b"
-version = "0.4.2"
+version = "0.4.3"
 
 [[Logging]]
 uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
@@ -138,10 +158,18 @@ version = "0.1.0"
 
 [[LoggingExtras]]
 deps = ["Dates", "Logging"]
-git-tree-sha1 = "dfeda1c1130990428720de0024d4516b1902ce98"
+git-tree-sha1 = "aa8dc79e4ffb91ac4e07ebc560c0449db6d3f876"
+repo-rev = "master"
+repo-url = "https://github.com/JuliaLogging/LoggingExtras.jl.git"
 uuid = "e6f89c97-d47a-5376-807f-9c37f3926c36"
 version = "0.4.7"
 
+[[LoggingFormats]]
+deps = ["JSON3", "Logging", "StructTypes"]
+git-tree-sha1 = "80b4a1ef291ebc67ce74c99a6be58200c8265ddd"
+uuid = "98105f81-4425-4516-93fd-1664fb551ab6"
+version = "1.0.0"
+
 [[LokiLogger]]
 deps = ["HTTP", "JSON3", "Logging", "StructTypes", "URIs"]
 git-tree-sha1 = "d412abc34fad95ca2b7d6db8c932561dc2648377"
@@ -173,16 +201,28 @@ uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
 [[NetworkOptions]]
 uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
 
+[[NodeJS_16_jll]]
+deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"]
+git-tree-sha1 = "5677da696fb18f8ae97f23b0236b29d88fb272b5"
+uuid = "a4b94fbf-73f5-58ff-888d-48a8396e17f6"
+version = "16.0.0+0"
+
 [[Parsers]]
 deps = ["Dates"]
-git-tree-sha1 = "c8abc88faa3f7a3950832ac5d6e690881590d6dc"
+git-tree-sha1 = "ae4bbcadb2906ccc085cf52ac286dc1377dceccc"
 uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
-version = "1.1.0"
+version = "2.1.2"
 
 [[Pkg]]
 deps = ["Artifacts", "Dates", "Downloads", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
 uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 
+[[Preferences]]
+deps = ["TOML"]
+git-tree-sha1 = "00cfd92944ca9c760982747e9a1d0d5d86ab1e5a"
+uuid = "21216c6a-2e73-6563-6e65-726566657250"
+version = "1.2.2"
+
 [[Printf]]
 deps = ["Unicode"]
 uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
@@ -212,9 +252,9 @@ uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
 
 [[StructTypes]]
 deps = ["Dates", "UUIDs"]
-git-tree-sha1 = "e36adc471280e8b346ea24c5c87ba0571204be7a"
+git-tree-sha1 = "d24a825a95a6d98c385001212dc9020d609f2d4f"
 uuid = "856f2bd8-1eba-4b0a-8007-ebc267875bd4"
-version = "1.7.2"
+version = "1.8.1"
 
 [[SyslogLogging]]
 deps = ["Logging", "Sockets", "Syslogs"]
@@ -238,19 +278,19 @@ uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
 
 [[TerminalLoggers]]
 deps = ["LeftChildRightSiblingTrees", "Logging", "Markdown", "Printf", "ProgressLogging", "UUIDs"]
-git-tree-sha1 = "e185a19bb9172f0cf5bc71233fab92a46f7ae154"
+git-tree-sha1 = "62846a48a6cd70e63aa29944b8c4ef704360d72f"
 uuid = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"
-version = "0.1.3"
+version = "0.1.5"
 
 [[Test]]
 deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
 uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [[TranscodingStreams]]
 deps = ["Random", "Test"]
-git-tree-sha1 = "7c53c35547de1c5b9d46a4797cf6d8253807108c"
+git-tree-sha1 = "216b95ea110b5972db65aa90f88d8d89dcb8851c"
 uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
-version = "0.9.5"
+version = "0.9.6"
 
 [[URIs]]
 git-tree-sha1 = "97bbe755a53fe859669cd907f2d96aee8d2c1355"

Project.toml

@@ -1,12 +1,16 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+FilesystemDatastructures = "89f0c457-83d8-4998-bfff-8b4a338c9833"
+Gzip_jll = "be1be57a-8558-53c3-a7e5-50095f79957e"
 LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 LogCompose = "8416b438-731e-11ea-2421-05f642269042"
 LogRoller = "c41e01d8-14e5-11ea-185b-e7eabed7be4b"
 Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 Logging2 = "18cd0bd4-3461-488c-9dae-1a490b172243"
 LoggingExtras = "e6f89c97-d47a-5376-807f-9c37f3926c36"
+LoggingFormats = "98105f81-4425-4516-93fd-1664fb551ab6"
 LokiLogger = "51d429d1-9683-4c89-86d7-889f440454ef"
+NodeJS_16_jll = "a4b94fbf-73f5-58ff-888d-48a8396e17f6"
 ProgressLogging = "33c8b6b6-d38a-422a-b730-caa89a2f386c"
 SyslogLogging = "0c4b0c42-68ec-11ea-3bc9-e7fb6e00ea0f"
 TerminalLoggers = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"

make.jl

@@ -1,30 +1,97 @@
 using Documenter
+import NodeJS_16_jll
 import LoggingExtras, LokiLogger, ProgressLogging, TerminalLoggers,
-       SyslogLogging, LogRoller, LogCompose, Logging, Logging2
+       SyslogLogging, LogRoller, LogCompose, Logging, Logging2, LoggingFormats
+
+# "Backport" of JuliaLang/julia#40979
+@eval Logging begin
+    @doc """
+    Alias for `LogLevel(-1000)`.
+    """
+    Debug
+    @doc """
+    Alias for `LogLevel(0)`.
+    """
+    Info
+    @doc """
+    Alias for `LogLevel(1000)`.
+    """
+    Warn
+    @doc """
+    Alias for `LogLevel(2000)`.
+    """
+    Error
+end
+
+# TODO: Upstream this
+@eval LoggingFormats begin
+    @doc """
+        JSON
+
+    Serialize log messages as JSON.
+    """
+    JSON
+
+    @doc """
+        LogFmt
+
+    Format log messages as [logfmt](https://brandur.org/logfmt).
+    """
+    LogFmt
+
+    @doc """
+        Truncated
+
+    Format log messages similar to `ConsoleLogger`, but truncate long messages.
+    """
+    Truncated
+end
 
 # Build the docs
 makedocs(
     sitename = "JuliaLogging",
     pages = [
         "Home" => "index.md",
+        "package-overview.md",
+        "Tutorials" => [
+            "tutorials/logging-basics.md",
+            "tutorials/working-with-loggers.md",
+            "tutorials/implement-a-new-logger.md",
+        ],
         "How-to guides" => [
             "how-to/enable-debug.md",
             "how-to/log-to-file.md",
+            "how-to/tee.md",
+            "how-to/filter-messages.md",
+            "how-to/rotate-log-files.md",
         ],
         "Reference" => [
-            "logging.md",
-            "loggingextras.md",
-            "terminalloggers.md",
-            "progresslogging.md",
-            "lokilogger.md",
-            "logroller.md",
-            "logcompose.md",
-            "sysloglogging.md",
-            "logging2.md",
+            "reference/logcompose.md",
+            "reference/logging.md",
+            "reference/logging2.md",
+            "reference/loggingextras.md",
+            "reference/loggingformats.md",
+            "reference/logroller.md",
+            "reference/lokilogger.md",
+            "reference/progresslogging.md",
+            "reference/sysloglogging.md",
+            "reference/terminalloggers.md",
         ],
+        # "Background and discussion" => [
+        # ],
     ],
     format = Documenter.HTML(
-        assets = ["assets/julialogging.css"],
+        assets = [
+            "assets/julialogging.css",
+            "assets/gruvbox-light-hard.css",
+            "assets/gruvbox-dark-hard.css",
+            "assets/favicon.ico",
+        ],
+        collapselevel = 1,
+        ansicolor = true,
+        prerender = get(ENV, "GITHUB_ACTIONS", nothing) == "true",
+        node = NodeJS_16_jll.node(),
+        highlightjs = joinpath(@__DIR__, "src", "assets", "julia.highlight.min.js"),
     ),
 )