Skip to content

Commit

Permalink
guides: fix dates and sorting
Browse files Browse the repository at this point in the history
Reverse collection items order in guides page as it wasn't showing
latest published guides.

Also using date as frontmatter properties instead of putting it in filename.
  • Loading branch information
thimy committed Jun 20, 2024
1 parent 8254176 commit 3128b12
Show file tree
Hide file tree
Showing 37 changed files with 42 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/_components/guides/category/section.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ def initialize(category:, title: nil, css_classes: "")
@site = Bridgetown::Current.site
@category_name = category.name
@description = category.description
@resources = @site.collections.guides.resources.select do |guide|
@resources = @site.collections.guides.resources.reverse.select do |guide|
guide.data.categories.find do |category|
Bridgetown::Utils.slugify(category) == Bridgetown::Utils.slugify(@category_name)
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Damaso Sanoja
image: images/guides/api-architecture-diagrams.png
canonical_url: https://bump.sh/blog/api-architecture-diagrams
excerpt: Learn about the various types of API architecture diagrams and some tips for creating them.
date: 2024-03-25
---

Architecture diagrams are essential in the API development process. They provide a map of how different systems interact to help software teams manage and maintain them, and they provide insight into the architect’s vision for the entire system. Along with other elements like interactive API portals, API architecture diagrams also help enrich your API’s documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Sooter Saalu
image: images/guides/api-contracts-extended-introduction.png
canonical_url: https://bump.sh/blog/api-contracts-extended-introduction
excerpt: This guide explains how API contracts can help your business, the best practices to follow, and gives some practical examples.
date: 2023-11-24
---

An API contract is a document that showcases how an API behaves and how it should be used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Joanna Wallace
image: images/guides/asyncapi-vs-openapi.png
canonical_url: https://bump.sh/blog/asyncapi-vs-openapi
excerpt: Learn about the basic differences between AsyncAPI and OpenAPI that will help you pick one of them.
date: 2024-03-25
---

