Recommendation for a Python-based wiki

[Sean Tan]

Hi. I want to write a user guide for a client. I thought it is better to host it online, so I don't have to periodically email an updated version to my client. I wonder why Wiki engines do you Pyramid folks use? Any suggestions?

[Steve Piercy]

Wikis are crapware. They're a headache to maintain.

The Pylons Project contributors use GitHub repos and Read the
Docs to produce user guides and other documentation.

--steve


On 9/1/17 at 8:01 PM, cct....@gmail.com (Sean Tan) pronounced:

------------------------
Steve Piercy, Soquel, CA

[Mike Orr]

Right, it's easy to write a simple wiki but a lot of work to write a
good one and maintain it, and no great markup language has emerged
yet. If you are the only editor, then you don't need wikis' multiple
authoring or simple markup language -- so the main question is how
*you* want to edit.

I'd suggest Sphinx for a users' guide. You write it in ReStructured
Text, convert it to static HTML, and host it on any webserver. It
supports previous/next links and a table of contents. Similar products
include Pelican and others.

> --
> You received this message because you are subscribed to the Google Groups
> "pylons-discuss" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to pylons-discus...@googlegroups.com.
> To post to this group, send email to pylons-...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/pylons-discuss/r473Ps-10126i-561A0A6A1F7845678C43C4D5A6F32211%40Steves-iMac.local.
>
> For more options, visit https://groups.google.com/d/optout.



--
Mike Orr <slugg...@gmail.com>

[Sean Tan]

Okay, thanks for the suggestion.

I am not sure if Github or Read the Docs are good for private project and documentations. I have hosted a gollum wiki (Github is using this too to power their wiki), but it is written in Ruby. I am just wondering if there is a Pyramid-based wiki which is comparable in terms of features. Github markdown is good enough for my purposes.

Agreed, for a single editor, a static website generator is a good solution. I have used Python-based get-nikola for several personal projects. 

But for multi-editor involving non-technical users, a wiki could be beneficial.

[Jonathan Vanasco]

A lot of the hosted commercial services are freemium.  i think pbwiki gives you a handful of users on their free tier -- all you really need are 2 users (one set of credentials for you, another one for your clients)

[Mikko Ohtamaa]

Hi. I want to write a user guide for a client. I thought it is better to host it online, so I don't have to periodically email an updated version to my client. I wonder why Wiki engines do you Pyramid folks use? Any suggestions?

Without knowing the details of the complexity of the guide, I'd say Google Docs is sufficient for such purposes. No need to get Wiki to complicate things.

-Mikko

--

Mikko Ohtamaa
http://opensourcehacker.com
http://twitter.com/moo9000

[Mikko Ohtamaa]

Hi all,

Here is a "modern" option. Netlify CMS provides an online editor that mimics static site generator workflow.

* You can edit pages and posts on their website

* Changes are pushed to Github document repo

* Netlify will automatically rebuild a static web site and host it

Netlify is free for hosting and in many ways easier and more powerful than e.g. readthedocs or Github. However, their online editor + Github integration is still very young.

Br,

Mikko

On Sun, 19 Apr 2020 at 21:07, Sydo Luciani <sydo.l...@gmail.com> wrote:

What do you think of :

https://github.com/SystematicD/pyramid_wiki

Flat file based documentation powered by Pyramid traversal and Deform.

 

On Saturday, 2 September 2017 00:52:13 UTC-5, Steve Piercy wrote:

Wikis are crapware.  They're a headache to maintain.

The Pylons Project contributors use GitHub repos and Read the
Docs to produce user guides and other documentation.

--steve

On 9/1/17 at 8:01 PM, cct...@gmail.com (Sean Tan) pronounced:

>Hi. I want to write a user guide for a client. I thought it is
>better to host it online, so I don't have to periodically email
>an updated version to my client. I wonder why Wiki engines do
>you Pyramid folks use? Any suggestions?
>

------------------------
Steve Piercy, Soquel, CA

--
You received this message because you are subscribed to the Google Groups "pylons-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pylons-discus...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/pylons-discuss/25fadd39-8e3c-4ff9-bd8c-defc26606d97%40googlegroups.com.

[Mikko Ohtamaa]

Hi,

Another point to make, Gitbook is good for user guides (no cross references, no source code snippets, etc.) Gitbook also offers hosting and very friendly editor. Many OSS projects are using it.

Br,

Mikko