feat: use tutorial short name - breadcrumb, tutorial sidebar, sitemap (…

…#2046)

* update types

* add to breadcrumb

* type and formatting

* Adds to sitemap

src/lib/learn-client/api/api-types.ts

@@ -54,6 +54,7 @@ export interface ApiTutorial extends ContentBaseModel, DefaultCollection {
 	hands_on_lab_provider: HandsOnLabProviderOption | null
 	products_used: ApiProductsUsed[] // Returns empty array if no products used
 	variants: ApiTutorialVariant[]
+	short_name: string
 }
 
 // Everything in base ApiTutorial, except content

src/lib/learn-client/api/collection/formatting.ts

@@ -53,6 +53,7 @@ export function formatToTutorialLite(
 	const {
 		id,
 		name,
+		short_name,
 		slug,
 		description,
 		read_time,
@@ -71,6 +72,7 @@ export function formatToTutorialLite(
 	return {
 		id,
 		name,
+		shortName: short_name || name,
 		slug,
 		description,
 		readTime: read_time,

src/lib/learn-client/api/tutorial/formatting.ts

@@ -40,6 +40,7 @@ export function formatTutorialData(
 		id,
 		slug,
 		name,
+		short_name,
 		description,
 		content,
 		default_collection_id,
@@ -66,6 +67,7 @@ export function formatTutorialData(
 		id,
 		slug,
 		name,
+		shortName: short_name || name,
 		description,
 		content,
 		collectionCtx,

src/lib/learn-client/types.ts

@@ -29,6 +29,7 @@ export interface Tutorial {
 	id?: ApiTutorial['id'] // uuid
 	slug: identifier
 	name: string
+	shortName: string
 	description: string
 	content: string // mdx content
 	collectionCtx: CollectionCtxLite
@@ -73,6 +74,7 @@ export interface TutorialLite
 		Tutorial,
 		| 'id'
 		| 'name'
+		| 'shortName'
 		| 'slug'
 		| 'description'
 		| 'readTime'

src/views/product-tutorials-view/components/sitemap/helpers.ts

@@ -19,7 +19,7 @@ export function formatSitemapCollection(
 		tutorials: collection.tutorials.map((t: ClientTutorialLite) => ({
 			id: t.id,
 			slug: t.slug,
-			name: t.name,
+			name: t.shortName || t.name,
 		})),
 	}
 }

src/views/tutorial-view/server.ts

@@ -106,7 +106,7 @@ export async function getTutorialPageProps(
 				filename: collection.filename,
 			},
 			tutorial: {
-				name: fullTutorialData.name,
+				name: fullTutorialData.shortName,
 				filename: tutorialReference.filename,
 			},
 		}),

src/views/tutorial-view/types.ts

@@ -36,6 +36,7 @@ interface TutorialData
 		ClientTutorial,
 		| 'id'
 		| 'name'
+		| 'shortName'
 		| 'slug'
 		| 'readTime'
 		| 'productsUsed'

src/views/tutorial-view/utils/index.ts

@@ -46,7 +46,7 @@ export function formatTutorialToMenuItem(
 	return {
 		tutorialId: tutorial.id,
 		collectionId: collection.id,
-		text: tutorial.name,
+		text: tutorial.shortName,
 		href: path,
 		isActive: path === currentPathWithoutVariant,
 	}