You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "samueleresca (via GitHub)" <gi...@apache.org> on 2023/05/16 12:38:04 UTC
[GitHub] [incubator-pekko] samueleresca opened a new pull request, #321: Describe current project state and how to contribute
samueleresca opened a new pull request, #321:
URL: https://github.com/apache/incubator-pekko/pull/321
This PR is related to #112. The PR (and these changes) need to be discussed in the mailing list. Any feedback/suggestion is welcome.
Changes in `README.MD`:
- Added the current status message.
- Updated the Documentation pointing to https://pekko.apache.org
- Added the Release Tracking
- Added the Repositories section pointing to the other repositories.
Changes in `CONTRIBUTING.MD`:
- Removed the labels not used by the project
- Moved the TLDR regarding the workflow on top.
--
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
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #321: Describe current project state and how to contribute
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on code in PR #321:
URL: https://github.com/apache/incubator-pekko/pull/321#discussion_r1200264446
##########
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:
I generally don't agree with most of the changes here and kind of think that this stuff is better driven via issues or email discussion than PRs.
I definitely don't think that the README in this Git repo is our main doc. Our main doc is https://pekko.apache.org
I have taken this 'repositories' section and included it at https://pekko.apache.org/modules.html
--
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
[GitHub] [incubator-pekko] samueleresca commented on a diff in pull request #321: Describe current project state and how to contribute
Posted by "samueleresca (via GitHub)" <gi...@apache.org>.
samueleresca commented on code in PR #321:
URL: https://github.com/apache/incubator-pekko/pull/321#discussion_r1203854023
##########
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:
Thanks for the feedback. Right now, there is a conversation (resumed from a past discussion) in the mailing list, see https://lists.apache.org/thread/8gnbv8g8z9fjlnlgbp903f51f3fd8634. I'm happy to reopen a thread with the "[DISCUSS]" tag. Also, I agree with the "avoid duplication" point:
- I'm proceeding by taking in the changes added yesterday to point to the actual documentation.
- I'm proceeding by removing the "Repository" section, as it would lead to duplication.
--
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
[GitHub] [incubator-pekko] Claudenw commented on a diff in pull request #321: Describe current project state and how to contribute
Posted by "Claudenw (via GitHub)" <gi...@apache.org>.
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
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #321: Describe current project state and how to contribute
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on code in PR #321:
URL: https://github.com/apache/incubator-pekko/pull/321#discussion_r1202312745
##########
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:
a PR merged today has added a link to the pekko.apache.org docs
--
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
[GitHub] [incubator-pekko] mdedetrich commented on a diff in pull request #321: Describe current project state and how to contribute
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on code in PR #321:
URL: https://github.com/apache/incubator-pekko/pull/321#discussion_r1201847417
##########
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:
If we are specifically dealing with contributing, the convention is to put a cheat sheet/quick start guide in `CONTRIBUTING.md` in the root git repo (this convention is also followed by github, i.e. it will pick it up and reference it when someone tries to make a PR).
Of course within that `CONTRIBUTING.md` you can always reference to the actuals docs which will be hosted on the main `https://pekko.apache.org/` site.
--
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
[GitHub] [incubator-pekko] He-Pin commented on pull request #321: Describe current project state and how to contribute
Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on PR #321:
URL: https://github.com/apache/incubator-pekko/pull/321#issuecomment-1556460573
Thank
--
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
[GitHub] [incubator-pekko] Claudenw commented on a diff in pull request #321: Describe current project state and how to contribute
Posted by "Claudenw (via GitHub)" <gi...@apache.org>.
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.
I also note that this pull request is a draft and I think it is a good start as it provides us with a view of exactly what is being suggested. Back when I reviewed ticket #112 I suggested that a discussion be opened on the mailing list with a "[DISCUSS]" tag. @samueleresca please start the conversation in the mailing list.
I think that we need to look at different paths to finding Pekko. Some will come in via apahce.org and simply use the library. We might call them consumers (I hate the term "users" -- that is what drug dealers have). The second group will be looking for how to contribute and will come via github. For this group the dev centered documentation should start in the README.
--
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
[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #321: Describe current project state and how to contribute
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on code in PR #321:
URL: https://github.com/apache/incubator-pekko/pull/321#discussion_r1202311794
##########
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:
With the small team and the large number of repos - duplicated docs are turning into a real maintenance nightmare. I have no problem linking to one source of truth.
--
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