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

Add remote file opening via HTTP #59

Merged
merged 1 commit into from
Dec 14, 2015

Conversation

brettchalupa
Copy link
Contributor

This adds support for loading the markdown and JSON from remote servers
by using open-uri. This means the docs can live outside of the
application server and not need to be generated or checked into the app.

The usecase for doing this is so that a Continuous Integration (CI)
server can generate the docs since it is already setup for the test
environment, which RAD requires. Then, after generation, it uploads the
RAD docs (JSON and markdown files) to a static file host, like AWS S3,
and then those docs get served to the application environments when
viewing the API docs.

This lets the docs be viewed in live application environments without
checking the docs into the app since they may change often.


Let me know if this change is fitting for Apitome; if not, no worries. If I
need to add specs or adjust the Ruby style, totally let me know.

Thanks for building such a great doc viewer. 😄

This adds support for loading the markdown and JSON from remote servers
by using open-uri. This means the docs can live outside of the
application server and not need to be generated or checked into the app.

The usecase for doing this is so that a Continuous Integration (CI)
server can generate the docs since it is already setup for the test
environment, which RAD requires. Then, after generation, it uploads the
RAD docs (JSON and markdown files) to a static file host, like AWS S3,
and then those docs get served to the application environments when
viewing the API docs.

This lets the docs be viewed in live application environments without
checking the docs into the app since they may change often.
@jejacks0n
Copy link
Owner

I absolutely love the idea, but don't have the time to review it right now.. please give me a few days to get back to you on this. I've been meaning to give this project some needed love and attention, but work has been taking it's toll. =)

@brettchalupa
Copy link
Contributor Author

@jejacks0n No rush or worries at all, thanks!

jejacks0n added a commit that referenced this pull request Dec 14, 2015
Add remote file opening via HTTP
@jejacks0n jejacks0n merged commit ff99335 into jejacks0n:master Dec 14, 2015
@jejacks0n
Copy link
Owner

I'll merge it and see how it plays out. =) thanks again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants