docs(techdocs-common): add case sentitive migration steps

Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
This commit is contained in:
Camila Belo
2021-08-09 11:38:33 +02:00
parent c772d9a84e
commit 2f4f15846d
4 changed files with 99 additions and 4 deletions
+6 -1
View File
@@ -248,7 +248,12 @@ export interface Config {
storageUrl?: string;
/**
* (Optional)
* (Optional and not recommended) Prior to version [0.x.y] of TechDocs, docs
* sites could only be accessed over paths with case-sensitive entity triplets
* e.g. (namespace/Kind/name). If you are upgrading from an older version of
* TechDocs and are unable to perform the necessary migration of files in your
* external storage, you can set this value to `true` to temporarily revert to
* the old, case-sensitive entity triplet behavior.
*/
legacyUseCaseSensitiveTripletPaths?: boolean;
};