Depending on how your application is designed and what it needs to accomplish, you probably want to consider choosing one type of communication protocol for your API over another—namely, synchronous or asynchronous. And which protocol you use determines which specification you need to follow for your API—[OpenAPI](https://www.openapis.org/) or [AsyncAPI](https://www.asyncapi.com/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Alex Doukas
image: images/guides/api-first-design-guide.png
canonical_url: https://bump.sh/blog/dev-guide-api-design-first
excerpt: Learn about the principles of API-first design and how it can benefit your organization.
date: 2024-03-25
---

API-first design is a software development approach built around the idea that the application programming interfaces (APIs) should be the primary focus of the development process, with other system components, such as the user interface (UI) being developed later.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: polo
image: blog/document-polymorphism-api.png
canonical_url: https://bump.sh/blog/api-architecture-diagrams
excerpt: Learn how to use `oneOf`, `anyOf` and `allOf` when writing an OpenAPI or AsyncAPI definition.
date: 2023-11-10
---

Don't Repeat Yourself. Be DRY! Anyone who ever had to manually correct thousand of flyers printed for an event,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Ivan Kahl
image: images/guides/openapi-asyncapi-tags-organize-endpoints.png
canonical_url: https://bump.sh/blog/openapi-tags-organize-endpoints
excerpt: Learn tips and tricks to group related endpoints in a meaningful way.
date: 2024-03-25
---

OpenAPI Tags are a great way to organize the API endpoints in [your API Contract](https://bump.sh/blog/api-contracts-extended-introduction).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: jay
image: images/guides/different-api-types.png
canonical_url: https://bump.sh/blog/what-are-the-different-api-types
excerpt: This is an introduction to the various API technologies that exist today, and their main use cases.
date: 2023-11-09
---
APIs have become increasingly popular over the past few years, enabling products, projects and people to connect. In this article, we will try to present a snapshot of the most popular solutions available as of August 2022. We did our best to avoid bias, but some technologies are not mentioned on purpose, as we want to focus on the most used/popular.

Expand Down Expand Up @@ -127,4 +128,4 @@ Learn more on [WebSockets](https://en.wikipedia.org/wiki/WebSocket).

This article was just a short tour of today’s API scene, as there’s much more to share on this growing, vivid topic. New concepts, ideas, projects, tools, standards, and optimizations are developed and shared weekly within the community. And even if we know that some content in this article will be obsolete in the upcoming months, we’ll try to keep it updated as much as possible.

In the meantime, we at Bump are trying to create great tools to help developers, API evangelists, communities and teams to get the best from their APIs. We have developed the first product that provides a unified experience around [OpenAPI](https://bump.sh/openapi) and [AsyncAPI](https://bump.sh/asyncapi). Feel free to look at our solution, and please reach us if you have any feedback, comment or suggestion you would like to share. We’re always listening. :)
In the meantime, we at Bump are trying to create great tools to help developers, API evangelists, communities and teams to get the best from their APIs. We have developed the first product that provides a unified experience around [OpenAPI](https://bump.sh/openapi) and [AsyncAPI](https://bump.sh/asyncapi). Feel free to look at our solution, and please reach us if you have any feedback, comment or suggestion you would like to share. We’re always listening. :)
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Michael Nyamande
image: images/guides/building-event-driven-async-api.png
canonical_url: https://bump.sh/blog/asyncapi-first-event-driven-api
excerpt: Follow this walkthrough tutorial and build and Event-driven API along its documentation.
date: 2024-03-25
---

Event-driven APIs are APIs that use events to enable real-time and asynchronous communication between different components of a system. This leads to a couple significant benefits right out of the gate:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: jay
image: images/guides/what-is-asyncapi.png
canonical_url: https://bump.sh/blog/what-is-asyncapi
excerpt: AsyncAPI is the most popular specification for describing asynchronous APIs and Event-Driven Architectures.
date: 2023-10-19
---

AsyncAPI is the most popular specification for describing asynchronous APIs and Event-Driven Architectures.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Deploying docs from API Platform
authors: chris
excerpt: Get started with Bump.sh for API Platform projects. Learn how to publish and enrich OpenAPI documents, and build great documentation.
date: 2024-04-05
---

[API Platform](https://api-platform.com/) is an API-first PHP framework that allows you to create REST and GraphQL APIs using PHP classes, and automatically generates their documentation, based on the OpenAPI specification.
Expand Down Expand Up @@ -58,4 +59,4 @@ The Bump.sh CLI supports Overlays. Technically, the `bump overlay` command will

> Note: The diff computation performed by Bump.sh to display the [API changelog](/help/changes-management/changelog) is done when the resulting file is deployed.
> If you need to compute the diff before applying Overlays (for instance when your Overlay document filters out some information), consider using the [`bump diff`](/help/continuous-integration/cli#bump-diff-file) command and the [GitHub Action](/help/continuous-integration/github-actions).
{: .info}
{: .info}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Deploying docs from FastAPI
authors: chris
excerpt: Get started with Bump.sh for FastAPI projects. Learn how to publish and enrich OpenAPI documents, and build great documentation.
date: 2024-04-05
---

[FastAPI](https://fastapi.tiangolo.com/) is a Python framework that allows you to create APIs, and automatically generates their documentation, based on the OpenAPI specification.
Expand Down Expand Up @@ -60,4 +61,4 @@ The Bump.sh CLI supports Overlays. Technically, the `bump overlay` command will

> Note: The diff computation performed by Bump.sh to display the [API changelog](/help/changes-management/changelog) is done when the resulting file is deployed.
> If you need to compute the diff before applying Overlays (for instance when your Overlay document filters out some information), consider using the [`bump diff`](/help/continuous-integration/cli#bump-diff-file) command and the [GitHub Action](/help/continuous-integration/github-actions).
{: .info}
{: .info}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Deploying docs from Huma
authors: phil
excerpt: Generating OpenAPI for Go APIs
date: 2024-03-25
---

[Huma](https://huma.rocks/) is a Golang framework that allows you to create APIs, and automatically generates their documentation, based on the OpenAPI specification.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Make your APIs Discoverable with APIs.json"
authors: phil
canonical_url: https://bump.sh/blog/make-your-apis-discoverable-with-apis-json
excerpt: You've built a brilliant API, and you've taken the time to document it, now leverage API specifications to help share this API on API marketplaces.
date: 2024-06-03
---

You've built a brilliant API, and you've taken the time to document it, but how do you get this API advertised to potential users? After all, the more users that discover your API, the more business you're getting, so it's worth thinking about discoverability beyond a tweet and a blog.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Migrate from Redocly
authors: phil
excerpt: Move your OpenAPI out of Redocly and into your own source control, so you can control more of the workflow with all the same benefits.
date: 2024-06-10
---

Redocly is a hosted OpenAPI documentation SaaS which works in a similar way to Bump.sh: you work on OpenAPI wherever you want, then publish it up to Redocly via various Git hosting providers or Continuous Integration. The fact that it works so similarly means you can switch from Redocly easily, and start getting all the extra benefits of breaking change detection and an API changelog with minimal effort.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Try HTTP Requests with Insomnia
authors: phil
excerpt: Integrate your OpenAPI-powered documentation with Insomnia to let customers try your API out, right from the API docs.
date: 2024-06-04
---

Seeing how an API works is the first step in an end-users journey to using the API, and the second step is making some test requests to get a feel for how it works. Some people like to do this with code, so code samples will be a good start for them, especially if the API has an SDK. Other people like to do this with interactive HTTP clients, like [Insomnia](https://insomnia.rest).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: phil
image: images/guides/ref_advanced_usages.png
canonical_url: https://bump.sh/blog/openapi-asyncapi-ref-usage-guide
excerpt: Learn how to use $ref to reduce clutter and repetition in your OpenAPI and AsyncAPI documents.
date: 2023-11-27
---

After using OpenAPI or AsyncAPI for a while, you might notice your description documents have become a rather unwieldy mess of YAML and JSON. You end up with a whole lot of repetition, and this huge mess just loves to trigger merge conflicts as multiple developers change different things but Git seems none the wiser.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Augmenting Generated OpenAPI Documents with Filters & Overlays
authors: phil
canonical_url:
excerpt: Enhance and enrich your OpenAPI descriptions without creating conflicts in the source code using filters and overlays.
date: 2024-03-20
---

However you make OpenAPI descriptions for your APIs, there are all sorts of scenarios where you might want to customize it for different audiences. Perhaps your tech writers want to add amazing longer descriptions but they are locked out of the source code, or you want to hide some internal endpoints from your OpenAPI before publishing. Is it possible to do all this without awkwardly managing multiple similar-but-different OpenAPI documents?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Doug Sillars
image: images/guides/building-your-api-design-mode.png
canonical_url: https://bump.sh/blog/building-your-api-design-mode
excerpt: Read a practical example of how to write your first OpenAPI contract, and publish it via Bump.sh.
date: 2023-11-10
---

At Bump.sh, we are committed to ensuring that your API documentation is beautiful and always up to date. To demonstrate the power of our tooling, we're going to walk through the creation of an API (and, more importantly, its documentation). As we create the API and modify it, the power of integrating with Bump.sh will become more and more apparent. And this is why we are here: to make everyone's life easier: easier for the development team, the documentation team and - of course - easier for your customers to understand and stay abreast of any changes to your API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Generating OpenAPI docs for Laravel with Swagger-PHP
authors: phil
excerpt: This guide describes, in a code-first approach and Laravel codebase, how to generate OpenAPI description documents, enhancing it with contextual information and deploying it to Bump.sh.
date: 2024-01-25
---

API Code-first is the art of building an API, and then popping some annotations or metadata in there to output API documentation in an API description format like [OpenAPI](https://spec.openapis.org/oas/latest.html).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Generating OpenAPI docs for Ruby on Rails with RSwag
authors: phil
excerpt: This guide describes, in a code-first approach and RoR codebase, how to generate OpenAPI description documents, enhancing it with contextual information and deploying it to Bump.sh.
date: 2024-02-02
---

API Code-first is the art of building an API, and then popping some annotations or metadata in there to output API documentation in an API description format like [OpenAPI](https://spec.openapis.org/oas/latest.html).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: phil
image: images/guides/code_first_openapi.png
canonical_url: https://bump.sh/blog/code-first-openapi
excerpt: Learn how to generate OpenAPI from an existing codebase.
date: 2024-01-22
---

API Code-first is the art of building an API, and then popping some annotations or metadata in there to output API documentation in an API description format like [OpenAPI](https://spec.openapis.org/oas/latest.html). There are a few conceptually different ways to do this, with new tools popping up to help make everything easier, so this guide will show you how those different types of tool work.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Using OpenAPI to simplify building and testing Laravel APIs
authors: phil
excerpt: Dive into the API Design-first workflow with Laravel PHP, leveraging OpenAPI to power your server-side request validations, and build a contracting test suite based off that same API contract.
date: 2024-03-25
---

Laravel PHP is a powerful framework with loads of handy community extensions for building APIs, and working with [OpenAPI](https://spec.openapis.org/oas/latest.html) tooling.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Using OpenAPI to simplify building and testing Ruby on Rails APIs
authors: phil
excerpt: In a Design-first approach and RoR API, leverage OpenAPI to verify specific request responses or write a test suite for your complete API contracts.
date: 2024-03-25
---

Ruby on Rails developers are blessed with a bunch of great [OpenAPI](https://spec.openapis.org/oas/latest.html) tooling, and can use either of the API Code-First workflow which was popular for a long time, or the follow the newer API Design-first workflow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Jerry Ejonavi
image: images/guides/express-js-open-api.png
canonical_url: https://bump.sh/blog/express-api-openapi
excerpt: This tutorial walks you through the creation of a REST API in a Node.JS enviromnent, and its documentation using Bump.sh.
date: 2024-03-25
---

[Express](https://expressjs.com/) is a popular backend JavaScript framework for building landing pages and integrated content management systems or integrating APIs with other tools. With over [twenty million weekly downloads on npm](https://www.npmjs.com/package/express) at the time of writing, the framework's popularity comes from its ease of setup and use, extensibility with first- and third-party middleware functions, and its flexible built-in router.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "How to use JSONPath"
authors: phil
excerpt: JSONPath is a query language that can be used to extract data from JSON documents, powering OpenAPI Overlays amongst other useful functionality in the world of APIs.
date: 2024-04-22
---

A few years ago most API designers, developers, and technical writers would have had very little reason to bump into JSONPath, but its starting to get more and more relevant as more tools and standards start relying on it. So what is JSONPath, what is it used for, and how can you get up to speed with using it?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'OpenAPI v4.0 (A.K.A "Project Moonwalk")'
authors: phil
canonical_url: https://bump.sh/blog/openapi-moonwalk
excerpt: What is coming next for OpenAPI, as v4.0 of the OpenAPI Specification gets closer to being released? What major changes are coming, how easy will it be to upgrade, and how do tooling companies feel about it?
date: 2024-04-15
---

What is coming next for OpenAPI, as v4.0 of the OpenAPI Specification gets closer to being released? What major changes are coming, how easy will it be to upgrade, and how do tooling companies feel about it?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors: Grégoire Pichat
image: images/guides/what-is-openapi.png
canonical_url: https://bump.sh/blog/what-is-openapi
excerpt: OpenAPI allows to describe, develop, test, and document APIs conforming to the REST architecture, to create RESTful APIs.
date: 2023-10-19
---
OpenAPI is a standard for describing APIs (Application Programming Interfaces). The OpenAPI specification (or OAS) defines an open and independent description format for API services and allows both humans and computers to discover and understand how an API works and how to interact with it, without the need to look at the source code. More specifically, OpenAPI allows to describe, develop, test, and document APIs conforming to the REST architecture, to create RESTful APIs.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: 5 Improvements to OpenAPI Operation Documentation
authors: james
canonical_url: https://bump.sh/blog/5-improvements-to-openapi-operation-documentation
excerpt: A look at five operation-specific improvements that you can make to deliver on a great developer experience while reducing the support costs of your API.
excerpt: A look at five operation-specific improvements that you can make to deliver on a great developer experience while reducing the support costs of your API.
date: 2024-05-14
---

After conducting API design and documentation reviews for over a decade, there are common mistakes that most developers make when composing their reference documentation using the OpenAPI Specification. Let’s look at five operation-specific improvements that you can make to deliver on a great developer experience while reducing the support costs of your API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: API Documentation Checklist
authors: james
canonical_url: https://bump.sh/blog/api-documentation-checklist
excerpt: A checklist to help you identify the documentation you will need for launching your API.
date: 2024-05-02
---

Your API is nearing completion and it’s time to let the world know about it. This means that it is time to complete your API documentation effort. But, where should you start? How do you know if you covered everything that your decision makers and developers will need to select your API and get started successfully?
Expand Down
Loading

0 comments on commit 3128b12

Please sign in to comment.