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

s3 storage for the index files #25

Open
jippi opened this issue May 5, 2022 · 1 comment
Open

s3 storage for the index files #25

jippi opened this issue May 5, 2022 · 1 comment

Comments

@jippi
Copy link

jippi commented May 5, 2022

Hey!

Would be fantastic if doctree serve could use s3 as filesystem backend - would allow me to use doctree index in CI and upload the files to s3 where they could be served, allowing a central highly-available doctree frontend for all projects

Maybe via a filesystem abstraction layer like https://github.com/usmanhalalit/gost , https://github.com/lytics/cloudstorage , https://github.com/graymeta/stow

Note: my use-case only covers frontend part, assuming i can s3 upload the indexed file to the right path and it would just work

@slimsag
Copy link
Member

slimsag commented May 5, 2022

Thanks for filing this! I can't say for sure right now if this will make sense or not. The reason being: search.

I really need to figure out how to do good/nice search indexing for the docs, and that will likely involve leveraging local SSD performance (otherwise it'd require a lot of memory.)

I do think finding a way for this to be super simple to deploy, easily turned into an HA service, and (most importantly) easy to keep your projects indexed is extremely important though.

I'll keep this issue open and revisit once I have a better idea of how search in doctree will look / be implemented.

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

No branches or pull requests

2 participants