Ticket #587 (closed task: fixed)

Opened 3 years ago

Last modified 2 years ago

Launch new documentation server

Reported by: DarTar Owned by: YanB
Priority: normal Milestone: 1.1.6.4
Component: documentation Version: 1.1.6.3
Severity: normal Keywords: docs
Cc: NilsLindenberg, BrianKoontz

Description (last modified by DarTar) (diff)

Coordination ticket for the launch of the new documentation server:  http://docs.wikkawiki.org

  • upgrade to the latest Wikka version #588
  • complete documentation for new features of the forthcoming release #589
  • add pointers from old documentation pages #590
  • update documentation links in the source code #632
  • announce the new docs server on the blog and the lists

Change History

Changed 3 years ago by DarTar

  • description modified (diff)

Changed 3 years ago by DarTar

  • description modified (diff)

Changed 3 years ago by DarTar

  • cc BrianKoontz added

Changed 3 years ago by YanB

  • status changed from new to assigned

Changed 3 years ago by DarTar

  • description modified (diff)

Changed 3 years ago by BrianKoontz

There is some strangeness going on here. I was unable to get the {{files}} action to work...further investigation reveals what looks like two different versions of each action under the action/ dir. Nothing appears to be under SVN control (there appear to be no .svn dirs). The version of files.php in the docs instance is much older (revision 369) than what is supposed to be in the trunk version (revision 736).

Can someone explain to me how the docs instance was built? It's difficult for me to work on this issue without knowing the method by which the docs instance was installed. Is there a reason why we aren't using an SVN checkout of trunk?

Changed 3 years ago by YanB

Beats me... Dario?

Changed 3 years ago by NilsLindenberg

We aren't using trunk because the docs server should run on the latest released version, imho, so it behaves the way people expect. And of course trunk can be unstable.

Changed 3 years ago by BrianKoontz

Nils, the footer says otherwise:

Powered by Wikka Wakka Wiki trunk [arrow tail]

Also, the external link notation that's in evidence (an arrow rather than the infinity symbol) is a feature first introduced in the trunk.

Changed 3 years ago by DarTar

Hello people:

  • yes docs does run on trunk, this is necessary to be able to document the new 1.1.7 features (e.g. table markup). We decided to do this and to upgrade manually to make sure the engine is sufficiently stable.
  • as per my previous mail, the trunk version running docs is stored for convenience on this page after each manual upgrade:  http://docs.wikkawiki.org/AdminWikkaVersion

Changed 3 years ago by DarTar

if the latest nightly build is sufficiently stable to run the docs server, we should manually upgrade and change the version in the above page. I'm afraid we won't be able to downgrade this to 1.1.6.4 once this is out. As previously discussed, the best solution IMO would be to maintain a separate docs branch. Other forthcoming subdomains (main / community) are less demanding and could easily run on the latest stable.

Changed 3 years ago by BrianKoontz

Definitely a quandary. The problem is that we're sort of in a no-man's land: Not 1.1.6.4, but not quite the latest 1.1.7, which makes it difficult to maintain. I believe a separate docs branch might be the safest and most robust solution too. Anyone object to me creating a new docs branch at HEAD and installing that for the docs server?

Changed 3 years ago by DarTar

Fine with me.

Changed 3 years ago by BrianKoontz

OK, the docs server has been updated to the latest on the 1.1.7 trunk, and a new branch has been created (1.1.7-docs). It probably needs a bit of vetting to make sure I haven't missed anything (for instance, I needed to pull over DarTar's "since" and "until" actions). See #651 for details.

Changed 3 years ago by BrianKoontz

The {{countowned}} action on the SysInfoActionInfo page appears to be broken; I've disabled it for now.

Changed 3 years ago by BrianKoontz

(In [918]) Added quotes around WHERE clause args. Refs #587, #655

Changed 2 years ago by DarTar

  • status changed from assigned to closed
  • resolution set to fixed

closing this ticket as substantially done - open subtickets can be dealt with separately.

Note: See TracTickets for help on using tickets.