You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "Claudenw (via GitHub)" <gi...@apache.org> on 2023/05/23 06:52:30 UTC
[GitHub] [incubator-pekko] Claudenw commented on a diff in pull request #321: Describe current project state and how to contribute
Claudenw commented on code in PR #321:
URL: https://github.com/apache/incubator-pekko/pull/321#discussion_r1201623395
##########
README.md:
##########
@@ -4,16 +4,48 @@ Apache Pekko
[](https://github.com/apache/incubator-pekko/actions/workflows/nightly-builds.yml)
[](https://github.com/apache/incubator-pekko/actions/workflows/nightly-builds-aeron.yml)
-Apache Pekko is an open-source framework for building applications that are concurrent, distributed, resilient and elastic.
-Pekko uses the Actor Model to provide more intuitive high-level abstractions for concurrency.
+> Current status: We are currently working on the 1.0.0 milestone. we will be initially releasing incubator-pekko [1.0.0 Milestone](https://github.com/apache/incubator-pekko/milestone/1) and [incubator-pekko-sbt-paradox](https://github.com/apache/incubator-pekko-sbt-paradox/).
+
+Apache Pekko is an open-source framework for building applications that are concurrent, distributed, resilient and elastic. It uses the Actor Model to provide more intuitive high-level abstractions for concurrency.
Using these abstractions, Pekko also provides libraries for persistence, streams, HTTP, and more.
+Pekko is part of the Apache Incubator program and we are actively working towards a v1.0.0 release. It's not yet ready for production use, but please get involved with the community and contribute to the effort.
+
Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka project's adoption of the Business Source License.
Reference Documentation
-----------------------
-**TODO add documentation links**
+The reference documentation is available at [pekko.apache.org](https://pekko.apache.org/).
+
+Release tracking
+----------------
+
+The Pekko project spans multiple Github repositories. Work required for a whole Pekko project release (multiple repositories) is tracked in the [Apache Pekko Github project](https://github.com/orgs/apache/projects/220/views/1). Note that due to Apache Software Foundation regulations, this cannot be made public and is viewable only by Apache project [committers](https://www.apache.org/foundation/how-it-works.html#committers). Therefore non-committers check up on the Github Discussions and dev mailing list to confirm contents of the current in-development release.
+
+
+Repositories
Review Comment:
While the README may not be the "main doc" it is probably the fist point of contact for many people looking for documentation. And it will be displayed on the Github page.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org