Re: [MirageOS-devel] docs.mirage.io building again

2017-01-18 Thread Anil Madhavapeddy
Dear all,

Another update on http://docs.mirage.io:

There has been quite a significant bit of work on odoc over the past few months 
by Daniel Buenzli and Thomas Refis, and so docs.mirage.io should reflect many 
of these:

- it now uses odoc by default, and not ocamldoc! You can find the old ocamldoc 
generation in the hidden url of http://docs.mirage.io/_ocamldoc if you really 
need it, but odoc is pretty good now for day-to-day use.
- it has been rebuilt with many rendering fixes for odoc, but please continue 
to report any issues you find to https://github.com/ocaml-doc/odoc/issues
- the latest mirage-dev packages are also included, but please do feel free to 
suggest more packages you would like in the central trove.  The list is at 
https://github.com/mirage/mirage in the Dockerfile.doc file, but I will 
probably move it out into a separate place before the release. I'll update the 
list when I do, but for now just propose packages directly in there.

regards,
Anil

> On 1 Nov 2016, at 12:22, Anil Madhavapeddy  wrote:
> 
> Another round of updates and the new http://docs.mirage.io is now deployed 
> with new packages for:
> - charrua-unix
> - cpuid
> - hkdf
> - jenga
> - logs-syslog
> - mirage-block-ccm
> - mirage-logs
> - mirage-os-shim
> - mirage-stdlib-random
> - ocb-stubblr
> - otr
> - pbkdf
> - scrypt-kdf
> - syslog-message
> 
> The tracking issue for bugs/features for docs is:
> https://github.com/mirage/mirage/issues/609
> 
> New bugs in there since the last round are support for ppx in interface files 
> (which seems to break things right now) and the 404s for CHANGES/README 
> (thanks Hannes for noticing).  If your request isnt on that list (aside from 
> search, which is a bigger issue), please comment on there.
> 
> thanks
> Anil
> 
>> On 28 Oct 2016, at 13:54, Anil Madhavapeddy  wrote:
>> 
>> Thanks for the pointer Nicolas, I didn't realise that was still under active 
>> development! Hooking it into odig should be a fun exercise.
>> 
>> An update on docs.mirage.io:
>> 
>> - it is now building again after the latest batch of mirage/mirage-dev 
>> changes.  Thanks to David Kaloper for lots of hard work on fixing up 
>> mirage-entropy and the associated packages.
>> - we now have more packages in there, such as cpuid 
>> http://docs.mirage.io/odoc/cpuid/Cpuid/index.html
>> - the odoc backend was temporarily broken but is also now working again; 
>> http://docs.mirage.io/odoc/ -- please report any cross-referencing issues on 
>> the https://github.com/ocaml-doc repos.
>> 
>> As usual, please iterate through the list and try to refresh any older 
>> packages to match the odig convention so that we have more metadata in place 
>> for LICENSES, CHANGES and versions.  This is an ongoing process so I'll keep 
>> reminding us all about it :-)
>> 
>> regards,
>> Anil
>> 
>>> On 21 Oct 2016, at 16:18, Nicolas Ojeda Bar  wrote:
>>> 
>>> Re search:
>>> 
>>> http://ocamloscope.herokuapp.com/
>>> 
>>> and
>>> 
>>> https://twitter.com/camlspotter/status/789416138333573120
>>> 
>>> Cheers!
>>> 
>>> - Nicolas
>>> 
>>> 
>>> On Fri, Oct 21, 2016 at 5:04 PM, Anil Madhavapeddy  wrote:
 On 19 Oct 2016, at 16:57, Anil Madhavapeddy  wrote:
