Skip to content

Commit

Permalink
guides: display links to openapi complete guide
Browse files Browse the repository at this point in the history
Adds an entry in the main navbar and a highlight banner in the main
guides page.
  • Loading branch information
thimy committed Sep 2, 2024
1 parent 0d81d2d commit f07a093
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
3 changes: 1 addition & 2 deletions src/_components/shared/highlight_banner.rb
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions src/_data/navbar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
10 changes: 10 additions & 0 deletions src/_pages/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %>
<p>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.</p>
<% end %>

0 comments on commit f07a093

Please sign in to comment.