You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@teaclave.apache.org by ms...@apache.org on 2020/06/18 23:53:38 UTC
[incubator-teaclave] branch master updated: Update docs
organization (#362)
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.git
The following commit(s) were added to refs/heads/master by this push:
new 015c189 Update docs organization (#362)
015c189 is described below
commit 015c18969ea16c6500b971de6da0a0d508ad427d
Author: Mingshen Sun <bo...@mssun.me>
AuthorDate: Thu Jun 18 16:53:28 2020 -0700
Update docs organization (#362)
---
CONTRIBUTORS.md | 3 +++
README.md | 7 +++++++
attestation/README.md | 2 +-
cli/README.md | 2 +-
config/README.md | 2 +-
dcap/README.md | 2 +-
docker/README.md | 2 +-
docs/README.md | 36 ++++++++++++++++++++++++++++++++----
examples/README.md | 2 +-
executor/README.md | 2 +-
file_agent/README.md | 2 +-
function/README.md | 2 +-
keys/README.md | 2 +-
rpc/README.md | 2 +-
runtime/README.md | 2 +-
sdk/README.md | 2 +-
services/README.md | 2 +-
tests/README.md | 2 +-
third_party/README.md | 2 +-
worker/README.md | 2 +-
20 files changed, 59 insertions(+), 21 deletions(-)
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
index 98c06ab..e1fe2fc 100644
--- a/CONTRIBUTORS.md
+++ b/CONTRIBUTORS.md
@@ -61,14 +61,17 @@ List of external contributors of Teaclave and Teaclave SGX SDK (in alphabetical
- [Shi Wenbin](https://github.com/bradyjoestar)
- [Sythanos](https://github.com/sythanos)
- [T0day](https://github.com/hi-T0day)
+ - [Tianjia Zhang](https://github.com/uudiin)
- [akoskinas](https://github.com/akoskinas)
- [czzmmc](https://github.com/czzmmc)
- [devashishdxt](https://github.com/devashishdxt)
- [garbageslam](https://github.com/garbageslam)
+ - [h4x3rotab](https://github.com/h4x3rotab)
- [lhf](https://github.com/EighteenZi)
- [luoyanhua2011](https://github.com/luoyanhua2011)
- [lyj](https://github.com/lengyijun)
- [piotr-roslaniec](https://github.com/piotr-roslaniec)
+ - [rebol0x6c](https://github.com/rebol0x6c)
- [volcano](https://github.com/volcano0dr)
- [zEqueue](https://github.com/z1queue)
diff --git a/README.md b/README.md
index ab9aae5..b2d554b 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,13 @@ platform, making computation on privacy-sensitive data safe and simple.
- [Test Harness and Test Cases](tests)
- [Third-Party Dependency Vendoring](third_party)
+### API Docs
+
+- [Teaclave SGX SDK](https://teaclave.apache.org/docs/sgx-sdk/)
+- [Teaclave Client SDK (Python)](https://teaclave.apache.org/docs/client-sdk-python/)
+- [Crates in Teaclave (Enclave)](https://teaclave.apache.org/docs/crates-enclave/)
+- [Crates in Teaclave (App)](https://teaclave.apache.org/docs/crates-app/)
+
## Contributing
Teaclave is open source in [The Apache Way](https://www.apache.org/theapacheway/),
diff --git a/attestation/README.md b/attestation/README.md
index 9a4e375..e5b668f 100644
--- a/attestation/README.md
+++ b/attestation/README.md
@@ -1,5 +1,5 @@
---
-permalink: /attestation
+permalink: /docs/codebase/attestation
---
# Attestation in Teaclave
diff --git a/cli/README.md b/cli/README.md
index 8ce913c..81b879e 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -1,5 +1,5 @@
---
-permalink: /cli
+permalink: /docs/codebase/cli
---
# Teaclave Command Line Tool
diff --git a/config/README.md b/config/README.md
index 71fb128..a44157a 100644
--- a/config/README.md
+++ b/config/README.md
@@ -1,5 +1,5 @@
---
-permalink: /config
+permalink: /docs/codebase/config
---
# Configurations in Teaclave
diff --git a/dcap/README.md b/dcap/README.md
index 1f3c665..c800921 100644
--- a/dcap/README.md
+++ b/dcap/README.md
@@ -1,5 +1,5 @@
---
-permalink: /dcap
+permalink: /docs/codebase/dcap
---
# Data Center Attestation Service
diff --git a/docker/README.md b/docker/README.md
index bc5d211..ce7e5ca 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,5 +1,5 @@
---
-permalink: /docker
+permalink: /docs/codebase/docker
---
# Teaclave Docker
diff --git a/docs/README.md b/docs/README.md
index ef5a1e7..b484c76 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,11 +4,39 @@ permalink: /docs/
# Teaclave Documentation
+## Try
+
+- [How to Add Built-in Functions](builtin-functions.md)
+- [My First Function](my-first-function.md)
+
+## Design
+
- [Access Control in Teaclave](access-control.md)
- [Build System](build-system.md)
-- [How to Add Built-in Functions](builtin-functions.md)
- [Mutual Attestation: Why and How](mutual-attestation.md)
-- [My First Function](my-first-function.md)
-- [Rust Development Guideline](rust-guideline.md)
-- [Development Tips](development-tips.md)
- [Threat Model](threat-model.md)
+
+## Contribute
+
+- [Development Tips](development-tips.md)
+- [Rust Development Guideline](rust-guideline.md)
+
+## Codebase
+
+- [Attestation](../attestation/README.md)
+- [Built-in Functions](../function/README.md)
+- [Client SDK](../sdk/README.md)
+- [Command Line Tool](../cli/README.md)
+- [Configurations in Teaclave](../config/README.md)
+- [Data Center Attestation Service](../dcap/README.md)
+- [Dockerfile and Compose File](../docker/README.md)
+- [Examples](../examples/README.md)
+- [Executor Runtime](../runtime/README.md)
+- [File Agent](../file_agent/README.md)
+- [Function Executors](../executor/README.md)
+- [Keys and Certificates](../keys/README.md)
+- [RPC](../rpc/README.md)
+- [Teaclave Services](../services/README.md)
+- [Teaclave Worker](../worker/README.md)
+- [Test Harness and Test Cases](../tests/README.md)
+- [Third-Party Dependency Vendoring](../third_party/README.md)
diff --git a/examples/README.md b/examples/README.md
index 861d719..18d65bb 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,5 +1,5 @@
---
-permalink: /examples
+permalink: /docs/codebase/examples
---
# Examples
diff --git a/executor/README.md b/executor/README.md
index 5e1369b..3f018dc 100644
--- a/executor/README.md
+++ b/executor/README.md
@@ -1,5 +1,5 @@
---
-permalink: /executor
+permalink: /docs/codebase/executor
---
# Function Executors
diff --git a/file_agent/README.md b/file_agent/README.md
index 6408f8f..509fe75 100644
--- a/file_agent/README.md
+++ b/file_agent/README.md
@@ -1,5 +1,5 @@
---
-permalink: /file-agent
+permalink: /docs/codebase/file-agent
---
# File Agent
diff --git a/function/README.md b/function/README.md
index fbcfc92..b856b57 100644
--- a/function/README.md
+++ b/function/README.md
@@ -1,5 +1,5 @@
---
-permalink: /function
+permalink: /docs/codebase/function
---
# Built-in Functions
diff --git a/keys/README.md b/keys/README.md
index 42b6e48..2973b80 100644
--- a/keys/README.md
+++ b/keys/README.md
@@ -1,5 +1,5 @@
---
-permalink: /keys
+permalink: /docs/codebase/keys
---
# Keys and Certificates in Teaclave
diff --git a/rpc/README.md b/rpc/README.md
index 1439f90..d26e70b 100644
--- a/rpc/README.md
+++ b/rpc/README.md
@@ -1,5 +1,5 @@
---
-permalink: /rpc
+permalink: /docs/codebase/rpc
---
# RPC
diff --git a/runtime/README.md b/runtime/README.md
index bad651a..67efc2a 100644
--- a/runtime/README.md
+++ b/runtime/README.md
@@ -1,5 +1,5 @@
---
-permalink: /runtime
+permalink: /docs/codebase/runtime
---
# Executor Runtime
diff --git a/sdk/README.md b/sdk/README.md
index 5284ec3..b299518 100644
--- a/sdk/README.md
+++ b/sdk/README.md
@@ -1,5 +1,5 @@
---
-permalink: /sdk
+permalink: /docs/codebase/sdk
---
# Client SDK
diff --git a/services/README.md b/services/README.md
index ad6c6ca..8d5df52 100644
--- a/services/README.md
+++ b/services/README.md
@@ -1,5 +1,5 @@
---
-permalink: /services
+permalink: /docs/codebase/services
---
# Teaclave Services
diff --git a/tests/README.md b/tests/README.md
index c641e86..02244fa 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,5 +1,5 @@
---
-permalink: /tests
+permalink: /docs/codebase/tests
---
# Test Harness and Test Cases
diff --git a/third_party/README.md b/third_party/README.md
index 9e60ed2..0b94b62 100644
--- a/third_party/README.md
+++ b/third_party/README.md
@@ -1,5 +1,5 @@
---
-permalink: /third-party
+permalink: /docs/codebase/third-party
---
# Third-Party Dependency Vendoring
diff --git a/worker/README.md b/worker/README.md
index 1907a21..97c792b 100644
--- a/worker/README.md
+++ b/worker/README.md
@@ -1,5 +1,5 @@
---
-permalink: /worker
+permalink: /docs/codebase/worker
---
# Teaclave Worker
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@teaclave.apache.org
For additional commands, e-mail: commits-help@teaclave.apache.org