Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add site #71

Merged
merged 10 commits into from
Nov 15, 2023
Merged

Add site #71

merged 10 commits into from
Nov 15, 2023

Conversation

ennru
Copy link
Member

@ennru ennru commented Nov 14, 2023

Add site to show all current versions of the all Akka umbrella dependencies.

https://doc.akka.io/docs/akka-dependencies/snapshot/

At the core of Akka: A model for concurrency and distribution without all the pain of threading primitives.

[Documentation](https://doc.akka.io/docs/akka/current/) [JavaDoc](https://doc.akka.io/japi/akka/current/index.html) [ScalaDoc](https://doc.akka.io/api/akka/current/akka/)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In an earlier draft you had a page dependencies-listing.html that showed all artifact names in copy paste friendly build formats for maven, gradle, sbt. I think that would be useful.

Maybe it could be incorporated in this page?

## Akka (core)
...
### Akka Actors
...
### Akka Cluster
...
...
### Dependencies listing
maven/gradle/sbt
...
## Akka gRPC
...
### Dependencies listing
maven/gradle/sbt

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added those in the page. I think it gets too large with the Maven view...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depends on what the purpose of the page is. We have better pages for brief overview, such as the Akka docs landing page.

I see the purpose as:

  • what is the latest version? and which versions should I use together? (the table answers that)
  • what shall I paste in the build to add x? (I already know how to use the feature and I don't want to browse various reference doc pages to find it)

Copy link
Member

@johanandren johanandren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with that scalaVersion added

previewPath := (Paradox / siteSubdirName).value,
Paradox / siteSubdirName := s"docs/akka-dependencies/${projectInfoVersion.value}",
projectInfoVersion := (if (isSnapshot.value) "snapshot" else version.value),
publish / skip := true,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does the trick for build tool Scala versions:

Suggested change
publish / skip := true,
publish / skip := true,
scalaVersion = "2.13.12",

@ennru ennru merged commit 725285c into main Nov 15, 2023
2 of 3 checks passed
@ennru ennru deleted the ennru-add-site branch November 15, 2023 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants