Skip to content

Commit 66c06fc

Browse files
authored
Merge pull request lf-lang#225 from lf-lang/docusaurus-3.1.1
Upgrade docusaurus to v3.1.1
2 parents ed21fcf + 794d115 commit 66c06fc

File tree

4 files changed

+229
-228
lines changed

4 files changed

+229
-228
lines changed

docs/reference/containerized-execution.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The generated Docker file is simply called `Dockerfile` and will be put in the `
1515

1616

1717
## Unfederated Execution
18-
Suppose your LF source file is `src/Foo.lf`. When you run `lfc` or use the IDE to generate code, a file called `Dockerfile` and a file called `docker-compose.yml` will appear in the `src_gen/Foo` directory, see [Structure of an LF project](/docs/handbook/a-first-reactor#structure-of-an-lf-project) for more info.
18+
Suppose your LF source file is `src/Foo.lf`. When you run `lfc` or use the IDE to generate code, a file called `Dockerfile` and a file called `docker-compose.yml` will appear in the `src_gen/Foo` directory, see [Structure of an LF project](/docs/writing-reactors/a-first-reactor#structure-of-an-lf-project) for more info.
1919

2020
### Using docker compose up
2121
After running `lfc`, change to the directory that contains the generated sources. Then, use `docker compose up --build` to automatically build the Docker image and run the container. Once the container finishes execution, use `docker compose down` in the same directory where `docker-compose.yml` is located to remove the container.
@@ -48,7 +48,7 @@ The above run command can include any supported command-line arguments to the LF
4848
```
4949

5050
## Federated Execution
51-
Suppose your LF source file is `src/Fed.lf`. When you run `lfc` or use the IDE to generate code, a file called `Dockerfile` is created for each federate alongside its sources. Just like in the unfederated case, a single `docker-compose.yml` will appear in the `src_gen/Fed` directory, see [Structure of an LF project](/docs/handbook/a-first-reactor#structure-of-an-lf-project) for more info.
51+
Suppose your LF source file is `src/Fed.lf`. When you run `lfc` or use the IDE to generate code, a file called `Dockerfile` is created for each federate alongside its sources. Just like in the unfederated case, a single `docker-compose.yml` will appear in the `src_gen/Fed` directory, see [Structure of an LF project](/docs/writing-reactors/a-first-reactor#structure-of-an-lf-project) for more info.
5252

5353
### Using docker compose up
5454
Change directory to where the `docker-compose.yml` is located, and simply run:

package.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616
"dev": "docusaurus start"
1717
},
1818
"dependencies": {
19-
"@docusaurus/core": "^3.0.1",
20-
"@docusaurus/plugin-client-redirects": "^3.0.1",
21-
"@docusaurus/plugin-ideal-image": "^3.0.1",
22-
"@docusaurus/preset-classic": "^3.0.1",
19+
"@docusaurus/core": "^3.1.1",
20+
"@docusaurus/plugin-client-redirects": "^3.1.1",
21+
"@docusaurus/plugin-ideal-image": "^3.1.1",
22+
"@docusaurus/preset-classic": "^3.1.1",
2323
"@mdx-js/react": "^3.0.0",
2424
"clsx": "^1.2.1",
2525
"prism-react-renderer": "^2.1.0",
@@ -30,10 +30,10 @@
3030
"unist-util-visit": "^5.0.0"
3131
},
3232
"devDependencies": {
33-
"@docusaurus/eslint-plugin": "^3.0.1",
34-
"@docusaurus/module-type-aliases": "^3.0.1",
35-
"@docusaurus/tsconfig": "^3.0.1",
36-
"@docusaurus/types": "^3.0.1",
33+
"@docusaurus/eslint-plugin": "^3.1.1",
34+
"@docusaurus/module-type-aliases": "^3.1.1",
35+
"@docusaurus/tsconfig": "^3.1.1",
36+
"@docusaurus/types": "^3.1.1",
3737
"@typescript-eslint/eslint-plugin": "^6.13.1",
3838
"@typescript-eslint/parser": "^6.13.1",
3939
"eslint": "^8.55.0",

versioned_docs/version-0.5.0/reference/containerized-execution.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This specifies that the base image is the latest version of `alpine`, a very sma
2424
How to use this depends on whether your application is federated. You will need to [install Docker](https://docs.docker.com/get-docker/) if you haven't already in order to use this.
2525

2626
## Unfederated Execution
27-
Suppose your LF source file is `src/Foo.lf`. When you run `lfc` or use the IDE to generate code, a file called `Dockerfile` and a file called `docker-compose.yml` will appear in the `src_gen/Foo` directory, see [Structure of an LF project](/docs/handbook/a-first-reactor#structure-of-an-lf-project) for more info.
27+
Suppose your LF source file is `src/Foo.lf`. When you run `lfc` or use the IDE to generate code, a file called `Dockerfile` and a file called `docker-compose.yml` will appear in the `src_gen/Foo` directory, see [Structure of an LF project](/docs/writing-reactors/a-first-reactor#structure-of-an-lf-project) for more info.
2828

2929
### Using docker compose up
3030
After running `lfc`, change to the directory that contains the generated sources. Then, use `docker compose up --build` to automatically build the Docker image and run the container. Once the container finishes execution, use `docker compose down` in the same directory where `docker-compose.yml` is located to remove the container.
@@ -57,7 +57,7 @@ The above run command can include any supported command-line arguments to the LF
5757
```
5858

5959
## Federated Execution
60-
Suppose your LF source file is `src/Fed.lf`. When you run `lfc` or use the IDE to generate code, a file called `Dockerfile` is created for each federate alongside its sources. Just like in the unfederated case, a single `docker-compose.yml` will appear in the `src_gen/Fed` directory, see [Structure of an LF project](/docs/handbook/a-first-reactor#structure-of-an-lf-project) for more info.
60+
Suppose your LF source file is `src/Fed.lf`. When you run `lfc` or use the IDE to generate code, a file called `Dockerfile` is created for each federate alongside its sources. Just like in the unfederated case, a single `docker-compose.yml` will appear in the `src_gen/Fed` directory, see [Structure of an LF project](/docs/writing-reactors/a-first-reactor#structure-of-an-lf-project) for more info.
6161

6262
### Using docker compose up
6363
Change directory to where the `docker-compose.yml` is located, and simply run:

0 commit comments

Comments
 (0)