Move the wiki to user.js comments or README

[nodiscc]

From #218:

Maybe we could document these in the wiki?

:/ I think information is currently too much scattered between user.js comments, the wiki, the readme... In my experience it leads to duplicate/outdated/don't-know-where-to-look documentation. It can be made cleaner eg by:

• Moving all info from these wiki pages to the user.js file itself, alongside relevant prefs/sections
  • https://github.com/pyllyukko/user.js/wiki/Home
  • https://github.com/pyllyukko/user.js/wiki/Caching
  • https://github.com/pyllyukko/user.js/wiki/CIPHERS
  • https://github.com/pyllyukko/user.js/wiki/Extensions-&-Plugins
  • https://github.com/pyllyukko/user.js/wiki/Firefox-exploits-&-vulnerabilities
  • https://github.com/pyllyukko/user.js/wiki/Firefox-features-and-components
  • https://github.com/pyllyukko/user.js/wiki/HTML5---APIs---DOM
  • https://github.com/pyllyukko/user.js/wiki/HTTP
  • https://github.com/pyllyukko/user.js/wiki/Local-Dom-Storage
  • https://github.com/pyllyukko/user.js/wiki/Misc
  • https://github.com/pyllyukko/user.js/wiki/TLS---HTTPS----OCSP
  • https://github.com/pyllyukko/user.js/wiki/UI-related
  • https://github.com/pyllyukko/user.js/wiki/Firefox-autoconnections
  • There's at most a few links by section/page
  • Wiki tables appear to be broken
  • If the info does not fit in user.js it's probably not relevant, remove it.
• Move info from https://github.com/pyllyukko/user.js#what-does-it-do to section descriptions in user.js, and instead generate the "What does it do?" section do from section descriptions in user.js (ezpz sed/awk/Makefile magic)
• Move some tests from https://github.com/pyllyukko/user.js#online-tests to relevant prefs/sections in user.js
• Move https://github.com/pyllyukko/user.js/wiki/FAQ, to README.md
• Closing the wiki: Github Flavored Markdown is not very portable, there are authenticity issues with world-writable wikis, all in all it's harder to maintain than generating it from static comments/.md files. If you think this bloats the user.js file/README, just discard irrelevant information.

[nodiscc]

Move info from https://github.com/pyllyukko/user.js#what-does-it-do to section descriptions in user.js, and instead generate the "What does it do?" section do from section descriptions in user.js (ezpz sed/awk/Makefile magic)

I don't think that's a good idea. I think we should have it the similar way it's now, kinda summarizing different aspects of the hardening.

---

Move some tests from https://github.com/pyllyukko/user.js#online-tests to relevant prefs/sections in user.js

Moved or copied? I think the online tests section is good in the README as it is, but some of the tests could be also in the user.js.

[nodiscc]

• network.proxy.type (http://kb.mozillazine.org/Network.proxy.type) found in Misc page: no such entry in user.js
• All user.js prefs (or group of 2-3 prefs) should have a short, plain text description of what they do. (eg. CIS descriptions like Disable JAR from opening Unsafe File Types are quite good)
• browser.frames.enabled (https://bugzilla.mozilla.org/show_bug.cgi?id=729030) found in Misc page: no such entry in user.js

[pyllyukko]

network.proxy.type (http://kb.mozillazine.org/Network.proxy.type) found in Misc page: no such entry in user.js

Not needed.

browser.frames.enabled (https://bugzilla.mozilla.org/show_bug.cgi?id=729030) found in Misc page: no such entry in user.js

Not needed.

[nodiscc]

• browser.history_expire_days (http://kb.mozillazine.org/Browser.history_expire_days) found in Caching page: no such entry in user.js
• browser.history_expire_sites http://kb.mozillazine.org/Browser.history_expire_sites found in Caching page: no such entry in user.js
• browser.history_expire_visit http://kb.mozillazine.org/Browser.history_expire_visits found in Caching page: no such entry in user.js
• all links should be unshortened - moved to Unshorten all links #244

[nodiscc]

• security.enable_tls_session_ticket found in TLS/HTTPS/OCSP page: no such entry in user.js
• security.enable_ssl3 (https://support.mozilla.org/en-US/kb/enable-ssl-fix-cannot-connect-securely-error?redirectlocale=en-US&redirectslug=Firefox+cannot+connect+securely+because+the+SSL+protocol+is+disabled) found in TLS/HTTPS/OCSP page: no such entry in user.js
• security.warn_entering_weak (http://kb.mozillazine.org/About:config_entries#Security) found in UI Related page: no such entry in user.js
• security.ssl.warn_missing_rfc5746 (https://developer.mozilla.org/en/Preferences/Mozilla_preferences_for_uber-geeks) not found in user.js, no longer documented on the page

[nodiscc]

First part completed (main issue checklist + FAQ migration), along with some doc improvements.
@pyllyukko I will open a Pull Request and wait for review before continuing.
Feel free to delete the wiki (I deleted all pages, more info at https://github.com/pyllyukko/user.js/wiki).
There's also the few inconsistencies reported above, if you'd like to have a look.

Thanks

[pyllyukko]

Thanks! I disabled the wiki and start reviewing the PR.

[nodiscc]

Once current PRs are reviewed we can resume working on this (see unchecked checkbox items)

[pyllyukko]

security.enable_tls_session_ticket found in TLS/HTTPS/OCSP page: no such entry in user.js

Sound like security.ssl.disable_session_identifiers.

security.enable_ssl3 (https://support.mozilla.org/en-US/kb/enable-ssl-fix-cannot-connect-securely-error?redirectlocale=en-US&redirectslug=Firefox+cannot+connect+securely+because+the+SSL+protocol+is+disabled) found in TLS/HTTPS/OCSP page: no such entry in user.js

This should be covered by security.tls.version.min.

security.warn_entering_weak (http://kb.mozillazine.org/About:config_entries#Security) found in UI Related page: no such entry in user.js

Sounds like this is deprecated: Re: What happened to security.warn settings in about:config. They are missing in FF25. Please help!!.

security.ssl.warn_missing_rfc5746 (https://developer.mozilla.org/en/Preferences/Mozilla_preferences_for_uber-geeks) not found in user.js, no longer documented on the page

Sounds exactly like security.ssl.treat_unsafe_negotiation_as_broken.

Marking these as done.

[pyllyukko]

Once current PRs are reviewed we can resume working on this (see unchecked checkbox items)

BTW. the checkbox counter in the issues list doesn't seem to count the ones in comments, but only the ones in the first comment/description. It currently shows 17/17, even though there are still open ones in the comments.

[nodiscc]

browser.history_expire* prefs are no longer present in recent Firefox releases. Everything fixed, closing.