Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add astro-graphql-plugin to the documentation #1814

Merged
merged 13 commits into from
Sep 16, 2023
Merged

Conversation

AlexLakatos
Copy link
Member

@AlexLakatos AlexLakatos commented Sep 3, 2023

Add astro-graphql-plugin plugin that automatically generates GraphQL API docs on every build.

Changes proposed in this pull request

  • port old graphql-plugin to astro and add it to the docs
  • fix implementedBy link paths
  • remove doc generation step from CI

Context

Closes #1815

Checklist

  • Related issues linked using fixes #number
  • Tests added/updated
  • Documentation added
  • Make sure that all checks pass
  • Postman collection updated

@AlexLakatos AlexLakatos requested a review from huijing September 3, 2023 20:27
@netlify
Copy link

netlify bot commented Sep 3, 2023

Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit 5b03944
🔍 Latest deploy log https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/65059f5d1288340008bd571b
😎 Deploy Preview https://deploy-preview-1814--brilliant-pasca-3e80ec.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@github-actions github-actions bot added pkg: documentation Changes in the documentation package. type: documentation (archived) Improvements or additions to documentation labels Sep 3, 2023
@AlexLakatos
Copy link
Member Author

@huijing: of course I left a bug in there for you 😅 . The sidebar gets expanded and highlighted twice, because both the Backend API and the Auth API have the same menu items. I'm pretty sure that's not a bug with the plugin, and it's an Astro thing though.

Screenshot 2023-09-03 at 21 29 24

@AlexLakatos
Copy link
Member Author

@huijing Ignore that last comment, turns out PEBCAK, and it was my fault. I fixed it in 7723574

Copy link
Contributor

@huijing huijing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran locally and LGTM.
But would like @mkurapov and @sabineschaller to chime in.
Also, how does this work, do the markdown files get generated when the build runs or? How do people update the docs when the schema changes?

@sabineschaller
Copy link
Member

@mkurapov why is there no preview for this?

@mkurapov
Copy link
Contributor

mkurapov commented Sep 4, 2023

@sabineschaller from the Netlify logs:

10:36:59 PM: No changes detected in base directory. Returning early from build.

I removed the cache and re-built, the preview is there now

@sabineschaller
Copy link
Member

sabineschaller commented Sep 5, 2023

from the logs:

10:36:59 PM: No changes detected in base directory. Returning early from build.

I removed the cache and re-built, the preview is there now

@mkurapov Oh, so the splitting of the file doesn't happen locally but on build?

@github-actions github-actions bot added the type: ci Changes to the CI label Sep 16, 2023
@huijing huijing merged commit c0460ae into main Sep 16, 2023
23 checks passed
@huijing huijing deleted the docs-graphql branch September 16, 2023 12:41
@mkurapov
Copy link
Contributor

Just checked on rafiki.dev, all looks 👌 thanks @AlexLakatos & @huijing !

All wanted to mention is we can remove packages/documentation/src/schema-dumps folder now, but NABD

@AlexLakatos
Copy link
Member Author

@mkurapov missed those, sorry. Here's a PR for it: #1888

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: documentation Changes in the documentation package. type: ci Changes to the CI type: documentation (archived) Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create plugin that can generate API documentation in markdown from schema
4 participants