> 
> On 19 Oct 2016, at 10:56, Martin Lucina  wrote:
>> 
>> On Friday, 14.10.2016 at 11:29, Anil Madhavapeddy wrote:
>>> Good news everyone! The experimental documentation repository at 
>>> http://docs.mirage.io now builds again, and has been refreshed to the 
>>> latest set of libraries assembled from the MirageOS3 dev remote at 
>>> https://github.com/mirage/mirage-dev
>> 
>> Some ideas for UX improvements to the docs pages:
>> 
>> 1) Hyperlinks on types. Eg. in functoria/Functoria_app.Cmd.html
>> "Rresult.result" should link to rresult/Rresult.html.
>> 
>> 2) A "Path" nagivation header with the full hierarchy. E.g.
>> rresult/Result.html currently has "Up", which takes me to the package's
>> index.page but I can't go "Up" from there.
>> 
>> 3) A "Search" box of some sort. Ideally just client-side, search over
>> packages/modules/types/descriptions?
> 
> Thanks Martin! I've updated the tracking issue at 
> https://github.com/mirage/mirage/issues/609 and filed a couple of 
> upstream issues on odig about this.
 
 http://docs.mirage.io is now rebuilding again after the latest set of 
 library merges and API changes.  There is some temporary breakage in the 
 odoc CSS that Thomas Refis and Daniel Bunzli are working on, so just use 
 the ocamldoc version for now.
 
> I'm not quite sure who will handle search across cmt files yet.  Is this 
> on the roadmap or want-list for Merlin? (this question is mainly directed 
> at Fred or Gemma, who have been looking at the Merlin feature roadmap 
> recently).
 
 And looking at search more, I'm reasonably sure that this won't happen in 
 the short term for docs.mirage.io in odoc -- we shoul

Re: [MirageOS-devel] docs.mirage.io building again

2016-11-01 Thread Anil Madhavapeddy
Another round of updates and the new http://docs.mirage.io is now deployed with 
new packages for:
- charrua-unix
- cpuid
- hkdf
- jenga
- logs-syslog
- mirage-block-ccm
- mirage-logs
- mirage-os-shim
- mirage-stdlib-random
- ocb-stubblr
- otr
- pbkdf
- scrypt-kdf
- syslog-message

The tracking issue for bugs/features for docs is:
https://github.com/mirage/mirage/issues/609

New bugs in there since the last round are support for ppx in interface files 
(which seems to break things right now) and the 404s for CHANGES/README (thanks 
Hannes for noticing).  If your request isnt on that list (aside from search, 
which is a bigger issue), please comment on there.

thanks
Anil

> On 28 Oct 2016, at 13:54, Anil Madhavapeddy  wrote:
> 
> Thanks for the pointer Nicolas, I didn't realise that was still under active 
> development! Hooking it into odig should be a fun exercise.
> 
> An update on docs.mirage.io:
> 
> - it is now building again after the latest batch of mirage/mirage-dev 
> changes.  Thanks to David Kaloper for lots of hard work on fixing up 
> mirage-entropy and the associated packages.
> - we now have more packages in there, such as cpuid 
> http://docs.mirage.io/odoc/cpuid/Cpuid/index.html
> - the odoc backend was temporarily broken but is also now working again; 
> http://docs.mirage.io/odoc/ -- please report any cross-referencing issues on 
> the https://github.com/ocaml-doc repos.
> 
> As usual, please iterate through the list and try to refresh any older 
> packages to match the odig convention so that we have more metadata in place 
> for LICENSES, CHANGES and versions.  This is an ongoing process so I'll keep 
> reminding us all about it :-)
> 
> regards,
> Anil
> 
>> On 21 Oct 2016, at 16:18, Nicolas Ojeda Bar  wrote:
>> 
>> Re search:
>> 
>> http://ocamloscope.herokuapp.com/
>> 
>> and
>> 
>> https://twitter.com/camlspotter/status/789416138333573120
>> 
>> Cheers!
>> 
>> - Nicolas
>> 
>> 
>> On Fri, Oct 21, 2016 at 5:04 PM, Anil Madhavapeddy  wrote:
>>> On 19 Oct 2016, at 16:57, Anil Madhavapeddy  wrote:
 
 On 19 Oct 2016, at 10:56, Martin Lucina  wrote:
