From a1e79811c261a3877760ee8c6a32228fe7531872 Mon Sep 17 00:00:00 2001 From: Guillaume Tucker Date: Thu, 9 Nov 2023 18:35:49 +0100 Subject: [PATCH] doc: add notes about Azure File share names The Azure File name might not be exactly the same as the username so add a note about that. Also add a related note about putting values in double quotes when they contain a dot so it gets parsed correctly in TOML with the dotted-key syntax. Signed-off-by: Guillaume Tucker --- doc/early-access.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/early-access.md b/doc/early-access.md index eac88bd9..4fe0dfd9 100644 --- a/doc/early-access.md +++ b/doc/early-access.md @@ -143,6 +143,10 @@ storage: share: ``` +> **Note**: Please double check the exact name of your share as it may not +> always be quite the same as your username. Some characters are valid for +> username but not for the share name. + Then the token from your confirmation email needs to be stored in the `kernelci.toml` settings file in order to make use of it. Please note that only the part of the URL with the arguments starting with the `?` needs to be @@ -162,6 +166,10 @@ api.early-access.token = "" storage.early-access-azure-.credentials = "?sp=rcwdl&st=..." ``` +> **Note**: If your username contains a dot or any special character, please +> surround it with quotes to ensure it gets parsed correctly as TOML. For +> example: `storage."early-access-azure-my.name".credentials = "..."`. + Then here's a quick way to check it's working, still in the same container: ```sh