#1221 Wiki
Opened 3 years ago by williamjmorenor. Modified 3 years ago

Hello, pagure have a awesome service for documentation hosting, docs are good for users but for developers a wiki maybe usefull to coordinate work, save notes and soo, so I want to ask for a future support of a per project wiki in pagure.


hey @williamjmorenor thats a really good suggestion :smile: lets see what @pingou has to say but I like the feature to be there ! Something like Github gist

@farhaan I don't think what he meant is "something like Github gist". Wikis are one thing, pastebins are another.

By the way, I agree that pagure should remove the current docs system in favor of Wikis or any other kind of collaborative docs. Maybe just make another repository called "[project].docs.git" or something like that... The current docs system (website inside an iframe) is both unsafe and difficult to maintain for everybody that wants to deploy their own instance.

@qazwsxedc work is being done on that :smile: and there is an confkey option to turn doc hosting off :)

I do not think nor wish to see pagure develop a wiki-like system for the moment.

The doc system currently in place already allows collaboration, it's in a git repo, it can be placed in the sources of the project (cf the doc of pagure itself) or just as another project on pagure. Up to the maintainer to update the doc repo then when needed.

As for the iframe aspect, if you know a way to displaying user's provided data without compromising on security, I am all hears :)

(note the content of the iframe is also available outside of it: https://docs.pagure.org/pagure/ and there is a link to this on the top right above the iframe on the doc tab)

I do not think nor wish to see pagure develop a wiki-like system for the moment.
The doc system currently in place already allows collaboration, it's in a git repo, it can be placed in the sources of the project (cf the doc of pagure itself) or just as another project on pagure. Up to the maintainer to update the doc repo then when needed.

I really see the docs tool like a user oriented docs, but I think a wiki is a contributors oriented documentation, I see a post in Fedora Planet about the shutdown of Fedora Hosted in favor of Pagure, I think it is awesome, and most of the project is Fedora Hosted are Trac powered, and Trac have a wiki sytem already in place, so if Pagure is called to be of Fedora repo host a project wiki will be really apreciated.

The fact that trac has a wiki isn't a reason on its own for pagure to have one ;-)

I would agree, except for the fact that we're pushing pagure as the replacement for fedorahosted. Of course, I doubt that there are very many projects using the wiki facilities of trac in a way that can't be reasonably emulated by the docs repository.

Setting up a separate pagure repo to hold the documentation would at least give some features of a wiki, including some ability to edit online. (Also, pull requests.) The complexity is much higher than an actual wiki, though. I can actually see relatively simple ways to make the process more wiki-like, though, but have no time to implement them.

it maybe relevant that another feature request exists that is somewhat mutually exclusive with this one - in which the docs feature would be removed completely in favor of github-like gh-pages static hosting

https://pagure.io/pagure/issue/469

this is also being discussed on notabug

https://notabug.org/NotABug.org/notabug/issues/3

the pagure docs essentially is a wiki - the only thing that distinguishes a wiki from pagure docs is that a wiki has a web-based online editor and so it is editable by random users without peer review (which to me is an anti-feature) - so very little would need to be done to convert the existing pagure docs into a wiki - it would be quite similar to what is already implemented for the issues pages<->repos

I see your point, but pagure host hmtl formated docs, I will be no so easy to provide a online editor for html docs. I see a wiki as a group of markdown of reextructured files with a online editiing feature than than can be displayed in html from a link in the repo home, the text files should be in a git repo or just in a wiki/[project] directory in the pagure instalation system.

@williamjmorenor -

pagure docs are a git repo and can be markdown, rst, html, or text and they are converted to HTML on the fly - see here --> https://docs.pagure.org/pagure/usage/using_doc.html

Login to comment on this ticket.

Metadata