> 
> On Friday, 14.10.2016 at 11:29, Anil Madhavapeddy wrote:
>> Good news everyone! The experimental documentation repository at 
>> http://docs.mirage.io now builds again, and has been refreshed to the 
>> latest set of libraries assembled from the MirageOS3 dev remote at 
>> https://github.com/mirage/mirage-dev
> 
> Some ideas for UX improvements to the docs pages:
> 
> 1) Hyperlinks on types. Eg. in functoria/Functoria_app.Cmd.html
> "Rresult.result" should link to rresult/Rresult.html.
> 
> 2) A "Path" nagivation header with the full hierarchy. E.g.
> rresult/Result.html currently has "Up", which takes me to the package's
> index.page but I can't go "Up" from there.
> 
> 3) A "Search" box of some sort. Ideally just client-side, search over
> packages/modules/types/descriptions?
 
 Thanks Martin! I've updated the tracking issue at 
 https://github.com/mirage/mirage/issues/609 and filed a couple of upstream 
 issues on odig about this.
>>> 
>>> http://docs.mirage.io is now rebuilding again after the latest set of 
>>> library merges and API changes.  There is some temporary breakage in the 
>>> odoc CSS that Thomas Refis and Daniel Bunzli are working on, so just use 
>>> the ocamldoc version for now.
>>> 
 I'm not quite sure who will handle search across cmt files yet.  Is this 
 on the roadmap or want-list for Merlin? (this question is mainly directed 
 at Fred or Gemma, who have been looking at the Merlin feature roadmap 
 recently).
>>> 
>>> And looking at search more, I'm reasonably sure that this won't happen in 
>>> the short term for docs.mirage.io in odoc -- we should be looking at some 
>>> Merlin or Hoogle-like solution.
>>> 
>>> Anil
>>> 
>>> 
>>> ___
>>> MirageOS-devel mailing list
>>> MirageOS-devel@lists.xenproject.org
>>> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel
>> 
>> ___
>> MirageOS-devel mailing list
>> MirageOS-devel@lists.xenproject.org
>> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel
> 
> ___
> MirageOS-devel mailing list
> MirageOS-devel@lists.xenproject.org
> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel

___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-28 Thread Anil Madhavapeddy
Thanks for the pointer Nicolas, I didn't realise that was still under active 
development! Hooking it into odig should be a fun exercise.

An update on docs.mirage.io:

- it is now building again after the latest batch of mirage/mirage-dev changes. 
 Thanks to David Kaloper for lots of hard work on fixing up mirage-entropy and 
the associated packages.
- we now have more packages in there, such as cpuid 
http://docs.mirage.io/odoc/cpuid/Cpuid/index.html
- the odoc backend was temporarily broken but is also now working again; 
http://docs.mirage.io/odoc/ -- please report any cross-referencing issues on 
the https://github.com/ocaml-doc repos.

As usual, please iterate through the list and try to refresh any older packages 
to match the odig convention so that we have more metadata in place for 
LICENSES, CHANGES and versions.  This is an ongoing process so I'll keep 
reminding us all about it :-)

regards,
Anil

> On 21 Oct 2016, at 16:18, Nicolas Ojeda Bar  wrote:
> 
> Re search:
> 
>  http://ocamloscope.herokuapp.com/
> 
> and
> 
>  https://twitter.com/camlspotter/status/789416138333573120
> 
> Cheers!
> 
> - Nicolas
> 
> 
> On Fri, Oct 21, 2016 at 5:04 PM, Anil Madhavapeddy  wrote:
>> On 19 Oct 2016, at 16:57, Anil Madhavapeddy  wrote:
>>> 
>>> On 19 Oct 2016, at 10:56, Martin Lucina  wrote:
 
 On Friday, 14.10.2016 at 11:29, Anil Madhavapeddy wrote:
