Skip to content

Commit

Permalink
doc: fix internal links
Browse files Browse the repository at this point in the history
Fix links referring to internal pages as per the new
structure of API & Pipeline documentation.

Signed-off-by: Jeny Sadadia <[email protected]>
  • Loading branch information
Jeny Sadadia authored and JenySadadia committed May 30, 2024
1 parent aaf5768 commit 16e81dc
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
6 changes: 3 additions & 3 deletions doc/api-details.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "API details"
date: 2023-09-27
date: 2024-05-29
description: "KernelCI API building blocks"
weight: 3
---
Expand All @@ -16,7 +16,7 @@ setting things up and issuing low-level queries.
## Environment Variables

General instructions about the environment file are described on the [local
instance](https://kernelci.org/docs/api/local-instance/#create-the-environment-file)
instance](../local-instance/#create-the-environment-file)
page. This section goes through all the environment variables used by the API.

### Set ALGORITHM and ACCESS_TOKEN_EXPIRE_MINUTES in environment file
Expand Down Expand Up @@ -47,7 +47,7 @@ users are allowed to create user accounts.
The very first admin user needs to be created with
[`api.admin`](https://github.com/kernelci/kernelci-api/blob/main/api/admin.py)
tool provided in the `kernelci-api` repository.
[Here](/docs/api/local-instance/#create-an-admin-user-account) is a guide to
[Here](../local-instance/#create-an-admin-user-account) is a guide to
setup an admin user. We can use this admin user to create other user accounts.


Expand Down
5 changes: 2 additions & 3 deletions doc/design.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Design"
date: 2023-09-01
date: 2024-05-29
description: "Overall API & Pipeline design"
weight: 2
---
Expand Down Expand Up @@ -89,8 +89,7 @@ graph LR
```

Each step is a client for the API and related storage solutions. They are all
implemented in Python, rely on the [KernelCI Core](/docs/core) tools and run in
a separate `docker-compose` container. Here's a summary of each step:
implemented in Python, rely on the [KernelCI Core](/docs/legacy/core) tools and run in a separate `docker-compose` container. Here's a summary of each step:

### Trigger

Expand Down
4 changes: 2 additions & 2 deletions doc/local-instance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Local instance"
date: 2024-05-22
date: 2024-05-29
description: "Setting up a local KernelCI instance"
weight: 4
---
Expand Down Expand Up @@ -96,7 +96,7 @@ Creating admin user...
> instance such as an Atlas account using the `--mongo` command line argument.
> **Note** For more details about how to create users via the raw API, see the
> [API documentation](/docs/api/api-details/#users)
> [API documentation](../api-details/#users)
### Create an admin API token

Expand Down

0 comments on commit 16e81dc

Please sign in to comment.