Skip to content

Clarify the Git root required for Aqua policy discovery #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
konojunya merged 2 commits into from
Sep 5, 2026
Merged

Clarify the Git root required for Aqua policy discovery #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59d0a60
docs: clarify the Git root required for Aqua policy discovery
konojunya Sep 5, 2026
0b6bf3c
docs: keep the Aqua walkthrough inside its project
konojunya Sep 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/site/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version {{cliVersion}} --locked

### Aqua

In a Git repository, save the following as `aqua.yaml`:
At the root of a Git repository (the directory containing `.git`), save the following as `aqua.yaml`. If this is a new project, run `git init` first:

```yaml
checksum:
Expand Down Expand Up @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH"

## Create your first SVG

In a new empty working directory, run:
In a new empty working directory, run the following. With Aqua, keep this directory inside the Git repository containing your `aqua.yaml`:

```sh
$ stack --version
Expand Down
4 changes: 2 additions & 2 deletions content/site/ja/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version {{cliVersion}} --locked

### Aqua

Gitリポジトリ内に、次の内容を`aqua.yaml`として保存します。
Gitリポジトリのルート（`.git`があるディレクトリ）に、次の内容を`aqua.yaml`として保存します。新しいプロジェクトでは先に`git init`を実行してください。

```yaml
checksum:
Expand Down Expand Up @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH"

## 最初のSVGを作る

新しい空の作業ディレクトリで実行します。
新しい空の作業ディレクトリで実行します。Aquaを使う場合は、`aqua.yaml`があるGitリポジトリの内側に作ってください。

```sh
$ stack --version
Expand Down
4 changes: 2 additions & 2 deletions content/site/ko/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version {{cliVersion}} --locked

### Aqua

Git 저장소에서 다음 내용을 `aqua.yaml`로 저장하세요.
Git 저장소의 루트(`.git`이 있는 디렉터리)에 다음 내용을 `aqua.yaml`로 저장하세요. 새 프로젝트라면 먼저 `git init`을 실행하세요.

```yaml
checksum:
Expand Down Expand Up @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH"

## 첫 SVG 만들기

새로운 빈 작업 디렉터리에서 실행하세요.
새로운 빈 작업 디렉터리에서 실행하세요. Aqua를 사용한다면 `aqua.yaml`이 있는 Git 저장소 안에 디렉터리를 만드세요.

```sh
$ stack --version
Expand Down
4 changes: 2 additions & 2 deletions content/site/zh/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version {{cliVersion}} --locked

### Aqua

在Git仓库中，将以下内容保存为`aqua.yaml`：
在Git仓库的根目录（包含`.git`的目录）中，将以下内容保存为`aqua.yaml`。新项目请先运行`git init`：

```yaml
checksum:
Expand Down Expand Up @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH"

## 生成第一个SVG

在新的空工作目录中执行：
在新的空工作目录中执行。使用Aqua时，请将该目录放在包含`aqua.yaml`的Git仓库内：

```sh
$ stack --version
Expand Down
8 changes: 4 additions & 4 deletions generated/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
},
{
"path": "site/guide/getting-started.md",
"sha256": "a6001affc631efa8e52c37b80eee3d4228f255c934e6564266e7ae613bae9322"
"sha256": "b9e21a3fcf5c8de6360dcf060cbf2b05099f0e55dda1186f1ea3700740e0a860"
},
{
"path": "site/guide/playground.md",
Expand Down Expand Up @@ -52,7 +52,7 @@
},
{
"path": "site/ja/guide/getting-started.md",
"sha256": "10838a254fce97b88a304bd1cdf8940c3f3522fdecb37428cea36cee0b35e978"
"sha256": "bae22b095cc22279e48494213748d1b0413eddec9893b261c73159267c27875d"
},
{
"path": "site/ja/guide/playground.md",
Expand Down Expand Up @@ -108,7 +108,7 @@
},
{
"path": "site/ko/guide/getting-started.md",
"sha256": "e8c3980411457ed25973fe2075c6d58f22d9c5b17aeadfaecd73d9d4e91f257f"
"sha256": "0e55e18cc77bfa6ffb2598ecfc69b1884a8e0380e54953860cbfa1e01ebcd58b"
},
{
"path": "site/ko/guide/playground.md",
Expand Down Expand Up @@ -192,7 +192,7 @@
},
{
"path": "site/zh/guide/getting-started.md",
"sha256": "0741c92878eeff3b378f229f99ebadcb98689d13f6458644e4523e6b46cf923b"
"sha256": "88100e9090603b3eb07fad7e7b32f066cede0cfcc306e28ecb4ed852b9a850e1"
},
{
"path": "site/zh/guide/playground.md",
Expand Down
4 changes: 2 additions & 2 deletions generated/site/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version 0.5.1 --locked

### Aqua

In a Git repository, save the following as `aqua.yaml`:
At the root of a Git repository (the directory containing `.git`), save the following as `aqua.yaml`. If this is a new project, run `git init` first:

```yaml
checksum:
Expand Down Expand Up @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH"

## Create your first SVG

In a new empty working directory, run:
In a new empty working directory, run the following. With Aqua, keep this directory inside the Git repository containing your `aqua.yaml`:

```sh
$ stack --version
Expand Down
4 changes: 2 additions & 2 deletions generated/site/ja/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version 0.5.1 --locked

### Aqua

Gitリポジトリ内に、次の内容を`aqua.yaml`として保存します。
Gitリポジトリのルート（`.git`があるディレクトリ）に、次の内容を`aqua.yaml`として保存します。新しいプロジェクトでは先に`git init`を実行してください。

```yaml
checksum:
Expand Down Expand Up @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH"

## 最初のSVGを作る

新しい空の作業ディレクトリで実行します。
新しい空の作業ディレクトリで実行します。Aquaを使う場合は、`aqua.yaml`があるGitリポジトリの内側に作ってください。

```sh
$ stack --version
Expand Down
4 changes: 2 additions & 2 deletions generated/site/ko/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version 0.5.1 --locked

### Aqua

Git 저장소에서 다음 내용을 `aqua.yaml`로 저장하세요.
Git 저장소의 루트(`.git`이 있는 디렉터리)에 다음 내용을 `aqua.yaml`로 저장하세요. 새 프로젝트라면 먼저 `git init`을 실행하세요.

```yaml
checksum:
Expand Down Expand Up @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH"

## 첫 SVG 만들기

새로운 빈 작업 디렉터리에서 실행하세요.
새로운 빈 작업 디렉터리에서 실행하세요. Aqua를 사용한다면 `aqua.yaml`이 있는 Git 저장소 안에 디렉터리를 만드세요.

```sh
$ stack --version
Expand Down
4 changes: 2 additions & 2 deletions generated/site/zh/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo install stack-diagram-cli --version 0.5.1 --locked

### Aqua

在Git仓库中，将以下内容保存为`aqua.yaml`：
在Git仓库的根目录（包含`.git`的目录）中，将以下内容保存为`aqua.yaml`。新项目请先运行`git init`：

```yaml
checksum:
Expand Down Expand Up @@ -104,7 +104,7 @@ export PATH="$HOME/.local/bin:$PATH"

## 生成第一个SVG

在新的空工作目录中执行：
在新的空工作目录中执行。使用Aqua时，请将该目录放在包含`aqua.yaml`的Git仓库内：

```sh
$ stack --version
Expand Down