crossplane / docs

Repo for Crossplane documentation.
https://docs.crossplane.io
Other
47 stars 105 forks source link

API Docs Backend Refactor #757

Closed plumbis closed 2 months ago

plumbis commented 3 months ago

This PR is a modularizes the API docs generation code that is in place today. This will make maintenance way easier for anyone that isn't me.

This also moves the CRD directory from /content/<version>/api/yaml to the more obvious /content/<version>/api/crds.

This also fixes existing bugs found during development around processing and displaying enum data types.

(this is a revamp of #737 without the description files changes)

netlify[bot] commented 3 months ago

Deploy Preview for crossplane ready!

Name Link
Latest commit e5760250bcdc3c28eb031ea6ef9fa1c6e25394c3
Latest deploy log https://app.netlify.com/sites/crossplane/deploys/66202f22c2343b0008e75367
Deploy Preview https://deploy-preview-757--crossplane.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
1 paths audited
Performance: 82 (🔴 down 8 from production)
Accessibility: 88 (🔴 down 3 from production)
Best Practices: 83 (no change from production)
SEO: 93 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

jbw976 commented 2 months ago

@plumbis consider squashing your commits as there are definitely some of the 40 commits here that aren't necessary to tell a complete story in the commit history 😉