You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/architecture/containers/components/webassembly_module/index.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,4 +11,5 @@ Ocre containers use [WebAssembly (WASM)](https://webassembly.org/) modules as th
11
11
12
12
Modules can either be pure WebAssembly or Ahead-of-Time (AOT) compiled binaries optimized for a specific platform target. In general, the Ocre Orchestration Hub will automatically AOT compile modules on-demand based on the architecture of the deployment target. However, there are instances where a pure WASM binary may be preferred.
13
13
14
-
**Note:** Currently, only a single WASM module is supported per container image. However, we are exploring extending this to support multiple modules and/or components via the WebAssembly Component Model.
14
+
{: .note}
15
+
Currently, only a single WASM module is supported per container image. However, we are exploring extending this to support multiple modules and/or components via the WebAssembly Component Model.
Copy file name to clipboardExpand all lines: docs/quickstart/prerequisites/dev-environment/index.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,7 @@ title: Setting Up Your Development Environment
3
3
layout: default
4
4
parent: Prerequisites
5
5
nav_order: 1
6
+
has_toc: true
6
7
---
7
8
8
9
# Setting Up Your Development Environment
@@ -28,7 +29,8 @@ Before you begin, ensure that you have the following tools installed on your dev
28
29
2.[Visual Studio Code](https://code.visualstudio.com/): A lightweight but powerful source code editor.
29
30
3.[Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): This extension allows you to use Docker containers as development environments within VS Code.
30
31
31
-
**Note:** The dev container can also be run directly in GitHub via [CodeSpaces](https://docs.github.com/en/codespaces), though you will only be able to build Ocre containers, not load them on your device as the dev container will not have access to your local devices.
32
+
{: .note}
33
+
The dev container can also be run directly in GitHub via [CodeSpaces](https://docs.github.com/en/codespaces), though you will only be able to build Ocre containers, not load them on your device as the dev container will not have access to your local devices.
32
34
33
35
### Steps
34
36
@@ -44,7 +46,8 @@ Before you begin, ensure that you have the following tools installed on your dev
44
46
45
47
Once you select the folder, VS Code will reload. If the container does not exist yet, it will automatically create one and clone the sample repository into an isolated container volume. This process may take a few moments, and progress will be displayed in the lower right corner of the VS Code window. After the container is ready, you can open a terminal within VS Code to access the container environment.
46
48
47
-
**Note**: Additional documentation and a step-by-step guide for working with dev containers can be found [here](https://code.visualstudio.com/docs/remote/containers-tutorial).
49
+
{: .note}
50
+
Additional documentation and a step-by-step guide for working with dev containers can be found [here](https://code.visualstudio.com/docs/remote/containers-tutorial).
48
51
49
52
---
50
53
@@ -60,4 +63,10 @@ The toolchain container can also be launched and used interactively as follows:
60
63
```sh
61
64
cd samples
62
65
docker run --rm -it -v $(pwd):/home/ocre ocre/ocre-c-toolchain:latest
63
-
```
66
+
```
67
+
---
68
+
69
+
## Troubleshooting
70
+
This section covers common issues you might encounter when setting up your development environment, along with their solutions.
71
+
72
+
- If you encounter errors opening the dev container, you likely need to authenticate with the GitHub Container Registry. Follow the authentication steps in the [GitHub documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).
0 commit comments