Update README.md
1 file changed
tree: 49950f7f48cd5539d991f12ebd9ee61fd9855053
  1. .asf.yaml
  2. .gitignore
  3. DISCLAIMER
  4. LICENSE
  5. NOTICE
  6. README.md
README.md

incubator-pekko-site

Status

This repo is a temporary solution to publishing the Apache Pekko website. The artifacts are built in the Pekko modules. A Pekko committer can use the commands below to copy these artifacts and commit them.

Anyone looking to help improve our docs should look at the Git repos (eg incubator-pekko) for the modules. Typically, sbt docs/paradoxBrowse will build the docs and load them into your browser when they are ready.

Publishing

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. 3a. In incubator-pekko repo, run
sbt unidoc docs/paradox
# next line requires Java 11 or above
sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc

3b. Go back to your local copy of incubator-pekko-site and run

mkdir -p content/docs/pekko/current/
mkdir -p content/api/pekko/current/
mkdir -p content/japi/pekko/current/

3c. Remain in 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/

4a. In incubator-pekko-http repo, run

sbt unidoc docs/paradox
# next line requires Java 11 or above
sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc 

4b. Go back to your local copy of incubator-pekko-site and run

mkdir -p content/docs/pekko-http/current/
mkdir -p content/api/pekko-http/current/
mkdir -p content/japi/pekko-http/current/

4c. Remain in incubator-pekko-site and run

cp -r <path>/incubator-pekko-http/docs/target/paradox/site/main/ content/docs/pekko-http/current/
cp -r <path>/incubator-pekko-http/target/scala-2.13/unidoc/ content/api/pekko-http/current/
cp -r <path>/incubator-pekko-http/target/javaunidoc/ content/japi/pekko-http/current/
  1. Perform git add on the affected files and git commit.
  2. Perform git push.
  3. After a few minutes review https://pekko.staged.apache.org and make sure the appropriate changes are present.
  4. Once the site has been approved checkout the asf-site branch.
  5. Perform git rebase asf-staging followed by git push.
  6. After a few minutes verify that https://pekko.apache.org has the correct changes.

This approach is based on the support for publishing sites provided by INFRA team. See .asf.yaml features documentation.

This approach is based on the Apache Flume process, see How to Release - Update the Web Site.