> Good news everyone! The experimental documentation repository at 
> http://docs.mirage.io now builds again, and has been refreshed to the 
> latest set of libraries assembled from the MirageOS3 dev remote at 
> https://github.com/mirage/mirage-dev
 
 Some ideas for UX improvements to the docs pages:
 
 1) Hyperlinks on types. Eg. in functoria/Functoria_app.Cmd.html
 "Rresult.result" should link to rresult/Rresult.html.
 
 2) A "Path" nagivation header with the full hierarchy. E.g.
 rresult/Result.html currently has "Up", which takes me to the package's
 index.page but I can't go "Up" from there.
 
 3) A "Search" box of some sort. Ideally just client-side, search over
 packages/modules/types/descriptions?
>>> 
>>> Thanks Martin! I've updated the tracking issue at 
>>> https://github.com/mirage/mirage/issues/609 and filed a couple of upstream 
>>> issues on odig about this.
>> 
>> http://docs.mirage.io is now rebuilding again after the latest set of 
>> library merges and API changes.  There is some temporary breakage in the 
>> odoc CSS that Thomas Refis and Daniel Bunzli are working on, so just use the 
>> ocamldoc version for now.
>> 
>>> I'm not quite sure who will handle search across cmt files yet.  Is this on 
>>> the roadmap or want-list for Merlin? (this question is mainly directed at 
>>> Fred or Gemma, who have been looking at the Merlin feature roadmap 
>>> recently).
>> 
>> And looking at search more, I'm reasonably sure that this won't happen in 
>> the short term for docs.mirage.io in odoc -- we should be looking at some 
>> Merlin or Hoogle-like solution.
>> 
>> Anil
>> 
>> 
>> ___
>> MirageOS-devel mailing list
>> MirageOS-devel@lists.xenproject.org
>> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel
> 
> ___
> MirageOS-devel mailing list
> MirageOS-devel@lists.xenproject.org
> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel

___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-21 Thread Nicolas Ojeda Bar
Re search:

  http://ocamloscope.herokuapp.com/

and

  https://twitter.com/camlspotter/status/789416138333573120

Cheers!

- Nicolas


On Fri, Oct 21, 2016 at 5:04 PM, Anil Madhavapeddy  wrote:
> On 19 Oct 2016, at 16:57, Anil Madhavapeddy  wrote:
>>
>> On 19 Oct 2016, at 10:56, Martin Lucina  wrote:
>>>
>>> On Friday, 14.10.2016 at 11:29, Anil Madhavapeddy wrote:
 Good news everyone! The experimental documentation repository at 
 http://docs.mirage.io now builds again, and has been refreshed to the 
 latest set of libraries assembled from the MirageOS3 dev remote at 
 https://github.com/mirage/mirage-dev
>>>
>>> Some ideas for UX improvements to the docs pages:
>>>
>>> 1) Hyperlinks on types. Eg. in functoria/Functoria_app.Cmd.html
>>> "Rresult.result" should link to rresult/Rresult.html.
>>>
>>> 2) A "Path" nagivation header with the full hierarchy. E.g.
>>> rresult/Result.html currently has "Up", which takes me to the package's
>>> index.page but I can't go "Up" from there.
>>>
>>> 3) A "Search" box of some sort. Ideally just client-side, search over
>>> packages/modules/types/descriptions?
>>
>> Thanks Martin! I've updated the tracking issue at 
>> https://github.com/mirage/mirage/issues/609 and filed a couple of upstream 
>> issues on odig about this.
>
> http://docs.mirage.io is now rebuilding again after the latest set of library 
> merges and API changes.  There is some temporary breakage in the odoc CSS 
> that Thomas Refis and Daniel Bunzli are working on, so just use the ocamldoc 
> version for now.
>
>> I'm not quite sure who will handle search across cmt files yet.  Is this on 
>> the roadmap or want-list for Merlin? (this question is mainly directed at 
>> Fred or Gemma, who have been looking at the Merlin feature roadmap recently).
>
> And looking at search more, I'm reasonably sure that this won't happen in the 
> short term for docs.mirage.io in odoc -- we should be looking at some Merlin 
> or Hoogle-like solution.
>
> Anil
>
>
> ___
> MirageOS-devel mailing list
> MirageOS-devel@lists.xenproject.org
> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel

___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-21 Thread Anil Madhavapeddy
On 19 Oct 2016, at 16:57, Anil Madhavapeddy  wrote:
> 
> On 19 Oct 2016, at 10:56, Martin Lucina  wrote:
>> 
>> On Friday, 14.10.2016 at 11:29, Anil Madhavapeddy wrote:
>>> Good news everyone! The experimental documentation repository at 
>>> http://docs.mirage.io now builds again, and has been refreshed to the 
>>> latest set of libraries assembled from the MirageOS3 dev remote at 
>>> https://github.com/mirage/mirage-dev
>> 
>> Some ideas for UX improvements to the docs pages:
>> 
>> 1) Hyperlinks on types. Eg. in functoria/Functoria_app.Cmd.html
>> "Rresult.result" should link to rresult/Rresult.html.
>> 
>> 2) A "Path" nagivation header with the full hierarchy. E.g.
>> rresult/Result.html currently has "Up", which takes me to the package's
>> index.page but I can't go "Up" from there.
>> 
>> 3) A "Search" box of some sort. Ideally just client-side, search over
>> packages/modules/types/descriptions?
> 
> Thanks Martin! I've updated the tracking issue at 
> https://github.com/mirage/mirage/issues/609 and filed a couple of upstream 
> issues on odig about this.

http://docs.mirage.io is now rebuilding again after the latest set of library 
merges and API changes.  There is some temporary breakage in the odoc CSS that 
Thomas Refis and Daniel Bunzli are working on, so just use the ocamldoc version 
for now.

> I'm not quite sure who will handle search across cmt files yet.  Is this on 
> the roadmap or want-list for Merlin? (this question is mainly directed at 
> Fred or Gemma, who have been looking at the Merlin feature roadmap recently).

And looking at search more, I'm reasonably sure that this won't happen in the 
short term for docs.mirage.io in odoc -- we should be looking at some Merlin or 
Hoogle-like solution.

Anil


___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-19 Thread Anil Madhavapeddy
On 19 Oct 2016, at 10:56, Martin Lucina  wrote:
> 
> On Friday, 14.10.2016 at 11:29, Anil Madhavapeddy wrote:
>> Good news everyone! The experimental documentation repository at 
>> http://docs.mirage.io now builds again, and has been refreshed to the latest 
>> set of libraries assembled from the MirageOS3 dev remote at 
>> https://github.com/mirage/mirage-dev
> 
> Some ideas for UX improvements to the docs pages:
> 
> 1) Hyperlinks on types. Eg. in functoria/Functoria_app.Cmd.html
> "Rresult.result" should link to rresult/Rresult.html.
> 
> 2) A "Path" nagivation header with the full hierarchy. E.g.
> rresult/Result.html currently has "Up", which takes me to the package's
> index.page but I can't go "Up" from there.
> 
> 3) A "Search" box of some sort. Ideally just client-side, search over
> packages/modules/types/descriptions?

Thanks Martin! I've updated the tracking issue at 
https://github.com/mirage/mirage/issues/609 and filed a couple of upstream 
issues on odig about this.

I'm not quite sure who will handle search across cmt files yet.  Is this on the 
roadmap or want-list for Merlin? (this question is mainly directed at Fred or 
Gemma, who have been looking at the Merlin feature roadmap recently).

Anil

___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-19 Thread Martin Lucina
On Friday, 14.10.2016 at 11:29, Anil Madhavapeddy wrote:
> Good news everyone! The experimental documentation repository at 
> http://docs.mirage.io now builds again, and has been refreshed to the latest 
> set of libraries assembled from the MirageOS3 dev remote at 
> https://github.com/mirage/mirage-dev

Some ideas for UX improvements to the docs pages:

1) Hyperlinks on types. Eg. in functoria/Functoria_app.Cmd.html
"Rresult.result" should link to rresult/Rresult.html.

2) A "Path" nagivation header with the full hierarchy. E.g.
rresult/Result.html currently has "Up", which takes me to the package's
index.page but I can't go "Up" from there.

