Skip to content

Commit 7cce1a6

Browse files
eabaAaronontheweb
eaba
and
Aaronontheweb
authored
Re-organize Configuration documentation (#5501)
* * Moved ~/articles/hocon/index.md --> ~/articles/configuration/hocon.md * Moved ~/articles/concepts/configuration.md --> ~/articles/configuration/index.md * Moved ~/articles/configuration/* (all of the module-specific configurations) --> ~/articles/configuration/modules/* Co-authored-by: Aaron Stannard <aaron@petabridge.com>
1 parent 3706c6f commit 7cce1a6

18 files changed

+99
-29
lines changed

‎docs/articles/concepts/configuration.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Akka.NET Configuration</title>
5+
<meta http-equiv = "refresh" content="1;url=../configuration/index.html" />
6+
</head>
7+
<body>
8+
<p>This page has been moved to <a href="../configuration/index.html">Akka.NET Configuration</a>.</p>
9+
</body>
10+
</html>

‎docs/articles/configuration/akka.cluster.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Akka.Cluster Configuration</title>
5+
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.cluster.html" />
6+
</head>
7+
<body>
8+
<p>This page has been moved to <a href="../configuration/modules/akka.cluster.html">Akka.Cluster Configuration</a>.</p>
9+
</body>
10+
</html>

‎docs/articles/configuration/akka.persistence.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Akka.Persistence Configuration</title>
5+
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.persistence.html" />
6+
</head>
7+
<body>
8+
<p>This page has been moved to <a href="../configuration/modules/akka.persistence.html">Akka.Persistence Configuration</a>.</p>
9+
</body>
10+
</html>

‎docs/articles/configuration/akka.remote.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Akka.Remote Configuration</title>
5+
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.remote.html" />
6+
</head>
7+
<body>
8+
<p>This page has been moved to <a href="../configuration/modules/akka.remote.html">Akka.Remote Configuration</a>.</p>
9+
</body>
10+
</html>

‎docs/articles/configuration/akka.streams.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Akka.Streams Configuration</title>
5+
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.streams.html" />
6+
</head>
7+
<body>
8+
<p>This page has been moved to <a href="../configuration/modules/akka.streams.html">Akka.Streams Configuration</a>.</p>
9+
</body>
10+
</html>

‎docs/articles/configuration/akka.testkit.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Akka.Testkit Configuration</title>
5+
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.testkit.html" />
6+
</head>
7+
<body>
8+
<p>This page has been moved to <a href="../configuration/modules/akka.testkit.html">Akka.Testkit Configuration</a>.</p>
9+
</body>
10+
</html>

‎docs/articles/configuration/akka.testkit.md

-9
This file was deleted.

‎docs/articles/concepts/configuration.md renamed to ‎docs/articles/configuration/config.md

File renamed without changes.

‎docs/articles/hocon/index.md renamed to ‎docs/articles/configuration/hocon.md

File renamed without changes.

‎docs/articles/configuration/akka.cluster.md renamed to ‎docs/articles/configuration/modules/akka.cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ title: Akka.Cluster Configuration
77

88
Below is the default HOCON configuration for the base `Akka.Cluster` package.
99

10-
[!code[Akka.Cluster.dll HOCON Configuration](../../../src/core/Akka.Cluster/Configuration/Cluster.conf)]
10+
[!code[Akka.Cluster.dll HOCON Configuration](../../../../src/core/Akka.Cluster/Configuration/Cluster.conf)]

‎docs/articles/configuration/akka.persistence.md renamed to ‎docs/articles/configuration/modules/akka.persistence.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ title: Akka.Persistence Configuration
77

88
Below is the default HOCON configuration for the base `Akka.Persistence` package.
99

10-
[!code[Akka.Persistence.dll HOCON Configuration](../../../src/core/Akka.Persistence/persistence.conf)]
10+
[!code[Akka.Persistence.dll HOCON Configuration](../../../../src/core/Akka.Persistence/persistence.conf)]

‎docs/articles/configuration/akka.remote.md renamed to ‎docs/articles/configuration/modules/akka.remote.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ title: Akka.Remote Configuration
77

88
Below is the default HOCON configuration for the base `Akka.Remote` package.
99

10-
[!code[Akka.Remote.dll HOCON Configuration](../../../src/core/Akka.Remote/Configuration/Remote.conf)]
10+
[!code[Akka.Remote.dll HOCON Configuration](../../../../src/core/Akka.Remote/Configuration/Remote.conf)]

‎docs/articles/configuration/akka.streams.md renamed to ‎docs/articles/configuration/modules/akka.streams.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ title: Akka.Streams Configuration
77

88
Below is the default HOCON configuration for the base `Akka.Streams` package.
99

10-
[!code[Akka.Streams.dll HOCON Configuration](../../../src/core/Akka.Streams/reference.conf)]
10+
[!code[Akka.Streams.dll HOCON Configuration](../../../../src/core/Akka.Streams/reference.conf)]

‎docs/articles/configuration/modules/akka.testkit.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Akka.TestKit Configuration
2+
3+
Below is the default HOCON configuration for the base `Akka.TestKit` package.
4+
5+
[!code[Akka.TestKit.dll HOCON Configuration](../../../../src/core/Akka.TestKit/Internal/Reference.conf)]
6+
7+
Additionally, it's also possible to change the default [`IScheduler` implementation](../../../api/Akka.Actor.IScheduler.yml) in the `Akka.TestKit` to use [a virtualized `TestScheduler` implementation](../../api/Akka.TestKit.TestScheduler.yml) that Akka.NET developers can use to artificially advance time forward. To swap in the `TestScheduler`, developers will want to include the HOCON below:
8+
9+
[!code[Akka.TestKit.dll TestScheduler HOCON Configuration](../../../../src/core/Akka.TestKit/Configs/TestScheduler.conf)]

‎docs/articles/configuration/modules/toc.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
- name: Akka.Cluster
2+
href: akka.cluster.md
3+
- name: Akka.Remote
4+
href: akka.remote.md
5+
- name: Akka.Persistence
6+
href: akka.persistence.md
7+
- name: Akka.Streams
8+
href: akka.streams.md
9+
- name: Akka.TestKit
10+
href: akka.testkit.md

‎docs/articles/configuration/toc.yml

+6-10
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1+
- name: Configurations
2+
href: config.md
3+
- name: HOCON Syntax and Practices in Akka.NET
4+
href: hocon.md
15
- name: Akka
26
href: akka.md
3-
- name: Akka.Remote
4-
href: akka.remote.md
5-
- name: Akka.Cluster
6-
href: akka.cluster.md
7-
- name: Akka.Persistence
8-
href: akka.persistence.md
9-
- name: Akka.Streams
10-
href: akka.streams.md
11-
- name: Akka.TestKit
12-
href: akka.testkit.md
7+
- name: Modules
8+
href: modules/toc.yml

‎docs/articles/hocon/index.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>HOCON Syntax and Practices in Akka.NET</title>
5+
<meta http-equiv = "refresh" content="1;url=../configuration/hocon.html" />
6+
</head>
7+
<body>
8+
<p>This page has been moved to <a href="../configuration/hocon.html">HOCON Syntax and Practices in Akka.NET</a>.</p>
9+
</body>
10+
</html>

‎docs/articles/toc.yml

-6
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616
href: concepts/location-transparency.md
1717
- name: Message Delivery Reliability
1818
href: concepts/message-delivery-reliability.md
19-
- name: Configuration
20-
href: concepts/configuration.md
2119
- name: Actors
2220
items:
2321
- name: ReceiveActor API
@@ -46,10 +44,6 @@
4644
href: actors/testing-actor-systems.md
4745
- name: Coordinated Shutdown
4846
href: actors/coordinated-shutdown.md
49-
- name: HOCON
50-
items:
51-
- name: HOCON Syntax and Practices in Akka.NET
52-
href: hocon/index.md
5347
- name: Persistence
5448
items:
5549
- name: Architecture

0 commit comments

Comments
 (0)