docat-org/docat

Question: Uploading files seems to override the index.html

Closed this issue · 3 comments

Hello, I just found this project and seem to get stuck in the setup.

I am running the project locally with docker like stated in the documentation

mkdir -p docat-run/doc
docker run \
  --detach \
  --volume $PWD/docat-run:/var/docat/ \
  --publish 8000:80 \
  ghcr.io/docat-org/docat

I uploaded a zipped index.html file

curl -X POST -F "file=@docs.zip" http://localhost:8000/api/new-project/1.0.0
{"message":"File successfully uploaded"}

and on the UI, I can see the new project and can navigate to its index.html.

However, when I upload another file

curl --header "Docat-Api-Key: c0eefad74d00d4cc3eb6287dd8345f5d" -X POST -F "file=@Dockerfile" http://localhost:8000/api/new-project/1.0.0/
{"message":"File successfully uploaded"}

and I navigate to the new-project, then I get a 404 from nginx

image

The workflow is you gather all files for your documentation version put them in a zip and upload them at once.

Not sure what you are trying to do.

After uploading the documentation, I want to upload additional files, because that's what I thought was the process. Create a project with documention and then start uploading files

Is it perhaps, that once the project is created, all new documents have to uploaded in a zip file even if it's just one new file?

yes you need to upload all files at once, and project and version getting automatically created if they don't exist

there is no adding files, just replacing everything