Skip to content

Commit

Permalink
adjust links to new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasten committed Oct 25, 2022
1 parent 7a0c6c6 commit 756b0bf
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The Coordinator starts with the following default values. You can set your desir

### Create a Manifest

See the [how to add a service](https://docs.edgeless.systems/marblerun/#/workflows/add-service) documentation on how to create a Manifest.
See the [how to add a service](https://docs.edgeless.systems/marblerun/workflows/add-service) documentation on how to create a Manifest.
You can find the test enclave's specific values (MRENCLAVE, MRSIGNER, etc.) in `build/marble-test-config.json`:

```bash
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ The popular [Linkerd][linkerd] service mesh uses the simple and scalable *emojiv
[edgelessrt]: https://github.com/edgelesssys/edgelessrt
[ego]: https://github.com/edgelesssys/ego
[emojivoto]: https://github.com/edgelesssys/emojivoto
[getting-started]: https://docs.edgeless.systems/marblerun/#/getting-started/quickstart
[getting-started]: https://docs.edgeless.systems/marblerun/getting-started/quickstart
[github-actions]: https://github.com/edgelesssys/marblerun/actions
[github-actions-badge]: https://github.com/edgelesssys/marblerun/workflows/Unit%20Tests/badge.svg
[go-pkg]: https://pkg.go.dev/github.com/edgelesssys/marblerun
Expand Down
4 changes: 2 additions & 2 deletions charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Documentation

See the [Getting Started Guide](https://docs.edgeless.systems/marblerun/#/getting-started/quickstart) to set up a distributed confidential-computing app in a few simple steps.
For more comprehensive documentation, start with the [docs](https://docs.edgeless.systems/marblerun/#/).
See the [Getting Started Guide](https://docs.edgeless.systems/marblerun/getting-started/quickstart) to set up a distributed confidential-computing app in a few simple steps.
For more comprehensive documentation, start with the [docs](https://docs.edgeless.systems/marblerun).

## Add Repository (stable)

Expand Down
2 changes: 1 addition & 1 deletion samples/gramine-redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Instead of running a single [Redis](https://redis.io/) server instance, MarbleRu
*Prerequisite:*

* Ensure you have access to a Kubernetes cluster with SGX-enabled nodes and kubectl installed and configured. Probably the easiest way to get started is to run Kubernetes on an [Azure Kubernetes Service (AKS)](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-enclave-nodes-aks-get-started), which offers SGX-enabled nodes.
* Ensure you have the [MarbleRun CLI](https://docs.edgeless.systems/marblerun/#/reference/cli) installed.
* Ensure you have the [MarbleRun CLI](https://docs.edgeless.systems/marblerun/reference/cli) installed.

## Kubernetes deployment walkthrough

Expand Down
4 changes: 2 additions & 2 deletions samples/helloc++/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# How to create a C++ Marble

This example shows how to build a confidential C++ application and run it in MarbleRun. This can serve you as a blueprint for making existing applications MarbleRun-ready or creating new [Marbles](https://docs.edgeless.systems/marblerun/#/getting-started/marbles). If you haven't already, [setup MarbleRun](../../BUILD.md#build) to get ready.
This example shows how to build a confidential C++ application and run it in MarbleRun. This can serve you as a blueprint for making existing applications MarbleRun-ready or creating new [Marbles](https://docs.edgeless.systems/marblerun/getting-started/marbles). If you haven't already, [setup MarbleRun](../../BUILD.md#build) to get ready.

**Note:** You can run this example on any hardware by simulating the enclave through setting `OE_SIMULATION=1` as environment variable. This might help you to get started with with the development of confidential apps. However, please notice that this bypasses any security. Detailed information on how to develop secure Marbles can be found in [MarbleRun's documentation](https://docs.edgeless.systems/marblerun/#/workflows/add-service).
**Note:** You can run this example on any hardware by simulating the enclave through setting `OE_SIMULATION=1` as environment variable. This might help you to get started with with the development of confidential apps. However, please notice that this bypasses any security. Detailed information on how to develop secure Marbles can be found in [MarbleRun's documentation](https://docs.edgeless.systems/marblerun/workflows/add-service).

The directory `app` contains the application code:

Expand Down
4 changes: 2 additions & 2 deletions samples/helloworld/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# How to build a helloworld Marble

This example shows how to build a confidential Go application with [EGo](https://ego.dev) and run it in MarbleRun. This can serve you as a blueprint for making existing applications MarbleRun-ready or creating new [Marbles](https://docs.edgeless.systems/marblerun/#/getting-started/marbles). If you haven't already, [setup MarbleRun](../../BUILD.md#build) and EGo to get ready.
This example shows how to build a confidential Go application with [EGo](https://ego.dev) and run it in MarbleRun. This can serve you as a blueprint for making existing applications MarbleRun-ready or creating new [Marbles](https://docs.edgeless.systems/marblerun/getting-started/marbles). If you haven't already, [setup MarbleRun](../../BUILD.md#build) and EGo to get ready.

**Note:** You can run this example on any hardware by simulating the enclave through setting `OE_SIMULATION=1` as environment variable. This might help you to get started with with the development of confidential apps. However, please notice that this bypasses any security. Detailed information on how to develop secure Marbles can be found in [MarbleRun's documentation](https://docs.edgeless.systems/marblerun/#/workflows/add-service).
**Note:** You can run this example on any hardware by simulating the enclave through setting `OE_SIMULATION=1` as environment variable. This might help you to get started with with the development of confidential apps. However, please notice that this bypasses any security. Detailed information on how to develop secure Marbles can be found in [MarbleRun's documentation](https://docs.edgeless.systems/marblerun/workflows/add-service).

You can build and sign the example (or your app) like this:

Expand Down

0 comments on commit 756b0bf

Please sign in to comment.