New issue
 Projects > website > Issues > Refactor #3849

Our new documents system is different from all other popular wiki systems

Refactor #3849 [Closed]
walzer@cocos2d-x.org 2014-01-25 13:23 . Updated over 2 years ago

We're using module/sub-module/article/en as the URL. The folder structures DO have very deep folder relationships. But in other wiki systems like redmine wiki, github wiki, they have all wiki pages in the root folder. In this way:

  • Different wiki pages can link to other pages easily
  • There will be no conflicts at the names of wiki pages
  • Title of wiki pages has a relationship with wiki pages' name. e.g., when users create a title How to Debug Lua, then the wiki page's file name will be how-to-debug-lua.

So comparing to other wiki systems, our current documents system has some pros and cons:

Pros

  • Better permission control via github repository. It's easier than redmine wiki and github wiki to review and merge docs contributions. Traditional wiki systems have no concept of review and merge.
  • Easy to analyse contributors, activities via github graph
  • Easy to use offline markdown editors

Cons

  • If we refactor the folder structure in the future, then all google search results to our docs system will be invalid
  • Impossible to link other wiki pages via a simple [[wiki page name]], because they're in different folders.

I don't know how to resolve this, just post the problems here.

walzer@cocos2d-x.org 2014-01-26 02:55
  • Description updated (diff)
walzer@cocos2d-x.org 2014-01-26 02:56
  • Description updated (diff)
lance_gray 2014-04-10 02:43

You guys might want to check out dokuWiki.

walzer@cocos2d-x.org 2014-05-05 07:00
  • Status changed from New to Closed

Turn back to redmine wiki system.

Atom PDF

Status:Closed
Start date:2014-01-25
Priority:Normal
Due date:
Assignee:eva
% Done:

0%

Category:-
Target version:-

Sign up for our newsletter to keep up with the latest developments, releases and updates for Cocos2d-x.