3) A "Search" box of some sort. Ideally just client-side, search over
packages/modules/types/descriptions?

Martin

___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-14 Thread Anil Madhavapeddy
On 14 Oct 2016, at 13:13, Hannes Mehnert  wrote:
> 
> On 14/10/2016 11:29, Anil Madhavapeddy wrote:
>> Good news everyone! The experimental documentation repository at 
>> http://docs.mirage.io now builds again, and has been refreshed to the latest 
>> set of libraries assembled from the MirageOS3 dev remote at 
>> https://github.com/mirage/mirage-dev
> 
> Yay!  There is also the one with cross-references using odoc at
> http://docs.mirage.io/odoc/ !?

Yes this is even more experimental and being built based on the odoc engine 
being developed at Jane Street.  Bug reports of output from that should go on 
https://github.com/ocaml-doc/odoc with a reference to the offending library.

> Could you remind what triggers a rebuild (and where are the logs of the
> rebuild)?  Inserting a last generated timestamp into the toplevel HTML
> output would be useful.

Right now it's just built using the Docker Hub on every push to mirage/mirage, 
so the builds on the "doc" branch at 
https://hub.docker.com/r/unikernel/mirage/builds/ will have the latest logs.

I'm planning to move this to a Datakit-based watcher that will track the 
mirage/mirage-dev and opam-repository so that it will rebuild when any of the 
libraries changes.  I'll do that once the trees stabilise.

Anil
___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-14 Thread Anil Madhavapeddy
On 14 Oct 2016, at 11:59, Amir Chaudhry  wrote:
> 
> 
>> On 14 Oct 2016, at 11:29, Anil Madhavapeddy  wrote:
>> 
>> As this setup stabilises, I will merge the TROVE links currently held in 
>> mirage-www with this version (which uses OPAM package names rather than 
>> repositories, which is more useful I think).
> 
> This is definitely more useful.  We’ve previously discussed using Opam tags 
> to help filter the Mirage libraries and this might be a good time to revisit 
> that.

See this issue on Odig:
https://github.com/dbuenzli/odig/issues/7

We could also just write our own index page generator for Mirage outside of 
Odig of course.

> For example, would it make sense to use something like the output of 'opam 
> search org:mirage’ as input to the opam depext step?  There would still be 
> packages we’d have to add directly to the Dockerfile but this might make it 
> easier as more libraries are added to Opam.

Yeah I think this would be useful.  Not all the libraries are part of Mirage 
(e.g. Lwt), but they would get pulled in as dependencies and so wouldn't get 
tagged.  PRs welcome for this -- the Dockerfile.doc can be built locally quite 
easily with "docker build -f Dockerfile.odoc -t mirage-doc ." so you can 
experiment with different labelling schemes to remove the manual list.

Anil


___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-14 Thread Anil Madhavapeddy
On 14 Oct 2016, at 11:34, Mindy  wrote:
> 
> 
> On 10/14/2016 05:29 AM, Anil Madhavapeddy wrote:
>> Good news everyone! The experimental documentation repository at 
>> http://docs.mirage.io now builds again, and has been refreshed to the latest 
>> set of libraries assembled from the MirageOS3 dev remote at 
>> https://github.com/mirage/mirage-dev
> 
> This is extremely cool!  Thanks a ton for getting this up and running, Anil.  
> Also, thanks to Daniel Bünzli, the author of odig!
> 
> I notice that "version" is listed as "?" for many of the packages (including 
> http://docs.mirage.io/ipaddr/index.html , which should have a proper version 
> number of the form we usually see in the main opam repository).  What's the 
> best place to report issues like this?  Maybe the issue tracker for odig 
> itself?

Good question.  What needs to happen is for all the packages to respect the 
odig packaging conventions [1] of installing the "opam" file along with library 
files and CHANGES/README files.

This happens automatically if you port the package to use topkg [2], but it 
would also be helpful to have an Oasis rule so that we can rapidly port 
existing libraries to make their metadata available.

