From 259c5bce7e7aec5499f3ccf258fa8c927c0b7be1 Mon Sep 17 00:00:00 2001
From: Fredrik Ekre <ekrefredrik@gmail.com>
Date: Sat, 26 Jun 2021 03:34:20 +0200
Subject: [PATCH] Add some more content and basic structure.

---
 Makefile                    |  12 +++
 Manifest.toml               | 192 +++++++++++++++++++++++++++++++++++-
 Project.toml                |  10 ++
 README.md                   |  10 +-
 make.jl                     |  20 ++++
 src/assets/julialogging.css |   3 +
 src/how-to/enable-debug.md  |   3 +
 src/how-to/log-to-file.md   |   3 +
 src/index.md                |   1 -
 src/logcompose.md           |   5 +
 src/logging.md              |   7 ++
 src/logging2.md             |   5 +
 src/loggingextras.md        |   5 +
 src/logroller.md            |   5 +
 src/lokilogger.md           |   5 +
 src/progresslogging.md      |   5 +
 src/sysloglogging.md        |   5 +
 src/terminalloggers.md      |   5 +
 18 files changed, 298 insertions(+), 3 deletions(-)
 create mode 100644 Makefile
 create mode 100644 src/assets/julialogging.css
 create mode 100644 src/how-to/enable-debug.md
 create mode 100644 src/how-to/log-to-file.md
 create mode 100644 src/logcompose.md
 create mode 100644 src/logging.md
 create mode 100644 src/logging2.md
 create mode 100644 src/loggingextras.md
 create mode 100644 src/logroller.md
 create mode 100644 src/lokilogger.md
 create mode 100644 src/progresslogging.md
 create mode 100644 src/sysloglogging.md
 create mode 100644 src/terminalloggers.md

diff --git a/Makefile b/Makefile
new file mode 100644
index 00000000..ccb20aab
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,12 @@
+default: serve
+
+build:
+	julia --project make.jl
+
+instantiate:
+	julia --project -e 'using Pkg; Pkg.instantiate()'
+
+serve: instantiate
+	julia --project -e 'using LiveServer; LiveServer.servedocs(; foldername=pwd(), host="0.0.0.0", port=8080)'
+
+.PHONY: build instantiate serve
diff --git a/Manifest.toml b/Manifest.toml
index a3f3dc8d..ebec9188 100644
--- a/Manifest.toml
+++ b/Manifest.toml
@@ -1,8 +1,30 @@
 # This file is machine-generated - editing it directly is not advised
 
+[[AbstractTrees]]
+git-tree-sha1 = "03e0550477d86222521d254b741d470ba17ea0b5"
+uuid = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
+version = "0.3.4"
+
+[[ArgTools]]
+uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
+
+[[Artifacts]]
+uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
+
 [[Base64]]
 uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
 
+[[CodecZlib]]
+deps = ["TranscodingStreams", "Zlib_jll"]
+git-tree-sha1 = "ded953804d019afa9a3f98981d99b33e3db7b6da"
+uuid = "944b1d66-785c-5afd-91f1-9de20f533193"
+version = "0.7.0"
+
+[[Crayons]]
+git-tree-sha1 = "3f71217b538d7aaee0b69ab47d9b7724ca8afa0d"
+uuid = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f"
+version = "4.0.4"
+
 [[Dates]]
 deps = ["Printf"]
 uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
