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

Documentation hosting lifecycle #35

Open
bbworld1 opened this issue Jul 20, 2021 · 2 comments
Open

Documentation hosting lifecycle #35

bbworld1 opened this issue Jul 20, 2021 · 2 comments

Comments

@bbworld1
Copy link
Contributor

bbworld1 commented Jul 20, 2021

Currently, hosted documentation sites follow the same 30-day deletion policy as the rest of the generated artifacts. However, this means that currently, hosting persistent documentation with Nunaweb is impossible, as docs will be deleted in 30 days.

To me, it does not seem to be possible to resolve this in a secure manner without some sort of authentication. Such an authentication system would be necessary 1) to allow updating of a generated site, and 2) to deter spam requests.

The current solutions I can think of are:

  • Implement an account login/authentication system to manage hosted sites
  • Kick off the problem as being out of scope (in this case, Nunaweb would generate temporary sites only, and permanent sites would be hosted somewhere else)

Perhaps someone else has some suggestions.

@pavel-kirienko
Copy link
Member

Implement an account login/authentication system to manage hosted sites

I did once write a website based on Flask that supported proper authentication and I don't recall having any difficulties with that (and I am not a web developer by any margin) since Flask pretty much handles everything out of the box. So my guess is that this probably shouldn't be a major obstacle for us.

However, right now it is probably not that critical. Maybe we could somehow arrange it such that docs generated for the official public regulated data types repository are kept forever until replaced by a newer revision, while for any other source the 30-day policy applies?

@pavel-kirienko
Copy link
Member

@bbworld1 can we maybe arrange some special privileges for us, the maintainers, to be able to host the docs for the public regulated data types persistently? I would like to link the docs of the fledging UDRAL namespace from its README. Maybe we could provide a secret token in the name field or something.

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