[GH-ISSUE #4] split dynamic, templated help and static documentation #3

New issue

Closed

opened 2026-02-26 09:34:51 +03:00 by kerem · 1 comment

kerem commented

2026-02-26 09:34:51 +03:00

Owner

Originally created by @ThomasWaldmann on GitHub (Oct 22, 2013).
Original GitHub issue: https://github.com/nsupdate-info/nsupdate.info/issues/4

ThomasWaldmann wrote:
dynamic, templated help (like showing configs for the user, with hostname, password, etc. already in place): should stay in django templates

static help, like FAQ should go into sphinx docs and linked from UI.
it is easier to update there than in html templates.

we can link to the sphinx docs from either footer or a minimal help page.

where will sphinx docs get hosted?

include it, so it is statically served on same site?

put it on rtd? versioning?

Originally created by @ThomasWaldmann on GitHub (Oct 22, 2013). Original GitHub issue: https://github.com/nsupdate-info/nsupdate.info/issues/4 ThomasWaldmann wrote: dynamic, templated help (like showing configs for the user, with hostname, password, etc. already in place): should stay in django templates static help, like FAQ should go into sphinx docs and linked from UI. it is easier to update there than in html templates. we can link to the sphinx docs from either footer or a minimal help page. where will sphinx docs get hosted? include it, so it is statically served on same site? put it on rtd? versioning?

kerem closed this issue

2026-02-26 09:34:51 +03:00

kerem commented

2026-02-26 09:34:52 +03:00

Author

Owner

@ThomasWaldmann commented on GitHub (Oct 22, 2013):

ThomasWaldmann wrote:
fixed in org repo, docs on rtd now, linked from help page

@ThomasWaldmann commented on GitHub (Oct 22, 2013): ThomasWaldmann wrote: fixed in org repo, docs on rtd now, linked from help page