Skip to content

Commit 183f235

Browse files
JounQinJounQin
authored
Merge branch 'master' into feat/spire-docs
2 parents 6fcc5f7 + 2d895c8 commit 183f235

80 files changed

Lines changed: 3392 additions & 1792 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.cspell/terms.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ cephclusters
2222
cephfilesystems
2323
cephobjectstores
2424
cephobjectstoreusers
25-
ghostunnel
25+
ghostunnel
26+
lvmdconfig

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/.vscode
12
**/node_modules
23
**/dist
34
local/*

‎README.md‎

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,84 @@ $ yarn install
1818

1919
## Updating AC CLI Documentation
2020

21-
* `yarn update-ac-manual`: Update the AC CLI documentation in [docs/en/ui/cli_tools/ac/](docs/en/ui/cli_tools/ac/).
21+
The AC CLI documentation in [docs/en/ui/cli_tools/ac/](docs/en/ui/cli_tools/ac/) is generated from the AC repository and should be updated through the sync script instead of manual edits.
2222

23-
**Important:** Do not manually edit files in [docs/en/ui/cli_tools/ac/](docs/en/ui/cli_tools/ac/) as they are managed by this update command.
23+
### Prerequisites
24+
25+
* Install project dependencies with `yarn install`
26+
* Ensure `git` is available on your machine
27+
* Ensure your account has SSH access to `git@gitlab-ce.alauda.cn:alauda/ac.git`
28+
29+
### Default Update Command
30+
31+
Run the standard update command from the repository root:
32+
33+
```bash
34+
yarn update-ac-manual
35+
```
36+
37+
This command runs:
38+
39+
```bash
40+
node scripts/update-ac-manual.js
41+
```
42+
43+
When you use `yarn update-ac-manual`, the repository sync pulls the `release-1.0` branch from `git@gitlab-ce.alauda.cn:alauda/ac.git` by default.
44+
45+
### What the Sync Script Does
46+
47+
The update script uses the following locations:
48+
49+
* Source repository: `git@gitlab-ce.alauda.cn:alauda/ac.git`
50+
* Temporary clone directory: `local/temp-ac-clone`
51+
* Source manual directory inside the AC repository: `manual/`
52+
* Target directory in this repository: `docs/en/ui/cli_tools/ac/`
53+
54+
The workflow is:
55+
56+
1. Clone the AC repository into `local/temp-ac-clone`
57+
2. Read the `manual/` directory from the cloned repository
58+
3. Remove all existing files under `docs/en/ui/cli_tools/ac/` except `index.mdx`
59+
4. Copy the files from `manual/` into `docs/en/ui/cli_tools/ac/`
60+
5. Strip leading numeric prefixes from top-level Markdown filenames such as `01_foo.md`
61+
6. Remove the temporary clone directory after the sync finishes
62+
63+
### Updating from a Different Branch
64+
65+
If you need to sync from a branch other than `release-1.0`, pass the branch name as an argument:
66+
67+
```bash
68+
yarn update-ac-manual <branch>
69+
```
70+
71+
This is equivalent to running the script directly:
72+
73+
```bash
74+
node scripts/update-ac-manual.js <branch>
75+
```
76+
77+
Replace `<branch>` with the branch name you want to pull from.
78+
79+
If you run `node scripts/update-ac-manual.js` without a branch argument, the script defaults to `release-1.0`.
80+
81+
### Recommended Verification Steps
82+
83+
After updating the generated files, review and validate the result:
84+
85+
```bash
86+
git diff -- docs/en/ui/cli_tools/ac
87+
yarn lint
88+
yarn build
89+
```
90+
91+
If the English source changes need to be synchronized to localized content, run:
92+
93+
```bash
94+
yarn translate
95+
```
96+
97+
### Notes
98+
99+
* Do not manually edit files in [docs/en/ui/cli_tools/ac/](docs/en/ui/cli_tools/ac/); they are managed by the update script
100+
* `index.mdx` in [docs/en/ui/cli_tools/ac/](docs/en/ui/cli_tools/ac/) is preserved by the sync process
101+
* If local preview output changes in the sidebar or navigation, restart `yarn dev`

‎docs/en/apis/advanced_apis/event/search.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,9 @@ i18n:
77

88
# Search
99

10-
<OpenAPIPath path="/platform/events.alauda.io/v1/events"/>
11-
<OpenAPIPath path="/platform/events.alauda.io/v1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/events"/>
10+
<OpenAPIPath
11+
path={[
12+
'/platform/events.alauda.io/v1/events',
13+
'/platform/events.alauda.io/v1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/events',
14+
]}
15+
/>

‎docs/en/apis/advanced_apis/log/aggregation.mdx‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ i18n:
77

88
# Aggregation
99

10-
<OpenAPIPath path="/platform/logging.alauda.io/v2/logs/aggregation"/>
11-
<OpenAPIPath path="/platform/logging.alauda.io/v2/clusters/{cluster}/logs/aggregation"/>
12-
<OpenAPIPath path="/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/aggregation"/>
10+
<OpenAPIPath
11+
path={[
12+
'/platform/logging.alauda.io/v2/logs/aggregation',
13+
'/platform/logging.alauda.io/v2/clusters/{cluster}/logs/aggregation',
14+
'/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/aggregation',
15+
]}
16+
/>

‎docs/en/apis/advanced_apis/log/archive.mdx‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ i18n:
77

88
# Archive
99

10-
<OpenAPIPath path="/platform/logging.alauda.io/v2/logs/archive"/>
11-
<OpenAPIPath path="/platform/logging.alauda.io/v2/clusters/{cluster}/logs/archive"/>
12-
<OpenAPIPath path="/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/archive"/>
10+
<OpenAPIPath
11+
path={[
12+
'/platform/logging.alauda.io/v2/logs/archive',
13+
'/platform/logging.alauda.io/v2/clusters/{cluster}/logs/archive',
14+
'/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/archive',
15+
]}
16+
/>

‎docs/en/apis/advanced_apis/log/context.mdx‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ i18n:
77

88
# Context
99

10-
<OpenAPIPath path="/platform/logging.alauda.io/v2/logs/context"/>
11-
<OpenAPIPath path="/platform/logging.alauda.io/v2/clusters/{cluster}/logs/context"/>
12-
<OpenAPIPath path="/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/context"/>
10+
<OpenAPIPath
11+
path={[
12+
'/platform/logging.alauda.io/v2/logs/context',
13+
'/platform/logging.alauda.io/v2/clusters/{cluster}/logs/context',
14+
'/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/context',
15+
]}
16+
/>

‎docs/en/apis/advanced_apis/log/search.mdx‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ i18n:
77

88
# Search
99

10-
<OpenAPIPath path="/platform/logging.alauda.io/v2/logs/search"/>
11-
<OpenAPIPath path="/platform/logging.alauda.io/v2/clusters/{cluster}/logs/search"/>
12-
<OpenAPIPath path="/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/search"/>
10+
<OpenAPIPath
11+
path={[
12+
'/platform/logging.alauda.io/v2/logs/search',
13+
'/platform/logging.alauda.io/v2/clusters/{cluster}/logs/search',
14+
'/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/search',
15+
]}
16+
/>

‎docs/en/apis/advanced_apis/monitor/indicators.mdx‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ sourceSHA: 16d2d3fa23c37585a14f34f86ceb05542f035409d29c5e91b4f3e6da53167fa1
44

55
# Indicators [monitoring.alauda.io/v1beta1]
66

7-
<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/indicators" />
8-
9-
<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/indicators" />
10-
11-
<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/indicators" />
7+
<OpenAPIPath
8+
path={[
9+
'/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/indicators',
10+
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/indicators',
11+
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/indicators',
12+
]}
13+
/>

‎docs/en/apis/advanced_apis/monitor/metrics.mdx‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ sourceSHA: 8fda8bb72100def30b6a497567611e9df184d1785a4fa920383613ef10b811dc
44

55
# Metrics [monitoring.alauda.io/v1beta1]
66

7-
<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/metrics" />
8-
9-
<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/metrics" />
10-
11-
<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/metrics" />
7+
<OpenAPIPath
8+
path={[
9+
'/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/metrics',
10+
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/metrics',
11+
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/metrics',
12+
]}
13+
/>

0 commit comments

Comments
 (0)