-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Allow fetching special files in the documentation #1698
Allow fetching special files in the documentation #1698
Conversation
Co-Authored by: Kehinde Olofinmoyin <kehindeolofinmoyin@hotmail.com>
…- requires refactoring
Co-Authored by: Kehinde P. Olofinmoyin <kehindeolofinmoyin@hotmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! A few comments to make it a little bit more Ruby-like.
I think too we might want to look at trying to test this out in: spec/features/documentation_spec.rb
Co-authored by: Kehinde Olofinmoyin <kehindeolofinmoyin@hotmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm trying to test this, but I'm having issues getting things installed on Windows (surprise). I'm trying something new; I'll report back.
This reverts commit 1ed0804. Removed commits that make README a special file, as they belong in their own pull request. Fixed issue where symlink doesn't work on Windows machines. Removed symlink, instead load the Contributing.md doc via a Special File hash in the Docs Controller Class. Co-author: Kehinde Olofinmoyin <kehindeolofinmoyin@hotmail.com>"
As mentioned, I've been trying to get this working on Windows, but have failed so far :-/ How did you install things on Windows yourself? I have tried this so far:
So it appears that you installed things in some way that allowed you to run |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is good to go now.
To answer @pablobm's question, if we flip the messaging of this PR to be about what it really is, vs. what motivated it is perhaps a better way of putting it. We were trying to fix #1693, where Administrate was using a symlink and breaking things. I don't think we can do much about dependencies (apart from going to their repos and opening PRs to fix them there).
We could perhaps rename this to be: "Allow fetching special files in the documentation", with a body like:
In #1514, we added a symlink so that the docs would show up on the demo app …but
symlinks aren't supported on Windows and was causing a problem when trying to bundle.This instead adds a lookup table of files not in
docs/
which allows us to render those.This partially fixes #1693, in allowing Administrate itself to be bundled without a symlink but
other dependencies have the same problem.
Right, I had misunderstood something. I thought this was about running the Administrate dev environment, which would require running OK, let's try this. I can't really test it properly because the problem doesn't appear if I install the gem from the GitHub repo ( |
Co-authored-by: Nick Charlton <nick@nickcharlton.net>
Co-authored-by: Nick Charlton <nick@nickcharlton.net>
In #1514, we added a symlink so that the docs would show up on the demo app …but
symlinks aren't supported on Windows and was causing a problem when trying to bundle.
This instead adds a lookup table of files not in docs/ which allows us to render those.
This partially fixes #1693, in allowing Administrate itself to be bundled without a symlink but
other dependencies have the same problem.