From f07a093216ef4cbe2e03826e0c08c609a6a69cc9 Mon Sep 17 00:00:00 2001 From: Thimy Kieu Date: Mon, 2 Sep 2024 10:38:09 +0200 Subject: [PATCH] guides: display links to openapi complete guide Adds an entry in the main navbar and a highlight banner in the main guides page. --- src/_components/shared/highlight_banner.rb | 3 +-- src/_data/navbar.yml | 1 + src/_pages/guides.md | 10 ++++++++++ 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/src/_components/shared/highlight_banner.rb b/src/_components/shared/highlight_banner.rb index 69668023..9c95a6cd 100644 --- a/src/_components/shared/highlight_banner.rb +++ b/src/_components/shared/highlight_banner.rb @@ -1,7 +1,6 @@ class Shared::HighlightBanner < Bridgetown::Component - def initialize(title:, description: "", image: "", link_url: "", link_label: "", link_icon: "") + def initialize(title:, image: "", link_url: "", link_label: "", link_icon: "") @title = title - @description = description @image = image @link_url = link_url @link_label = link_label diff --git a/src/_data/navbar.yml b/src/_data/navbar.yml index e945f1d7..9dada992 100644 --- a/src/_data/navbar.yml +++ b/src/_data/navbar.yml @@ -2,6 +2,7 @@ left_links: - {title: "Documentation", link: "/help"} - {title: "Product Updates", link: "/product-updates"} - {title: "Guides", link: "/guides"} + - {title: "OpenAPI", link: "/guides/openapi/specification/v3.1/introduction/what-is-openapi"} right_links: - {title: "API Reference", link: "https://developers.bump.sh"} - {title: "Bump.sh", link: "https://bump.sh"} diff --git a/src/_pages/guides.md b/src/_pages/guides.md index a3327a70..3f56616b 100644 --- a/src/_pages/guides.md +++ b/src/_pages/guides.md @@ -3,3 +3,13 @@ layout: guides title: Guides page_class: guides --- + +<%= render Shared::HighlightBanner.new( + title: "OpenAPI: The Complete Guide", + image: "images/logos/openapi.svg", + link_url: "/guides/openapi/specification/v3.1/introduction/what-is-openapi", + link_label: "Discover the guide", + link_icon: "images/icons/documentation.svg") do %> +

This guide is designed to give you a step-by-step overview of OpenAPI. +Discover the reasons behind its creation, its capabilities and how to make a good OpenAPI API from scratch, from design to maintenance.

+<% end %>