Skip to content

Commit

Permalink
chore: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fdewas-aneo committed Dec 2, 2024
1 parent bbef990 commit 9ab4ef4
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .docs/content/0.installation/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ To deploy ArmoniK.Core locally, you need first to clone the repository [ArmoniK.
just
```

More about local deployment, see [Local Deployment of ArmoniK.Core](./1.local-deployment.md).
More about local deployment, see [Local Deployment of ArmoniK.Core](../0.installation/1.local-deployment.md).

### Tests

There are a number of tests that help to verify the successful installation of ArmoniK.Core. Some of them depend of ArmoniK.Core deployment, others do not.

More about tests, see [Tests of ArmoniK.Core](./2.tests.md).
More about tests, see [Tests of ArmoniK.Core](../0.installation/2.tests.md).

## Contribution

Expand Down
2 changes: 1 addition & 1 deletion .docs/content/0.installation/4.perftests-htcmock.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ docker run --net armonik_network --rm \
```

We execute this test several times and compute the average tasks throughput.
See this [script](../../../tools/perftest-htcmock.sh) for the exact test process.
See this [script](https://github.com/aneoconsulting/ArmoniK.Core/blob/main/tools/perftest-htcmock.sh) for the exact test process.

## Useful git commands

Expand Down
4 changes: 2 additions & 2 deletions .docs/content/1.concepts/2.tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ graph TD

## Status state diagram

```mermaid
<Mermaid>
stateDiagram-v2
[*] --> Creating: Task is created in the db
Creating --> Pending: Dependencies are not available<br/>Creation rpc succeeds
Expand All @@ -57,4 +57,4 @@ stateDiagram-v2
Completed --> [*]
Retried --> [*]
Error --> [*]
```
</Mermaid>
5 changes: 4 additions & 1 deletion .docs/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ export default defineNuxtConfig({
siteName: 'ArmoniK Core',
siteDescription: 'The heart of ArmoniK'
}
}
},

robots: {
robotsTxt: false
},
})

0 comments on commit 9ab4ef4

Please sign in to comment.