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

Webui: add link to offline documentation in /www/docs #195

Closed
ilario opened this issue Aug 1, 2017 · 8 comments
Closed

Webui: add link to offline documentation in /www/docs #195

ilario opened this issue Aug 1, 2017 · 8 comments

Comments

@ilario
Copy link
Member

ilario commented Aug 1, 2017

lime-docs package includes documentation for offline use in LibreMesh firmware images.
The documentation is installed in /www/docs directory (with a symbolic link from /docs), so that it can be accessed by the http server.
A link has to be added in the lime-webui for accessing this documentation directory.

@ghost
Copy link

ghost commented Feb 18, 2018

I don't know what's the syntax being used (asciidoc?) but I think that in the website should render that format in something more web-based

@ilario
Copy link
Member Author

ilario commented Feb 18, 2018

AsciiDoc renderer is written in Python, AsciiDoctor renderer is written in Ruby. I believe that for obtaining HTML pages from AsciiDoc files, one of these two is needed but none can fit in a router.

If we really really want this, the only option I see is to download HTML pages from the website during lime-docs compilation.

@nicopace
Copy link
Member

I would go for a progressive enhancement approach... a link for now would suffice.
Also, asciidoc was ment to be read in ascii, so we shouldn't bother much about that.
@ilario is that something u can do? (A menu option in luci for accessing the docs).

@ilario
Copy link
Member Author

ilario commented Dec 8, 2018

@nicopace I'm not knowledgeable with the web interface, maybe @gmarcos87?

@ilario
Copy link
Member Author

ilario commented Oct 4, 2019

@gmarcos87 do you think it's a good or a bad idea to have a documentation tab in the lime-app?

@nicopace
Copy link
Member

nicopace commented Oct 8, 2019

It feels I had a change of heart on this, because now luci is not that relevant:

I wouldn't add it like it is in the lime-app as it would create noise to the lime-app users without adding value.
The technical capacity traning part of lime-app needs to get thought through as a project in itself.
I wouldn't add it on the web, would just add a comment on the /etc/banner saying that there is documentation on the router, as most of the doc are more for a technical audience than they are for the average user.

@ilario
Copy link
Member Author

ilario commented Oct 8, 2019

I wouldn't add it on the web, would just add a comment on the /etc/banner saying that there is documentation on the router

Ok, makes sense. New issue for this here: #616
So now it does not make any sense that the docs are placed in /www/docs and linked in /docs, we can change also that.

@ilario
Copy link
Member Author

ilario commented Jan 9, 2020

I wouldn't add it on the web

Ok, so in #675 I removed it from /www

@ilario ilario closed this as completed Jan 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants