<div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jun 20, 2023 at 7:20 PM Andrew Latham <<a href="mailto:lathama@gmail.com">lathama@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">Maybe file an issue at <a href="https://github.com/asterisk/documentation/issues" target="_blank">https://github.com/asterisk/documentation/issues</a><br><br>I just tested and it works on localhost for me. It also prompted me for cookies so I will do a PR for that.</div></blockquote><div><br></div><div>PR to disable cookies has been merged.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jun 20, 2023 at 6:53 PM <<a href="mailto:asterisk@phreaknet.org" target="_blank">asterisk@phreaknet.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On 6/20/2023 8:33 PM, George Joseph wrote:<br>
> On Tue, Jun 20, 2023 at 5:06 PM Joshua C. Colp <<a href="mailto:jcolp@sangoma.com" target="_blank">jcolp@sangoma.com</a> <br>
> <mailto:<a href="mailto:jcolp@sangoma.com" target="_blank">jcolp@sangoma.com</a>>> wrote:<br>
><br>
> On Tue, Jun 20, 2023 at 3:51 PM <<a href="mailto:asterisk@phreaknet.org" target="_blank">asterisk@phreaknet.org</a><br>
> <mailto:<a href="mailto:asterisk@phreaknet.org" target="_blank">asterisk@phreaknet.org</a>>> wrote:<br>
><br>
> On 6/20/2023 10:32 AM, George Joseph wrote:<br>
> > The one exception is the auto-generated documentation for<br>
> > AMI/ARI/Dialplan. That I'm starting to work on now.<br>
> Thanks, George - I see from the README that one can run this<br>
> on a local<br>
> webserver. Will the auto-generated documentation aspect tie in<br>
> with this<br>
> as well? I wrote my own xmldoc to HTML generator a while back<br>
> so I can<br>
> view documentation for out of tree modules. If this can do<br>
> that out of<br>
> the box, then that would certainly be nice functionality to take<br>
> advantage of. Will it just be sourcing from a core xml file,<br>
> that we can<br>
> point elsewhere if we want, or is that going to remain more<br>
> upstream<br>
> specific like it was with Confluence?<br>
><br>
><br>
> I don't know how George plans to approach it fully, but ultimately<br>
> the reference documentation will also end up as markdown and<br>
> consumed with mkdocs. I do not expect those markdown files to be<br>
> checked into the tree but generated as part of the deploy process.<br>
> Any tooling to consume the XML and produce the markdown files will<br>
> be available, so if someone wanted it locally they could.<br>
><br>
><br>
> Each version of Asterisk generates between 800 and 900 pages of <br>
> dynamic docs so it's going to take a bit of thought on how to <br>
> integrate them. As Josh noted, we don't want those markdown files <br>
> checked into the repo but we do want mkdocs to integrate them <br>
> seamlessly into the main docs site, including the search indexing. <br>
> We could run a full site build once a night to convert the static and <br>
> dynamic pages into html and index them all BUT we don't have <br>
> server-side searching available so it's done in the browser and right <br>
> now, even without the dynamic pages, the search_index.json file is <br>
> 4.1MB. This might make it prudent to create a "virtual" site with its <br>
> own index just for the dynamic docs and link to it from the main <br>
> site. Maybe even a separate virtual site for each Asterisk version. <br>
> In fact, there are tools to create a versioned API site already <br>
> available. Kind of like how Python does it with a drop down at the top <br>
> of every page to select the Python version you want to see the <br>
> documentation for.<br>
<br>
Thanks, George - that helps!<br>
I was a bit surprised by how fast the search results were on the new <br>
site. It seems to be a lot better than the old wiki (which doesn't seem <br>
to work anymore, either...)<br>
<br>
There does seem to be an issue with the web hosting. It seems to be running:<br>
root@debian11:/usr/src/documentation# mkdocs serve<br>
INFO - Building documentation...<br>
INFO - Cleaning site directory<br>
INFO - Documentation built in 16.96 seconds<br>
INFO - [20:42:02] Watching paths for changes: 'docs', 'mkdocs.yml'<br>
INFO - [20:42:02] Serving on <a href="http://127.0.0.1:8000/" rel="noreferrer" target="_blank">http://127.0.0.1:8000/</a><br>
<br>
But if I navigate to port 8000 on that machine in my browser, I get <br>
nothing... nothing even seems to be listening on that port.<br>
It works if I curl localhost on that server, so it seems to be listening <br>
on just the loopback address. I don't really see how that's helpful - it <br>
should probably be listening on all interfaces, so one can see what it <br>
looks like graphically, no?<br>
<br>
Realistically though, I wouldn't want to run a separate python server <br>
anyways, I just want static webpages I can serve in an Apache <br>
virtualhost, like my current doc generation process. It seems if I run <br>
"mkbuild docs" it does that. So if the dynamic docs have a similar <br>
process this seems like it will work great!<br>
<br>
-- <br>
_____________________________________________________________________<br>
-- Bandwidth and Colocation Provided by <a href="http://www.api-digital.com" rel="noreferrer" target="_blank">http://www.api-digital.com</a> --<br>
<br>
asterisk-dev mailing list<br>
To UNSUBSCRIBE or update options visit:<br>
<a href="http://lists.digium.com/mailman/listinfo/asterisk-dev" rel="noreferrer" target="_blank">http://lists.digium.com/mailman/listinfo/asterisk-dev</a></blockquote></div><br clear="all"><div><br></div><span class="gmail_signature_prefix">-- </span><br><div dir="ltr" class="gmail_signature"><div dir="ltr">- Andrew "lathama" Latham -</div></div>
-- <br>
_____________________________________________________________________<br>
-- Bandwidth and Colocation Provided by <a href="http://www.api-digital.com" rel="noreferrer" target="_blank">http://www.api-digital.com</a> --<br>
<br>
asterisk-dev mailing list<br>
To UNSUBSCRIBE or update options visit:<br>
<a href="http://lists.digium.com/mailman/listinfo/asterisk-dev" rel="noreferrer" target="_blank">http://lists.digium.com/mailman/listinfo/asterisk-dev</a></blockquote></div></div>