Autor Thema: Documentation/wiki  (Gelesen 473 mal)

Offline Van de Bugger

  • Nano
  • **
  • Beiträge: 32
Documentation/wiki
« am: 19. April 2011, 22:51:11 »
Hi all,

I believe the best way to write and maintain documentation (including "How to") is wiki. It is easy to edit, to share, to see changes and history. It is like source control (either svn, git or hg for sources).

I registered a project "opencaching" at SourceForge, and set up Wiki there. Feel free to add "How to" there. Here is the link:

https://sourceforge.net/apps/mediawiki/opencaching/index.php?title=Main_Page

If you have any troubles or need any help, let me know.





« Letzte Änderung: 22. April 2011, 12:59:36 von oliver »

oliver

  • Gast
Re: Documentation
« Antwort #1 am: 22. April 2011, 12:57:49 »
Hi,

we still have a google code account for issue tracker:
http://code.google.com/p/opencaching

There is a wiki integrated.
Should we use this wiki?

I think we should not spread our tools out over several websites.
( see http://forum.geocaching-network.com/index.php?topic=1359.0 )

Kind regards,
Oliver

oliver

  • Gast
Re: Documentation/wiki
« Antwort #2 am: 22. April 2011, 13:00:40 »
I splitted the topic from the "howto section" ...

Moving all to sourceforge would be the other option, but we have to work on the licensing issues you pointed out, before we can do that.

Offline Van de Bugger

  • Nano
  • **
  • Beiträge: 32
Re: Documentation
« Antwort #3 am: 23. April 2011, 00:24:14 »
Hi,

we still have a google code account for issue tracker:
http://code.google.com/p/opencaching

There is a wiki integrated.
Should we use this wiki?

I think we should not spread our tools out over several websites.
( see http://forum.geocaching-network.com/index.php?topic=1359.0 )

Kind regards,
Oliver

Oliver, that was exactly my idea. I am ready to follow project rules and decisions, but often I do not see them. For example, OlofL said:

> It doesn't matter to me if we use what we have today or something else as long as the tools work. Which also means that if you configure and setup something that works better than we have today I will start using that instead.

So, I started "opencaching" at SourceForge, because (1) I am familiar with MediaWiki to some extent (and planning to run MediaWiki at my site too), (2) SourceForge offers it, (3) SourceForge offers many other tools (including MySQL database and web server, so we could potentially run test Opencaching server there; but I did not checked it yet).

Again: I am ready to follow project decision. If you say I will delete "opencaching" @ SourceForge.

BTW, a question about GoogleCode's wiki: What about backup? It is not a question for source, because everybody has local git repository with all the information, but how to backup Wiki at GoogleCode?

(SourceForge's MediaWiki's MySQL base and files can be downloaded at any time. I did no tried to import them back, thought.)

Oh, I found answer to my question: http://code.google.com/p/support/wiki/WikiFAQ (See "Where is the wiki content stored?")

If either SVN or HG is used, all the wiki stuff is stored in chosen source control. That's good. But it is not well-known wiki engine, so, we we want to move from GoogleCode, it seems this stuff will be hardly used again. In contrast, it should be relatively easy to run MediaWiki at any web server and import saved stuff there. ?

I surfing the net for "GoogleCode vs SourceForge"... I found only 2 issues related to SourceForge:

1. It noticeable slower than GoogleCode.
2. There is an issue with licensing:

> You hereby grant Geeknet a worldwide, non-exclusive, irrevocable, perpetual, fully sublicensable, transferable (in accordance with Section 16), royalty-free right and license to use, reproduce, adapt, modify, translate, create derivative works from, publish, perform, display, rent, resell and distribute Associated Content (in whole or part) and incorporate Associated Content in other works, in any form, media, or technology developed by Geeknet, though Geeknet is not required to incorporate such Associated Content into any Geeknet products or services. Geeknet reserves the right to syndicate Associated Content submitted, posted or displayed by you on or through SourceForge.net and use that Associated Content in connection with any service offered by Geeknet.

> You hereby represent and warrant that you have all rights, licenses and consents necessary to grant Geeknet and other users the rights and licenses granted herein to the Associated Content without infringement of any third party rights.

There is an opinion that it is a separate agreement between author and Geeknet, and Geeknet is not bounded with GPL license. I am not sure whether it true or not... I starting to think that it would be better to run own server... We already have Forum. Git dooes not require centralized server at all, what we need is just one more server with MediaWiki...
« Letzte Änderung: 23. April 2011, 01:32:54 von Van de Bugger »

oliver

  • Gast
Re: Documentation
« Antwort #4 am: 23. April 2011, 12:03:52 »
Oliver, that was exactly my idea. I am ready to follow project rules and decisions, but often I do not see them. For example, OlofL said:

> It doesn't matter to me if we use what we have today or something else as long as the tools work. Which also means that if you configure and
setup something that works better than we have today I will start using that instead.

i fully agree with this statement of Olof.

Regarding sourceforge: In the past there has been a "Opencaching-server" project. I started to transfer sources file by file after checking that the content matches the GPL. I was not able to finish this process ... and finally requested sourceforge to delete the project (sourceforge did it 1 or 2 years later).

In my opinion we can use third party tools as soon as our different source licenses are cleaned up and all content is (A)GPL. But that nothing that can be done beside other development and takes some serious time. That's the reason why i said it slows down our development.

Zitat
There is an opinion that it is a separate agreement between author and Geeknet, and Geeknet is not bounded with GPL license. I am not sure whether it true or not... I starting to think that it would be better to run own server... We already have Forum. Git dooes not require centralized server at all, what we need is just one more server with MediaWiki...

If the others agree, we can use the domain "geocaching-network.org" for project hosting with all tools required. I am not sure about git-server, but hosting a mediawiki and/or php-based issue tracker is no problem.

Offline Van de Bugger

  • Nano
  • **
  • Beiträge: 32
Re: Documentation
« Antwort #5 am: 27. Mai 2011, 22:38:43 »
If the others agree, we can use the domain "geocaching-network.org" for project hosting with all tools required. I am not sure about git-server, but hosting a mediawiki and/or php-based issue tracker is no problem.

Is there any news? Will you set up wiki at geocaching-network.org?

My news are: (1) I am ready to remove Opencaching project at SourceForge. (2) I installed MediaWiki at my host, dev.opencaching.org.ru.

Please decide will we go with wiki at geocaching-network.org or dev.opencaching.org.ru. In any case, we need to finalize agreement on wiki content license.

Offline Van de Bugger

  • Nano
  • **
  • Beiträge: 32
Re: Documentation
« Antwort #6 am: 02. Juni 2011, 23:14:53 »
Please decide will we go with wiki at geocaching-network.org or dev.opencaching.org.ru. In any case, we need to finalize agreement on wiki content license.

Oliver?

oliver

  • Gast
Re: Documentation/wiki
« Antwort #7 am: 12. Juni 2011, 13:56:12 »
Hi Van de Bugger,

yes. Sorry. Your posting from end of Apil has been lost on my todo list.

Let us use your wiki installation for documentation.
We can move it later to the geocaching-network domain.

Do you have access to the current source code?
There is a documentation directory with a few files which can be moved to the wiki.


Kind regards,

Oliver

Offline Van de Bugger

  • Nano
  • **
  • Beiträge: 32
Re: Documentation/wiki
« Antwort #8 am: 18. Juni 2011, 16:25:44 »
Let us use your wiki installation for documentation.
We can move it later to the geocaching-network domain.

Ok, Wiki is ready. Feel free to register and login. Only users who confirmed registration may create and edit pages.

I can enable OpenID logins there. It looks very promissing. However, I failed to login with my Google account. But Yandex and LiveJournal accounts work good.

Do you have access to the current source code?
There is a documentation directory with a few files which can be moved to the wiki.

It seems so. Some time ago I was able to download sources from github.

Oops. 404. Did you delete the project at github?
« Letzte Änderung: 18. Juni 2011, 16:27:58 von Van de Bugger »

Offline OlofL

  • Nano
  • **
  • Beiträge: 70
  • OC SE Team
Re: Documentation/wiki
« Antwort #9 am: 28. Juni 2011, 21:10:09 »
Not deleted but we moved it around a bit. This is the address:
http://github.com/OpencachingTeam/opencaching
We have several admins there to handle users. I will try to act on merges and pull request but I've been a bit after reading mails and forum for a few weeks but catching up.