[SOLVED] Open up the wiki to the community

[theq86]

Hey!

It would be really nice, if the wiki was open for all people to contribute. Knowledge worked out in the forums could be added there, new articles and tutorials could be made and of course, if the core articles which are available now would be accessible, the community could also improve the docs more easily.

Closed wikis may give the project owners better controlling mechanisms but they are usually a bottleneck. Also, they may "force" people to post their knowledge somewhere else, spread across the whole internet.

[Ciprian]

+1

It has to have a controlling mechanism, like, say, a review/ approve before being published. But, anyway, I know most coders don't like docs... So I agree with the idea of a community updated wiki/ docs.

[paulchen]

I am migrating from pfsense to opnsense in the moment and visiting the doc often, but there is still missing very much to explain the several options in the WebGUI to the user.

I would like to contribute some help adding documentation into the WebGUI (some ? symbols are empty, others could be added with more text) and into the doc section of the opnsense webpage/wiki.

But how can I contribute my help?

And I could help translating into german: I have realized some wrong and some missing translations in the web gui. How can I contribute? The translation system is a closed system in the moment...

[fabian]

Docs: https://github.com/opnsense/docs
Translation: You need an account that has to be requested via project @ mail address.

[franco]

Marking this solved.... stoked about this.


Cheers,
Franco

[firewall]

This shouldn't be marked as solved, as github is hardly as straightforward as a Wiki.  If you wonder why the repository is strewn with last commits in the realm of "months" and "years" it's because you're limiting contributions to the 10% of users who are willing to even try to figure it out. 

Disclaimer: I'm now on the tail-end of attempt # 3 or 4 to get either nginx or haproxy setup in reverse mode and yet again I've come up short.  Frustrating.   

I feel the user base would expand greatly with either UX improvements or documentation overhaul...and since more people can write than can code I'd love to see a true Wiki setup. 

Sorry to necro the thread but the topic is still germane.

[mimugmail]

Are you aware that "true" Wiki markup language is quite similar to rst-language in github? Have you used Mediawiki before? It's really no fun at all.

Just copy an existing page and put your own content, that's it

[franco]

As a general rule I don't bite when discussing which is the right and which is the wrong tool chain. We delivered an open sourced documentation and funnily enough other projects followed suit. We're absolutely happy with our current state.


Cheers,
Franco

[firewall]

We're absolutely happy with our current state.

Your project = your decision.  That said I'll make one last point.   

You've used GitHub for maintaining documentation for a year and a half, yet over that time it's not been greatly improved and you still have users griping about lack of info.  Rather strong supporting argument to reconsider, but again, these are facts for your consideration alone.

[franco]

> You've used GitHub for maintaining documentation for a year and a half, yet over that time it's not been greatly improved and you still have users griping about lack of info.

Nothing like reviving a good old thread.

Since sharing your opinion 46 commits went into the docs.git.

What do you consider "greatly improved"?

How will you help especially since you have rather significant reservations?

Or have you been helping since? In that case thanks a lot!


Cheers,
Franco