Skip to content

Akka.NET Documentation Improvement Proposal #5483

Open
@eaba

Description

[WIP] Fix fragemented documentations

Add Getting Started section
  • Added getting started to documentation #5500
  • Create ~/articles/intro/getting-started
  • Create ~/articles/intro/getting-started/tutorial-overview.md this will describe everything about the application to be built to serve as as hook for the user.
  • Move ~/articles/intro/tutorial-1.md --> ~/articles/intro/getting-started/tutorial-1.md
  • Move ~/articles/intro/tutorial-2.md --> ~/articles/intro/getting-started/tutorial-2.md
  • Move ~/articles/intro/tutorial-3.md --> ~/articles/intro/getting-started/tutorial-3.md
  • Move ~/articles/intro/tutorial-4.md --> ~/articles/intro/getting-started/tutorial-4.md

Reorganize Configuration

  • Move ~/articles/hocon/index.md --> ~/articles/configuration/hocon.md
  • Add ~/articles/configuration/index.md - new page that explains how configuration works in Akka.NET, best practices, links to bootcamp section on fallbacks.
  • Move ~/articles/configuration/* (all of the module-specific configurations) --> ~/articles/configuration/modules/*
  • Create ~/articles/deployment (all of the deployment scenarios) --> ~~/articles/deployment/*

I think we should do it this way so all of the configuration pages fall under a single area. The configs for each module will be kept in the same area as where we explain conceptually how config works, how HOCON works, and best practices for using it.

Update UntypedActor to ReceiveActor

  • ~/articles/actors/fault-tolerance.md
  • revise ~/articles/actors/untyped-actor-api.md

Improve Getting Started Guide

  • Rename ~/articles/intro to ~/articles/getting-started-guide
  • Rename ~/articles/intro/what-is-akka.md to ~/articles/getting-started-guide/introduction-to-akka.md and update content
  • Split ~/articles/intro/what-problems-does-actor-model-solve.md into ~/articles/getting-started-guide/why-modern-systems-need-a-new-programming-model.md and ~/articles/getting-started-guide/how-the-actor-model-meets-the-needs-of-modern-distributed-systems.md, and update content where necessary.
  • Add a link for downloading code sample

Update Actor - add more sections

  • Create ~/articles/actors/Introduction/Actors.md
  • Create ~/articles/actors/Introduction/creating-actors.md
  • Create ~/articles/actors/Introduction/actor-api.md
  • Create ~/articles/actors/Introduction/actor-api.md
  • Create ~/articles/actors/Introduction/identitying-actors-via-actor-selection.md
  • Create ~/articles/actors/Introduction/messages-and-immutability.md
  • Create ~/articles/actors/Introduction/send-messages.md
  • Create ~/articles/actors/Introduction/receive-messages.md
  • Create ~/articles/actors/Introduction/reply-to-messages.md
  • Create ~/articles/actors/Introduction/receive-timeout.md
  • Create ~/articles/actors/Introduction/timers-scheduled-messages.md
  • Create ~/articles/actors/Introduction/stopping-actors.md
  • Create ~/articles/actors/Introduction/become-unbecome.md
  • Create ~/articles/actors/Introduction/stash.md
  • Create ~/articles/actors/Introduction/extending-actors.md
  • Create ~/articles/actors/Introduction/initialization-pattern.md

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions