From 16e81dccea653599f6b6c821f75d4b2b972675e2 Mon Sep 17 00:00:00 2001 From: Jeny Sadadia Date: Wed, 29 May 2024 16:46:37 +0530 Subject: [PATCH] doc: fix internal links Fix links referring to internal pages as per the new structure of API & Pipeline documentation. Signed-off-by: Jeny Sadadia --- doc/api-details.md | 6 +++--- doc/design.md | 5 ++--- doc/local-instance.md | 4 ++-- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/api-details.md b/doc/api-details.md index 3f6c83e0..2d429609 100644 --- a/doc/api-details.md +++ b/doc/api-details.md @@ -1,6 +1,6 @@ --- title: "API details" -date: 2023-09-27 +date: 2024-05-29 description: "KernelCI API building blocks" weight: 3 --- @@ -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 @@ -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. diff --git a/doc/design.md b/doc/design.md index a466d906..42939179 100644 --- a/doc/design.md +++ b/doc/design.md @@ -1,6 +1,6 @@ --- title: "Design" -date: 2023-09-01 +date: 2024-05-29 description: "Overall API & Pipeline design" weight: 2 --- @@ -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 diff --git a/doc/local-instance.md b/doc/local-instance.md index 185e8add..0d193a33 100644 --- a/doc/local-instance.md +++ b/doc/local-instance.md @@ -1,6 +1,6 @@ --- title: "Local instance" -date: 2024-05-22 +date: 2024-05-29 description: "Setting up a local KernelCI instance" weight: 4 --- @@ -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