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.

Sign up for GitHub

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

Jump to bottom

Self host redoc #284

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Self host redoc #284

wants to merge 4 commits into from

Conversation

Zanda256
Copy link

@Zanda256 Zanda256 commented Feb 6, 2025 •
edited
Loading

With this change, we download and host the latest Redoc script every time we generate a backend.

Resolves #38

Checklist

  • I have read the contribution guide.
  • I have not used an AI coding assistant to create this PR.
  • My contribution is compatible with the MPL-2.0 license and I have provided a DCO sign-off on all my commits.
  • I have written all code in this PR myself OR I have marked all code I have not written myself (including modified code, e.g. copied from other places and then modified) with a comment indicating where it came from.

abstractionfactory
abstractionfactory suggested changes Feb 7, 2025
View reviewed changes
Copy link
Contributor

@abstractionfactory abstractionfactory left a comment

Choose a reason for hiding this comment

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

Looking good, a few more things just caught my eye.

abstractionfactory
abstractionfactory suggested changes Feb 12, 2025
View reviewed changes
Copy link
Contributor

@abstractionfactory abstractionfactory left a comment

Choose a reason for hiding this comment

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

Hey @Zanda256 looking good! Let's add the SHA256 checksum explicitly to the pull tool as a command line argument and we'll record it the first time we download it in the go:generate command.

abstractionfactory
abstractionfactory approved these changes Feb 13, 2025
View reviewed changes
Copy link
Contributor

@abstractionfactory abstractionfactory left a comment

Choose a reason for hiding this comment

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

LGTM! I'd refactor the download tool to deduplicate the code, but this can be done later. Thank you for your work!

@Zanda256
Copy link
Author

LGTM! I'd refactor the download tool to deduplicate the code, but this can be done later. Thank you for your work!

My pleasure @abstractionfactory .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abstractionfactory abstractionfactory abstractionfactory approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Self-host ReDoc
2 participants
@Zanda256 @abstractionfactory