iverilog-devel

[Iverilog-devel] Icarus Verilog documentation vs. Wikia

[Stephen W. <st...@ic...>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


The Icarus Verilog documentation is on the Wikia.com web site. I went
there today without being logged in, and I was amazed: tons of ads,
every one of them a video!

No.

Bad impression.

So I'm considering moving the documentation to a less yucky place.
My first thought is to move it to the iverilog.icarus.com site,
which is a "Google Sites" site. At least there if there are ads,
the revenue would go to me;-) I'm familiar with it, and know it would
be safe there. The down side, granting permissions for editing
would be a more explicit thing, instead of the current default
of granting permissions.

Another option is to use the github wiki feature. I am almost
completely unfamiliar with its abilities, but I'm otherwise
pleased with github, so I'd consider it in the running. Do others
have experience with the github Wiki? Thoughts?

Any other thoughts we should consider?

- -- 
Steve Williams                "The woods are lovely, dark and deep.
steve at icarus.com           But I have promises to keep,
http://www.icarus.com         and lines to code before I sleep,
http://www.picturel.com       And lines to code before I sleep."
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iEYEARECAAYFAlSUnDsACgkQrPt1Sc2b3ik6owCfYnjKMIOpTeZiIf0y3n5BeMEE
KYQAn0XLNhmnijiNOS1OjKJLHnASG00C
=Px3R
-----END PGP SIGNATURE-----

Re: [Iverilog-devel] Icarus Verilog documentation vs. Wikia

[Pete J. <pe...@be...>]

Steve,

I have a server at a hosting site (got.net <http://got.net/>) running VmWare ESXi. If you want I could configure a virtual machine for you and you could run anything you want as long as there is not a lot of traffic. I have run it for about five years and it is pretty stable.

Let me know if that is of interest.

Thanks,

-Pete


> On Dec 19, 2014, at 1:44 PM, Stephen Williams <st...@ic...> wrote:
> 
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> 
> The Icarus Verilog documentation is on the Wikia.com web site. I went
> there today without being logged in, and I was amazed: tons of ads,
> every one of them a video!
> 
> No.
> 
> Bad impression.
> 
> So I'm considering moving the documentation to a less yucky place.
> My first thought is to move it to the iverilog.icarus.com site,
> which is a "Google Sites" site. At least there if there are ads,
> the revenue would go to me;-) I'm familiar with it, and know it would
> be safe there. The down side, granting permissions for editing
> would be a more explicit thing, instead of the current default
> of granting permissions.
> 
> Another option is to use the github wiki feature. I am almost
> completely unfamiliar with its abilities, but I'm otherwise
> pleased with github, so I'd consider it in the running. Do others
> have experience with the github Wiki? Thoughts?
> 
> Any other thoughts we should consider?
> 
> - -- 
> Steve Williams                "The woods are lovely, dark and deep.
> steve at icarus.com           But I have promises to keep,
> http://www.icarus.com         and lines to code before I sleep,
> http://www.picturel.com       And lines to code before I sleep."
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v2
> 
> iEYEARECAAYFAlSUnDsACgkQrPt1Sc2b3ik6owCfYnjKMIOpTeZiIf0y3n5BeMEE
> KYQAn0XLNhmnijiNOS1OjKJLHnASG00C
> =Px3R
> -----END PGP SIGNATURE-----
> 
> ------------------------------------------------------------------------------
> Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
> from Actuate! Instantly Supercharge Your Business Reports and Dashboards
> with Interactivity, Sharing, Native Excel Exports, App Integration & more
> Get technology previously reserved for billion-dollar corporations, FREE
> http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
> _______________________________________________
> Iverilog-devel mailing list
> Ive...@li...
> https://lists.sourceforge.net/lists/listinfo/iverilog-devel

Re: [Iverilog-devel] Icarus Verilog documentation vs. Wikia

[Guilherme B. T. <gui...@gm...>]

Hello Stephen,

Just a few ideas...
Have you considered using a documentation generator instead?

I started using the GitHub Wiki for Qucs [1]. I works fine to draft and 
aggregate general information. What I miss is a notification system 
about changes. It is a Git repo, but I don't want to pull each time to 
see what was changed.

I am now considering Sphinx (Python based) as a documentation generator 
to create static HTML pages (also PDF) for our online-help manuals 
(preview in [2]). Marcos from KiCad is currently evaluating other 
generators [3].

Your Wiki content can easily converted to reStructuredText (pandoc). You 
can pick or personalize a Sphinx template. The generated HTML looks 
great and you can put them anywhere you like (Google Pages, GitHub pages).
A really nice host is Read The Docs, which can fetch the changes 
directly from your repo and publish the HTML pages.
If you set it up with GitHub (not sure with Bitbucket) it even allows 
one to edit/preview the sources on the browser (almost like a Wiki).

Regards, Guilherme

[1] https://github.com/Qucs/qucs/wiki
[2] http://guitorri.github.io/qucs-help.github.io/html-en/index.html
[3] https://github.com/ciampix/kicad-doc/blob/master/doc/kicad-doc-doc.adoc



On 12/19/14, 10:44 PM, Stephen Williams wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
>
> The Icarus Verilog documentation is on the Wikia.com web site. I went
> there today without being logged in, and I was amazed: tons of ads,
> every one of them a video!
>
> No.
>
> Bad impression.
>
> So I'm considering moving the documentation to a less yucky place.
> My first thought is to move it to the iverilog.icarus.com site,
> which is a "Google Sites" site. At least there if there are ads,
> the revenue would go to me;-) I'm familiar with it, and know it would
> be safe there. The down side, granting permissions for editing
> would be a more explicit thing, instead of the current default
> of granting permissions.
>
> Another option is to use the github wiki feature. I am almost
> completely unfamiliar with its abilities, but I'm otherwise
> pleased with github, so I'd consider it in the running. Do others
> have experience with the github Wiki? Thoughts?
>
> Any other thoughts we should consider?
>
> - -- 
> Steve Williams                "The woods are lovely, dark and deep.
> steve at icarus.com           But I have promises to keep,
> http://www.icarus.com         and lines to code before I sleep,
> http://www.picturel.com       And lines to code before I sleep."
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v2
>
> iEYEARECAAYFAlSUnDsACgkQrPt1Sc2b3ik6owCfYnjKMIOpTeZiIf0y3n5BeMEE
> KYQAn0XLNhmnijiNOS1OjKJLHnASG00C
> =Px3R
> -----END PGP SIGNATURE-----
>
>