@@ -15,16 +37,37 @@ version = "0.8.5"
 
 [[Documenter]]
 deps = ["Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
-git-tree-sha1 = "621850838b3e74dd6dd047b5432d2e976877104e"
+git-tree-sha1 = "5626820ef21a7787b20b9084c90205bdc4103673"
+repo-rev = "fe/non-versioned-docs"
+repo-url = "https://github.com/JuliaDocs/Documenter.jl.git"
 uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 version = "0.27.2"
 
+[[Downloads]]
+deps = ["ArgTools", "LibCURL", "NetworkOptions"]
+uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
+
+[[FileWatching]]
+uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
+
+[[HTTP]]
+deps = ["Base64", "Dates", "IniFile", "MbedTLS", "NetworkOptions", "Sockets", "URIs"]
+git-tree-sha1 = "86ed84701fbfd1142c9786f8e53c595ff5a4def9"
+uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3"
+version = "0.9.10"
+
 [[IOCapture]]
 deps = ["Logging", "Random"]
 git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a"
 uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
 version = "0.2.2"
 
+[[IniFile]]
+deps = ["Test"]
+git-tree-sha1 = "098e4d2c533924c921f9f9847274f2ad89e018b8"
+uuid = "83e8ac13-25f8-5344-8a64-a9f2b223428f"
+version = "0.5.0"
+
 [[InteractiveUtils]]
 deps = ["Markdown"]
 uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
@@ -35,20 +78,98 @@ git-tree-sha1 = "81690084b6198a2e1da36fcfda16eeca9f9f24e4"
 uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 version = "0.21.1"
 
+[[JSON3]]
+deps = ["Dates", "Mmap", "Parsers", "StructTypes", "UUIDs"]
+git-tree-sha1 = "a61b471557f4cf73bc1047aef9c6aa941d115320"
+uuid = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
+version = "1.8.2"
+
+[[LeftChildRightSiblingTrees]]
+deps = ["AbstractTrees"]
+git-tree-sha1 = "71be1eb5ad19cb4f61fa8c73395c0338fd092ae0"
+uuid = "1d6d02ad-be62-4b6b-8a6d-2f90e265016e"
+version = "0.1.2"
+
+[[LibCURL]]
+deps = ["LibCURL_jll", "MozillaCACerts_jll"]
+uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
+
+[[LibCURL_jll]]
+deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
+uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
+
 [[LibGit2]]
 deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
 uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
 
+[[LibSSH2_jll]]
+deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
+uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
+
+[[Libdl]]
+uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+
+[[LiveServer]]
+deps = ["Crayons", "FileWatching", "HTTP", "Pkg", "Sockets", "Test"]
+git-tree-sha1 = "4db4abb8b7d8dadff178b8311e540c86dffcf97d"
+uuid = "16fef848-5104-11e9-1b77-fb7a48bbb589"
+version = "0.6.6"
+
+[[LogCompose]]
+deps = ["Logging", "Pkg"]
+git-tree-sha1 = "31bb42ff38e278c579be35741680a602196ffb3b"
+uuid = "8416b438-731e-11ea-2421-05f642269042"
+version = "0.2.1"
+
+[[LogRoller]]
+deps = ["CodecZlib", "Dates", "JSON", "Logging"]
+git-tree-sha1 = "93e808ce285f26cc9fd88c891f123dec6599c597"
+uuid = "c41e01d8-14e5-11ea-185b-e7eabed7be4b"
+version = "0.4.2"
+
 [[Logging]]
 uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
 
+[[Logging2]]
+deps = ["Logging"]
+git-tree-sha1 = "a325e8ad45ab9282b3e9cdbc2a0b1ea8b870daa5"
+uuid = "18cd0bd4-3461-488c-9dae-1a490b172243"
+version = "0.1.0"
+
+[[LoggingExtras]]
+deps = ["Dates", "Logging"]
+git-tree-sha1 = "dfeda1c1130990428720de0024d4516b1902ce98"
+uuid = "e6f89c97-d47a-5376-807f-9c37f3926c36"
+version = "0.4.7"
+
+[[LokiLogger]]
+deps = ["HTTP", "JSON3", "Logging", "StructTypes", "URIs"]
+git-tree-sha1 = "d412abc34fad95ca2b7d6db8c932561dc2648377"
+repo-rev = "master"
+repo-url = "https://github.com/JuliaLogging/LokiLogger.jl.git"
+uuid = "51d429d1-9683-4c89-86d7-889f440454ef"
+version = "1.0.0"
+
 [[Markdown]]
 deps = ["Base64"]
 uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
 
+[[MbedTLS]]
+deps = ["Dates", "MbedTLS_jll", "Random", "Sockets"]
+git-tree-sha1 = "1c38e51c3d08ef2278062ebceade0e46cefc96fe"
+uuid = "739be429-bea8-5141-9913-cc70e7f3736d"
+version = "1.0.3"
+
+[[MbedTLS_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
+
 [[Mmap]]
 uuid = "a63ad114-7e13-5084-954f-fe012c677804"
 
+[[MozillaCACerts_jll]]
+uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
+
 [[NetworkOptions]]
 uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
 
@@ -58,10 +179,20 @@ git-tree-sha1 = "c8abc88faa3f7a3950832ac5d6e690881590d6dc"
 uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
 version = "1.1.0"
 
+[[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"
+
 [[Printf]]
 deps = ["Unicode"]
 uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 
+[[ProgressLogging]]
+deps = ["Logging", "SHA", "UUIDs"]
+git-tree-sha1 = "80d919dee55b9c50e8d9e2da5eeafff3fe58b539"
+uuid = "33c8b6b6-d38a-422a-b730-caa89a2f386c"
+version = "0.1.4"
+
 [[REPL]]
 deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
 uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
@@ -79,9 +210,68 @@ uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 [[Sockets]]
 uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
 
+[[StructTypes]]
+deps = ["Dates", "UUIDs"]
+git-tree-sha1 = "e36adc471280e8b346ea24c5c87ba0571204be7a"
+uuid = "856f2bd8-1eba-4b0a-8007-ebc267875bd4"
+version = "1.7.2"
+
+[[SyslogLogging]]
+deps = ["Logging", "Sockets", "Syslogs"]
+git-tree-sha1 = "14faba6fd7a559c0597c03a4e242d1c0440272a4"
+uuid = "0c4b0c42-68ec-11ea-3bc9-e7fb6e00ea0f"
+version = "0.1.1"
+
+[[Syslogs]]
+deps = ["Printf", "Sockets"]
+git-tree-sha1 = "46badfcc7c6e74535cc7d833a91f4ac4f805f86d"
+uuid = "cea106d9-e007-5e6c-ad93-58fe2094e9c4"
+version = "0.3.0"
+
+[[TOML]]
+deps = ["Dates"]
+uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
+
+[[Tar]]
+deps = ["ArgTools", "SHA"]
+uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
+
+[[TerminalLoggers]]
+deps = ["LeftChildRightSiblingTrees", "Logging", "Markdown", "Printf", "ProgressLogging", "UUIDs"]
+git-tree-sha1 = "e185a19bb9172f0cf5bc71233fab92a46f7ae154"
+uuid = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"
+version = "0.1.3"
+
 [[Test]]
 deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
 uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
+[[TranscodingStreams]]
+deps = ["Random", "Test"]
+git-tree-sha1 = "7c53c35547de1c5b9d46a4797cf6d8253807108c"
+uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
+version = "0.9.5"
+
+[[URIs]]
+git-tree-sha1 = "97bbe755a53fe859669cd907f2d96aee8d2c1355"
+uuid = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
+version = "1.3.0"
+
+[[UUIDs]]
+deps = ["Random", "SHA"]
+uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
+
 [[Unicode]]
 uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
+
+[[Zlib_jll]]
+deps = ["Libdl"]
+uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
+
+[[nghttp2_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
+
+[[p7zip_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"
diff --git a/Project.toml b/Project.toml
index dfa65cd1..ae53db94 100644
--- a/Project.toml
+++ b/Project.toml
@@ -1,2 +1,12 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+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"
+LokiLogger = "51d429d1-9683-4c89-86d7-889f440454ef"
+ProgressLogging = "33c8b6b6-d38a-422a-b730-caa89a2f386c"
+SyslogLogging = "0c4b0c42-68ec-11ea-3bc9-e7fb6e00ea0f"
+TerminalLoggers = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"
diff --git a/README.md b/README.md
index 38f017c3..269d3e14 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,11 @@
 # julialogging.github.io
 
-JuliaLogging organization home page
+JuliaLogging organization home page: [julialogging.github.io](https://julialogging.github.io).
+
+
+### Making changes
+
+To make changes to the page, clone the repo and run `make serve` from the repository root.
+This will launch a local webserver at [http://localhost:8080](http://localhost:8080) which
+you can open in a browser. When you make changes to the source files the page is
+automatically rebuilt and the browser automatically refreshed.
diff --git a/make.jl b/make.jl
index 13166073..74207b2f 100644
--- a/make.jl
+++ b/make.jl
@@ -1,15 +1,35 @@
 using Documenter
+import LoggingExtras, LokiLogger, ProgressLogging, TerminalLoggers,
+       SyslogLogging, LogRoller, LogCompose, Logging, Logging2
 
 # Build the docs
 makedocs(
     sitename = "JuliaLogging",
     pages = [
         "Home" => "index.md",
+        "How-to guides" => [
+            "how-to/enable-debug.md",
+            "how-to/log-to-file.md",
+        ],
+        "Reference" => [
+            "logging.md",
+            "loggingextras.md",
+            "terminalloggers.md",
+            "progresslogging.md",
+            "lokilogger.md",
+            "logroller.md",
+            "logcompose.md",
+            "sysloglogging.md",
+            "logging2.md",
+        ],
     ],
     format = Documenter.HTML(
+        assets = ["assets/julialogging.css"],
     ),
 )
 
 deploydocs(
+    versions = nothing,
+    push_preview = true,
     repo = "github.com/JuliaLogging/julialogging.github.io.git",
 )
diff --git a/src/assets/julialogging.css b/src/assets/julialogging.css
new file mode 100644
index 00000000..4966fb5b
--- /dev/null
+++ b/src/assets/julialogging.css
@@ -0,0 +1,3 @@
+pre, code {
+    font-variant-ligatures: no-contextual;
+}
diff --git a/src/how-to/enable-debug.md b/src/how-to/enable-debug.md
new file mode 100644
index 00000000..02373f8a
--- /dev/null
+++ b/src/how-to/enable-debug.md
@@ -0,0 +1,3 @@
+# How to enable `@debug` messages
+
+To be written...
diff --git a/src/how-to/log-to-file.md b/src/how-to/log-to-file.md
new file mode 100644
index 00000000..c419ab05
--- /dev/null
+++ b/src/how-to/log-to-file.md
@@ -0,0 +1,3 @@
+# How to log to a file
+
+To be written...
diff --git a/src/index.md b/src/index.md
index b10a2747..517d26b6 100644
--- a/src/index.md
+++ b/src/index.md
@@ -48,4 +48,3 @@ abstractions from the
 
 * [`LogCompose.jl`](https://github.com/JuliaLogging/LogCompose.jl) provides
   declarative logger configuration and an associated `.toml` file format.
-
diff --git a/src/logcompose.md b/src/logcompose.md
new file mode 100644
index 00000000..1fc0eef0
--- /dev/null
+++ b/src/logcompose.md
@@ -0,0 +1,5 @@
+# LogCompose.jl
+
+```@autodocs
+Modules = [LogCompose]
+```
diff --git a/src/logging.md b/src/logging.md
new file mode 100644
index 00000000..649d5bce
--- /dev/null
+++ b/src/logging.md
@@ -0,0 +1,7 @@
+# Logging.jl
+
+```@docs
+Logging.@logmsg
+Logging.SimpleLogger
+Logging.ConsoleLogger
+```
diff --git a/src/logging2.md b/src/logging2.md
new file mode 100644
index 00000000..0de2ae98
--- /dev/null
+++ b/src/logging2.md
@@ -0,0 +1,5 @@
+# Logging2.jl
+
+```@autodocs
+Modules = [Logging2]
+```
diff --git a/src/loggingextras.md b/src/loggingextras.md
new file mode 100644
index 00000000..56f30ad6
--- /dev/null
+++ b/src/loggingextras.md
@@ -0,0 +1,5 @@
+# LoggingExtras.jl
+
+```@autodocs
+Modules = [LoggingExtras]
+```
diff --git a/src/logroller.md b/src/logroller.md
new file mode 100644
index 00000000..45aa1597
--- /dev/null
+++ b/src/logroller.md
@@ -0,0 +1,5 @@
+# LogRoller.jl
+
+```@autodocs
+Modules = [LogRoller]
+```
diff --git a/src/lokilogger.md b/src/lokilogger.md
new file mode 100644
index 00000000..395b92f4
--- /dev/null
+++ b/src/lokilogger.md
@@ -0,0 +1,5 @@
+# LokiLogger.jl
+
+```@autodocs
+Modules = [LokiLogger]
+```
diff --git a/src/progresslogging.md b/src/progresslogging.md
new file mode 100644
index 00000000..db04586c
--- /dev/null
+++ b/src/progresslogging.md
@@ -0,0 +1,5 @@
+# ProgressLogging.jl
+
+```@autodocs
+Modules = [ProgressLogging]
+```
diff --git a/src/sysloglogging.md b/src/sysloglogging.md
new file mode 100644
index 00000000..f50da606
--- /dev/null
+++ b/src/sysloglogging.md
@@ -0,0 +1,5 @@
+# SyslogLogging.jl
+
+```@autodocs
+Modules = [SyslogLogging]
+```
diff --git a/src/terminalloggers.md b/src/terminalloggers.md
new file mode 100644
index 00000000..780587e8
--- /dev/null
+++ b/src/terminalloggers.md
@@ -0,0 +1,5 @@
+# TerminalLoggers.jl
+
+```@autodocs
+Modules = [TerminalLoggers]
+```