search

Doctave / doctave

A batteries-included developer documentation site generator
https://cli.doctave.com
MIT License
566 stars 32 forks source link

Support for deploying to a website path instead of a website root #10

Closed ciwchris closed 3 years ago

ciwchris commented 3 years ago

It appears the generated site can only be deployed to the root of a website, ex: "https://example.com/index.html", because leading slashes are used on all assets. What do you think of supporting generating the site so it can be deployed to a path, ex: "https://example.com/documenation/index.html"?

begleynk commented 3 years ago

You're correct - this isn't currently supported but sounds like a positive feature to add.

Is this blocking you from using Doctave? I'd be happy to add this into the next 0.3.0 release with a couple other things but they are still in the works.

ciwchris commented 3 years ago

Currently I'm experimenting. I intend to present it to my team next week. Typically it's a slow process though. What will probably end up happening is that a trial go ahead will be given and I'll start to mirror some of our docs. There are other options I can use to deploy to that will work at the root, but deploying to a path will be much easier.

But relatedly, I also tried taking a look at the Doctave service. Unfortunately I ran into a problem with the cert at docs.doctave.com. My company terminates TLS connections at the firewall and inserts their own cert. For docs.doctave.com the browser responds with ERR_HTTP2_INADEQUATE_TRANSPORT_SECURITY. So there's something about the cert my company doesn't like. Not your problem but currently that's going to be a pretty hard blocker for me.

begleynk commented 3 years ago

Understood. I should be able to get that feature out early next week for you in the next release.

I'll have to look into that SSL issue a bit more carefully. Our certificates come through our hosting provider so it will require a bit of research on my end. If you have any questions you can also always email me at nik@doctave.com

begleynk commented 3 years ago

This is now available in the latest 0.3.0 release.

Relevant documentation can be found here. The short story is that you now add a base_path section into your doctave.yaml file which will instruct Doctave to generate all files based on the provided path.

I'm going to close this ticket but feel free to open a new one if you encounter any issues.