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

Nginx issue #509

Closed
sequoiap opened this issue May 2, 2023 · 3 comments · Fixed by #530
Closed

Nginx issue #509

sequoiap opened this issue May 2, 2023 · 3 comments · Fixed by #530

Comments

@sequoiap
Copy link

sequoiap commented May 2, 2023

I'm running the commands as given in the readme, and I'm able to upload (using curl) a zipped folder containing the html output of Sphinx where index.html is at the top level, and I get a "success" response. (I'm building my docs using JupyterBook.) The project than shows up in the docat landing page, but navigating to the project docs itself returns an Nginx 404 error. I can upload a single index.html file, and that displays. But the zipped directory is not working.
@fliiiix
Copy link
Member

fliiiix commented May 3, 2023

Can you share the zip file to have a look at it?

@sequoiap
Copy link
Author

It was my fault. I finally figured out that I shouldn't just zip up the html/ folder from _build/ (I'm using Sphinx), but rather the contents of the html/ folder. So, my index.html was nested one layer too deep. Maybe we can add a short note to the README as a "common mistake" to help future users.

@randombenj
Copy link
Member

Maybe issuing a warning in the api response when no /index.html file is found in the zip file would be nice.
I think we can keep the issue open to address something like this what do you think @fliiiix ?

reglim added a commit that referenced this issue Jun 5, 2023
@reglim
Feature: Add warning if index.html is missing in uploaded archive
ce56d97 
Upload now tests whether an index.html file is present, and returns the
following message if not:

"File successfully uploaded, but no index.html found at root of archive."

Fixes: #509
@reglim reglim mentioned this issue Jun 5, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature: Add warning if index.html is missing in uploaded archive docat-org/docat
3 participants
@fliiiix @randombenj @sequoiap