Skip to content

Commit 7937b14

Browse files
committed
docs: remove emojis from headings
1 parent 9294d42 commit 7937b14

File tree

5 files changed

+18
-8
lines changed

5 files changed

+18
-8
lines changed

docs/docs/getting-started/examples.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Examples 🧪
1+
# Examples
22

33
Just installed EGo? Here are some examples to start your confidential development process.
44

@@ -19,6 +19,7 @@ Similar to the above, but the server manages remote attestation by itself. This
1919
Vault is a common way to store secrets and share them on dynamic infrastructures. With EGo, you can build a confidential version of unmodified Vault.
2020

2121
## [WebAssembly with Wasmer](https://github.com/edgelesssys/ego/tree/master/samples/wasmer)
22+
2223
You can run WebAssembly inside EGo using Wasmer.
2324

2425
## [Microsoft Azure Attestation (MAA)](https://github.com/edgelesssys/ego/tree/master/samples/azure_attestation)

docs/docs/getting-started/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installing EGo 📦
1+
# Installing EGo
22

33
## Install the snap
44

docs/docs/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
slug: /
33
---
44

5-
# Welcome to EGo 🎉
5+
# Welcome to EGo
66

77
EGo is a framework for building *confidential apps* in Go. Confidential apps run in secure execution environments called *enclaves*. Enclaves are strongly isolated, runtime encrypted, and attestable. Enclaves can be created on Intel processors that have the SGX (Software Guard Extensions) feature.
88

99
In essence, EGo lets you run any Go program inside an enclave - without requiring modifications. Apps that benefit from enclaves are typically server applications that deal with sensitive data like cryptographic keys or payment data. HashiCorp Vault is a great example of such an app.
1010

11-
## Philosophy 🎓
11+
## Philosophy
1212

1313
EGo's goal is to bridge the gap between cloud-native and confidential computing. EGo's philosophy is to get as many enclave specifics out of your way as possible. Fundamentally, building and running an enclave with EGo is as simple as building and running an app with normal Go:
1414

@@ -18,7 +18,7 @@ ego sign myapp
1818
ego run myapp
1919
```
2020

21-
## Architecture 🏗
21+
## Architecture
2222

2323
In a nutshell, EGo comprises a modified Go compiler, additional tooling, and a Go library.
2424

docs/docs/workflows/build.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Build your app with EGo 👷‍♀️
1+
# Build your app with EGo
22

33
## `ego-go` replaces `go`
44

@@ -10,7 +10,7 @@ ego-go build
1010

1111
## Sign and run
1212

13-
After you've built your app, sign it with the [`ego sign`](../reference/cli.md#sign) command. Just insert the name of your binary in the following command:
13+
After you've built your app, sign it with the [`ego sign`](../reference/cli.md#ego-sign) command. Just insert the name of your binary in the following command:
1414

1515
```bash
1616
ego sign <executable>
@@ -21,6 +21,7 @@ Run the executable with
2121
```bash
2222
ego run <executable>
2323
```
24+
2425
You can set the `OE_SIMULATION=1` environment variable if you want to simulate the enclave, e.g. for development on hardware that doesn't support enclaves.
2526

2627
Look at the [example collection](../getting-started/examples.md) if you want to see the build process in action.

docs/docs/workflows/debug.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
# Debug your app 🔬
1+
# Debug your app
2+
23
EGo executables can be debugged inside as well as outside of enclaves. Depending on the task, you may prefer one or the other.
34

45
## Outside an enclave
6+
57
An EGo executable can be run as a normal host process without an enclave. Thus, it can also be debugged like any other Go program. This should be your first attempt if the problem isn't related to specific enclave functionality. Use your favorite tools (e.g. the Delve debugger) as usual.
68

79
## Inside an enclave
10+
811
EGo comes with `ego-gdb` that augments `gdb` with enclave support. The `console` interface is the same as `gdb`:
12+
913
```bash
1014
ego-gdb --args ./helloworld
1115
```
@@ -17,7 +21,9 @@ Setting up the `mi` interface for VSCode is a bit trickier. First, install the [
1721
Use one of the following templates for your `.vscode/launch.json` file. Just replace `samples/helloworld/helloworld` with the path to your EGo executable.
1822

1923
### Snap
24+
2025
If you installed the EGo snap, use this:
26+
2127
```json
2228
{
2329
"version": "0.2.0",
@@ -57,7 +63,9 @@ If you installed the EGo snap, use this:
5763
```
5864

5965
### DEB package or built from source
66+
6067
If you installed the DEB package or built it yourself, use this:
68+
6169
```json
6270
{
6371
"version": "0.2.0",

0 commit comments

Comments
 (0)