[incubator-pekko-site] branch main updated: synch with asf-site branch

[fa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-site.git


The following commit(s) were added to refs/heads/main by this push:
     new 498d609a synch with asf-site branch
498d609a is described below

commit 498d609a1198a0552be2d17037034d149d5c6a9b
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Tue Jan 31 01:37:09 2023 +0100

    synch with asf-site branch
---
 README.md | 27 +++++++++++++++++++--------
 1 file changed, 19 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index aa56949d..20769f9f 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,24 @@ Publishing the Apache Pekko web site requires:
 
 1. Clone https://github.com/apache/incubator-pekko-site into a local directory.
 2. Check out the asf-staging branch.
-3. If you have used `sbt docs/paradox` in `incubator-pekko` repo, you can use `cp -r <path>/incubator-pekko/docs/target/paradox/site/main/ content/`
-4. Perform `git add` on the affected files and `git commit`.
-5. Perform `git push`.
-6. After a few minutes review https://pekko.staged.apache.org and make sure the appropriate changes are present.
-7. Once the site has been approved checkout the asf-site branch.
-8. Perform `git rebase asf-staging` followed by `git push`.
-9. After a few minutes verify that https://pekko.apache.org has the correct changes.
+3. In `incubator-pekko` repo, run
+```
+sbt unidoc docs/paradox
+# next line requires Java 11 or above
+sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc 
+```
+4. Go back to your local copy of `incubator-pekko-site` and run
+```
+cp -r <path>/incubator-pekko/docs/target/paradox/site/main/ content/docs/pekko/current
+cp -r <path>/incubator-pekko/target/scala-2.13/unidoc/ content/api/pekko/current
+cp -r <path>/incubator-pekko/target/javaunidoc/ content/japi/pekko/current
+```
+5. Perform `git add` on the affected files and `git commit`.
+6. Perform `git push`.
+7. After a few minutes review https://pekko.staged.apache.org and make sure the appropriate changes are present.
+8. Once the site has been approved checkout the asf-site branch.
+9. Perform `git rebase asf-staging` followed by `git push`.
+10. After a few minutes verify that https://pekko.apache.org has the correct changes.
 
-Further information regarding what to edit in the site during a release may be found at 
+Further information regarding what to edit in the site during a release may be found at
 [How to Release - Update the Web Site](https://cwiki.apache.org/confluence/display/FLUME/How+to+Release#HowtoRelease-Updatethewebsite).


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org