wiki:WikiTodo

Version 38 (modified by Nicolas, 16 years ago) (diff)

Comment

Wiki To-do list

Please describe error and omissions in the BOINC documentation here.

Missing information (or requests for documentation)

  • Where is the format of global_prefs.xml? I want to link it from ClientSim#input_sim_prefs. I see many pages with related info, I don't know which one is right or correct: PrefsImpl, GlobalPrefs? (doesn't show XML format), PrefsOverride, and bottom of ClientFiles.
    • These pages are updated. Please will someone double-check before removing this and PrefsOverride below?
  • It may be useful to have a new page (MigratingServers?) explaining how to migrate a BOINC project to a new server.
  • The information in the Crashes section on ReportBugs is extremely Windows-centric. It would be great to have it expanded for other operating systems.
  • The build instructions for UNIX kind of lack a pointer to all the help that Linux distributions give in this respect. These come with complete build environments and, i.e., Debian provides packages for BOINC's clients and developers experiment for such for servers http://wiki.debian.org/BOINC/Server.
    • I strongly disagree about making a boinc-server package. If setting up a server involves just typing apt-get install boinc-server, [more] people who don't really know what they're doing will do it.

Out of date information

  • PrefsOverride is out of date
    • This has been "fixed", but per-day time preferences (and maybe others) are still missing.
  • Implementation notes are most very outdated.
  • DebugClientWin is mostly obsoleted by the built-in debug dump.
  • SecurityIssues should be checked when 6.0 is out and about. Certainly the part on sandboxing.

Minor corrections

  • ManagerAdvanced? could have some new screenshots. Current ones show glitches on the rendering of menus. Also it's probably better to keep the screenshots as attachments to that page, instead of stored somewhere else on BOINC server, that way contributors can change them.
  • JobIn needs similar work to BackendState: reformatting using headings instead of that table mess. I reformatted JobIn using definition lists. I think it looks better than with headings, but we can't link to individual attributes...

Misc

  • PythonMysql had been converted from the original .txt. I recently "wikified" the page, since it was just plaintext copied verbatim. It probably needs some cleanup, and checking if the information on it is still correct.
    • Answer: With recent distributions you won't need this page anymore. I always used the stable packages (usually: python-mysqldb) provided by each distro and got no problems. ChristianB
    • Other pages need to be updated to say Python DB can just be installed that way.
  • Would it make sense to move DevProjects stuff into Trac tickets marked as 'Task'?
    • Seconded.
    • Why not use the BOINCDev forums for that? We're already moving DevProjects stuff into Trac where necessary, but the forums are already there and at times used for such things. It would be great if the developers used them more.

Pages Tagged for Attention

You can tag pages for further action with the following tags: wiki_todo, wiki_cleanup, wiki_delete and image_todo.

Pages needing attention (wiki_todo)

ListTagged(wiki_todo, showheadings=false, tagspace=wiki)?

Pages needing wiki cleanup (wiki_cleanup)

ListTagged(wiki_cleanup, showheadings=false, tagspace=wiki)?

Pages pending deletion (wiki_delete)

ListTagged(wiki_delete, showheadings=false, tagspace=wiki)?

Images needing attention (image_todo)

ListTagged(image_todo, showheadings=false, tagspace=wiki)?

Not the Wiki

  • minor correction project list about date of LHC first turn-up - according to this press release the machine will not "see" first-light until May of next year.
  • favicon uses an old logo version that lacks transparency.
  • The "add it to the wiki to-do list" should be an absolute URL. The link is broken on some pages.