docs.konghq.com icon indicating copy to clipboard operation
docs.konghq.com copied to clipboard

Generate OAS Overlays

Open mheap opened this issue 2 years ago • 1 comments

Description

Proof of concept OAS Overlay generation from source files. This needs more work if we want to explore further, but it shows what the source files look like and how the output file could be generated

DO NOT MERGE

Path to overlay adoption

  • Jekyll ignores overlay markdown files
  • Ability to apply multiple overlays and generate one file.
  • Optional Automatic upload to Dev Portal
  • Define workflow for everything for specs that live in the platform-api repo and the Kong Admin API specs that live in the docs repo.
    • This is because we currently own the Gateway admin API specs but eventually they will live in another repo, we also need to figure out how we will interact with the specs in platform-api.

Preview link: N/A

Checklist

  • [x] Review label added
  • [x] PR pointed to correct branch (main for immediate publishing, or a release branch: e.g. release/gateway-3.2, release/deck-1.17)

mheap avatar Oct 09 '23 11:10 mheap

Deploy Preview for kongdocs ready!

Name Link
Latest commit aeed8c49935352728319a0771beb28d16de7d99b
Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/6523e2eb5ffbc80008670f90
Deploy Preview https://deploy-preview-6261--kongdocs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
9 paths audited
Performance: 95 (🟢 up 2 from production)
Accessibility: 80 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 90 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Oct 09 '23 11:10 netlify[bot]