Our wiki on wiki.mozilla.org

[David Rajchenbach-Teller]

I'm currently putting documentation on our Wiki, to complete the
documentation started by Michiel (thanks a lot, Michiel, btw).

Now that I have had time to test it, the bottom line, at the moment, is
that I'm not very happy about the tool for technical documentation.

1/ Formatting options for code are simply not very good.
2/ I'm not really happy about the search options either.

I would suggest we move technical documentation to a Github wiki.

This would have the following benefits:
- markdown support;
- syntax highlighting;
- same format as our documents in the source code, for easier
copy/pasting both ways (including from/to tests);
- better search.

For the moment, only the REST API would move.

Is anybody against that?

Cheers,
David

[Julien Wajsberg]

To me, the wiki in wiki.mozilla.org is an index: it should collect links
to other references, but it's not necessarily containing all information.
So good for me.
My only issue with Github wiki is the permanency of the data.

> _______________________________________________
> dev-project-link mailing list
> dev-proj...@lists.mozilla.org
> https://lists.mozilla.org/listinfo/dev-project-link

[Michael Henretty]

On Sun, Apr 3, 2016 at 9:52 AM, Julien Wajsberg <jwaj...@mozilla.com> wrote:

My only issue with Github wiki is the permanency of the data.

What do you mean?

[Julien Wajsberg]

If github shuts down, where is our data ?

This is not like a git repository that we can host somewhere else very easily. (or it is ?)

[David Rajchenbach-Teller]

Actually, it is:
https://help.github.com/articles/adding-and-editing-wiki-pages-locally/

[Julien Wajsberg]

ok then :)