DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

Cover image for πŸ” Build & deliver static documentation w. Quarkus/Reodcly on GitHub Pages πŸ“˜
adriens for opt-nc

Posted on • Originally published at youtu.be

πŸ” Build & deliver static documentation w. Quarkus/Reodcly on GitHub Pages πŸ“˜

❔ About

Today, CD (Continuous Delivery) of up-to-date documentation is a crucial step if you want to achieve things at scale.

APIs do not make exception : we deliver embedded swagger, but...

more and more outside collaborators ask for offline documentation, or on API marketplaces.

And (hopefully) :

your outside contributors or clients are more numerous than you.

☝️ So you have to deliver them an optimal DX (Developer-Experience) that costs no work to your organization.

πŸ‘‰ We'll show you how we deliver documentation for :

  • πŸ€“ Human people
  • πŸ€– Third party CI services for integration purposes

πŸ’‘ What we'll cover

What we'll show here is how we deliver a static OpenAPI specification (html and yaml), as part of the release process.

πŸ‘‰ With that, it makes it very easy to import your API into any API marketplace, see below on Google apigee :

Image description

🧰 Stack

🍿 Demo

Enough talks, let's watch this very cool step by step and short (<10') demo from @mbarre :

πŸ”– Resources

πŸ“† Date to save

Top comments (3)

Collapse
 
adriens profile image
adriens

Collapse
 
adriens profile image
adriens
Collapse
 
adriens profile image
adriens

Regex for lazy developers

regex for lazy devs

You know who you are. Sorry for the callout πŸ˜†