Skip to content

Commit

Permalink
Re-organize Configuration documentation (#5501)
Browse files Browse the repository at this point in the history
* * 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>
  • Loading branch information
eaba and Aaronontheweb authored Jan 13, 2022
1 parent 3706c6f commit 7cce1a6
Show file tree
Hide file tree
Showing 18 changed files with 99 additions and 29 deletions.
10 changes: 10 additions & 0 deletions docs/articles/concepts/configuration.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Akka.NET Configuration</title>
<meta http-equiv = "refresh" content="1;url=../configuration/index.html" />
</head>
<body>
<p>This page has been moved to <a href="../configuration/index.html">Akka.NET Configuration</a>.</p>
</body>
</html>
10 changes: 10 additions & 0 deletions docs/articles/configuration/akka.cluster.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Akka.Cluster Configuration</title>
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.cluster.html" />
</head>
<body>
<p>This page has been moved to <a href="../configuration/modules/akka.cluster.html">Akka.Cluster Configuration</a>.</p>
</body>
</html>
10 changes: 10 additions & 0 deletions docs/articles/configuration/akka.persistence.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Akka.Persistence Configuration</title>
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.persistence.html" />
</head>
<body>
<p>This page has been moved to <a href="../configuration/modules/akka.persistence.html">Akka.Persistence Configuration</a>.</p>
</body>
</html>
10 changes: 10 additions & 0 deletions docs/articles/configuration/akka.remote.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Akka.Remote Configuration</title>
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.remote.html" />
</head>
<body>
<p>This page has been moved to <a href="../configuration/modules/akka.remote.html">Akka.Remote Configuration</a>.</p>
</body>
</html>
10 changes: 10 additions & 0 deletions docs/articles/configuration/akka.streams.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Akka.Streams Configuration</title>
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.streams.html" />
</head>
<body>
<p>This page has been moved to <a href="../configuration/modules/akka.streams.html">Akka.Streams Configuration</a>.</p>
</body>
</html>
10 changes: 10 additions & 0 deletions docs/articles/configuration/akka.testkit.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Akka.Testkit Configuration</title>
<meta http-equiv = "refresh" content="1;url=../configuration/modules/akka.testkit.html" />
</head>
<body>
<p>This page has been moved to <a href="../configuration/modules/akka.testkit.html">Akka.Testkit Configuration</a>.</p>
</body>
</html>
9 changes: 0 additions & 9 deletions docs/articles/configuration/akka.testkit.md

This file was deleted.

File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ title: Akka.Cluster Configuration

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

[!code[Akka.Cluster.dll HOCON Configuration](../../../src/core/Akka.Cluster/Configuration/Cluster.conf)]
[!code[Akka.Cluster.dll HOCON Configuration](../../../../src/core/Akka.Cluster/Configuration/Cluster.conf)]
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ title: Akka.Persistence Configuration

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

[!code[Akka.Persistence.dll HOCON Configuration](../../../src/core/Akka.Persistence/persistence.conf)]
[!code[Akka.Persistence.dll HOCON Configuration](../../../../src/core/Akka.Persistence/persistence.conf)]
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ title: Akka.Remote Configuration

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

[!code[Akka.Remote.dll HOCON Configuration](../../../src/core/Akka.Remote/Configuration/Remote.conf)]
[!code[Akka.Remote.dll HOCON Configuration](../../../../src/core/Akka.Remote/Configuration/Remote.conf)]
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ title: Akka.Streams Configuration

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

[!code[Akka.Streams.dll HOCON Configuration](../../../src/core/Akka.Streams/reference.conf)]
[!code[Akka.Streams.dll HOCON Configuration](../../../../src/core/Akka.Streams/reference.conf)]
9 changes: 9 additions & 0 deletions docs/articles/configuration/modules/akka.testkit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Akka.TestKit Configuration

Below is the default HOCON configuration for the base `Akka.TestKit` package.

[!code[Akka.TestKit.dll HOCON Configuration](../../../../src/core/Akka.TestKit/Internal/Reference.conf)]

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:

[!code[Akka.TestKit.dll TestScheduler HOCON Configuration](../../../../src/core/Akka.TestKit/Configs/TestScheduler.conf)]
10 changes: 10 additions & 0 deletions docs/articles/configuration/modules/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- name: Akka.Cluster
href: akka.cluster.md
- name: Akka.Remote
href: akka.remote.md
- name: Akka.Persistence
href: akka.persistence.md
- name: Akka.Streams
href: akka.streams.md
- name: Akka.TestKit
href: akka.testkit.md
16 changes: 6 additions & 10 deletions docs/articles/configuration/toc.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
- name: Configurations
href: config.md
- name: HOCON Syntax and Practices in Akka.NET
href: hocon.md
- name: Akka
href: akka.md
- name: Akka.Remote
href: akka.remote.md
- name: Akka.Cluster
href: akka.cluster.md
- name: Akka.Persistence
href: akka.persistence.md
- name: Akka.Streams
href: akka.streams.md
- name: Akka.TestKit
href: akka.testkit.md
- name: Modules
href: modules/toc.yml
10 changes: 10 additions & 0 deletions docs/articles/hocon/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>HOCON Syntax and Practices in Akka.NET</title>
<meta http-equiv = "refresh" content="1;url=../configuration/hocon.html" />
</head>
<body>
<p>This page has been moved to <a href="../configuration/hocon.html">HOCON Syntax and Practices in Akka.NET</a>.</p>
</body>
</html>
6 changes: 0 additions & 6 deletions docs/articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
href: concepts/location-transparency.md
- name: Message Delivery Reliability
href: concepts/message-delivery-reliability.md
- name: Configuration
href: concepts/configuration.md
- name: Actors
items:
- name: ReceiveActor API
Expand Down Expand Up @@ -46,10 +44,6 @@
href: actors/testing-actor-systems.md
- name: Coordinated Shutdown
href: actors/coordinated-shutdown.md
- name: HOCON
items:
- name: HOCON Syntax and Practices in Akka.NET
href: hocon/index.md
- name: Persistence
items:
- name: Architecture
Expand Down

0 comments on commit 7cce1a6

Please sign in to comment.