This is an automated email from the ASF dual-hosted git repository.
mssun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-teaclave-website.git
The following commit(s) were added to refs/heads/master by this push:
new e4af5e0 Update README and explain the TEACLAVE_TARGET_DIR env
e4af5e0 is described below
commit e4af5e0d2355aa638743418f66a1d9cb286e9b1c
Author: Mingshen Sun <[email protected]>
AuthorDate: Thu Oct 22 13:15:28 2020 -0700
Update README and explain the TEACLAVE_TARGET_DIR env
---
README.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 98f58bd..6afc3a6 100644
--- a/README.md
+++ b/README.md
@@ -17,10 +17,14 @@ make dev
To commit generated files to the `asf-staging` and `asf-site` branches you can
call:
```
-make asf-staging
-make asf-site
+TEACLAVE_TARGET_DIR=xxx make asf-staging
+TEACLAVE_TARGET_DIR=xxx make asf-site
```
+This command will also copy the document generated by Teaclave. Therefore,
+please `make doc` in Teaclave to generate documents and set the
+`TEACLAVE_TARGET_DIR` environment to the target directory.
+
When pushing the branches to remote, the site are automatically deployed to
the following links.
- `asf-staging`: https://teaclave.staged.apache.org (for preview)
- `asf-site`: https://teaclave.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
