search

kororaproject / website

All things website for the Korora Project
https://kororaproject.org
GNU Affero General Public License v3.0
7 stars 9 forks source link

Provide User Accessible Documentation Entry #55

Open jimkp opened 8 years ago

jimkp commented 8 years ago

We have been asked on a number of occasions how our users can contribute to the Documentation section, e.g. https://kororaproject.org/support/engage/question/adding-documentation-1

I suggest we add a facility for users to create and edit documentation without the ability to publish. They would have the same entry screen as Documentation admin but no publish button. An Admin would then review and publish the entry. (I'm happy to take responsibility to do this but may need assistance with more technical entries).

This would require a notification system so Admins were aware when a new item was ready for review. Also possibility a way to provide feedback and to notify the user when the item had been published.

A further enhancement would be the ability to edit existing documents without overwriting, i.e. version control. This would allow users to improve existing documents and for them not to be overwritten before they were reviewed. (Actually this would be useful now.)

jimkp commented 7 years ago

there have been further suggestions to enable a github submission option as per the Nextcloud setup, https://github.com/nextcloud/documentation

dyoungwd commented 7 years ago

use the wiki feature for the docs with its on repo - will probably need to redo the markup but thats no problem. Happy to do the change over

jimkp commented 7 years ago

How would we link that back to the site?

dyoungwd commented 7 years ago

will get back to you on that one...

AdmiralAsshat commented 7 years ago

How would we link that back to the site?

The wiki has its own git repo URL. Perhaps run a cronjob (or some other trigger) on the webserver to periodicaly git clone the wiki repo into the website directory?

jimkp commented 7 years ago

ok let's do it

jimkp commented 7 years ago

added a footer, copied from the website.

not sure on difference between sidebar and page list that is there. Maybe the sidebar can show page hierarchy.

jimkp commented 7 years ago

suggestion from irc, - , if you really want to be able to use PRs for documentation you can use a normal github repo to do the PRs on and the repo owners (those with push permissions) can manually sync to the wiki repo when new documentation is added/accepted

jimkp commented 7 years ago

Added a notes document to provide a place to discuss the development of the wiki. https://github.com/kororaproject/website/wiki/Development-Notes

dyoungwd commented 7 years ago

PR's prob aren't neccassary. Before I edit the master- wiki I edit my fork first but I can just ctl-c / ctl-v instead

jimkp commented 7 years ago

PR's prob aren't neccassary. Before I edit the master- wiki I edit my fork first but I can just ctl-c / ctl-v instead

They have been requested on a few occasions and came up in the discussion earlier today.