Some useful issues may be:
- [development mode for odig to find non-ported packages]: 
https://github.com/dbuenzli/odig/issues/8
- [how to customise the index page]: https://github.com/dbuenzli/odig/issues/7

Daniel's point in the page customisation issue #7 is a good one -- it is better 
to embed our general help in an OCaml module, since then it can be used in 
non-HTML output (and Merlin and other editor tools) much more easily than if we 
write HTML help directly.

[1] Currently buried in 
https://github.com/dbuenzli/odig/blob/master/src-bin/help.ml#L51 or `odig 
--help` if installed.
[2] http://erratique.ch/software/topkg/doc/index.html

regards,
Anil
___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-14 Thread Hannes Mehnert
On 14/10/2016 11:29, Anil Madhavapeddy wrote:
> Good news everyone! The experimental documentation repository at 
> http://docs.mirage.io now builds again, and has been refreshed to the latest 
> set of libraries assembled from the MirageOS3 dev remote at 
> https://github.com/mirage/mirage-dev

Yay!  There is also the one with cross-references using odoc at
http://docs.mirage.io/odoc/ !?

Could you remind what triggers a rebuild (and where are the logs of the
rebuild)?  Inserting a last generated timestamp into the toplevel HTML
output would be useful.


hannes

___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-14 Thread Amir Chaudhry

> On 14 Oct 2016, at 11:29, Anil Madhavapeddy  wrote:
> 
> As this setup stabilises, I will merge the TROVE links currently held in 
> mirage-www with this version (which uses OPAM package names rather than 
> repositories, which is more useful I think).

This is definitely more useful.  We’ve previously discussed using Opam tags to 
help filter the Mirage libraries and this might be a good time to revisit that.

For example, would it make sense to use something like the output of 'opam 
search org:mirage’ as input to the opam depext step?  There would still be 
packages we’d have to add directly to the Dockerfile but this might make it 
easier as more libraries are added to Opam.

Thoughts?

Amir

___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


Re: [MirageOS-devel] docs.mirage.io building again

2016-10-14 Thread Mindy


On 10/14/2016 05:29 AM, Anil Madhavapeddy wrote:

Good news everyone! The experimental documentation repository at 
http://docs.mirage.io now builds again, and has been refreshed to the latest 
set of libraries assembled from the MirageOS3 dev remote at 
https://github.com/mirage/mirage-dev


This is extremely cool!  Thanks a ton for getting this up and running, 
Anil.  Also, thanks to Daniel Bünzli, the author of odig!


I notice that "version" is listed as "?" for many of the packages 
(including http://docs.mirage.io/ipaddr/index.html , which should have a 
proper version number of the form we usually see in the main opam 
repository).  What's the best place to report issues like this?  Maybe 
the issue tracker for odig itself?


Thanks,

Mindy


___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel


[MirageOS-devel] docs.mirage.io building again

2016-10-14 Thread Anil Madhavapeddy
Good news everyone! The experimental documentation repository at 
http://docs.mirage.io now builds again, and has been refreshed to the latest 
set of libraries assembled from the MirageOS3 dev remote at 
https://github.com/mirage/mirage-dev

As a reminder, this has become the unofficial "trove" since it attempts to 
build all the libraries in one OPAM install instruction:
https://github.com/mirage/mirage/blob/master/Dockerfile.doc

and then uses odig to build the aggregate documentation set. This can also be 
done locally on your machine via the commands in the Dockerfile.

As this setup stabilises, I will merge the TROVE links currently held in 
mirage-www with this version (which uses OPAM package names rather than 
repositories, which is more useful I think).

Thanks to everyone who has been hard at work porting libraries to mirage-dev in 
the release effort so far, and in particular to Hannes Menhert, Mindy Preston, 
Martin Lucina, Dave Scott and Thomas Gazagnaire who have all been steadily 
submitting "master branch" ports to mirage-dev to keep it building and stable 
as we merge the API changes required for MirageOS3.

regards,
Anil
___
MirageOS-devel mailing list
MirageOS-devel@lists.xenproject.org
https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel