Ticket #9155 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Update DGS workflow algorithm wiki docs

Reported by: Michael Reuter Owned by: Michael Reuter
Priority: major Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #9165 Tester: Karl Palmen

Description

As part of generating the workflow algorithm flow charts, I've already found that the wiki docs can be updated on some of the functions. Do that.

Change History

comment:1 Changed 7 years ago by Michael Reuter

  • Status changed from new to assigned

comment:2 Changed 7 years ago by Michael Reuter

  • Status changed from assigned to inprogress

comment:3 Changed 7 years ago by Michael Reuter

Refs #9155. Updating DgsPreProcessData wiki docs.

Changeset: ed155fe10dbb7fa84144a527f46a031e368faad0

comment:4 Changed 7 years ago by Michael Reuter

Refs #9155. Updating DgsProcessDetectorVanadium wiki docs.

Changeset: 2dddfd2c96635f121bdd23f34b18f1eb48cfbfdc

comment:5 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:6 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:7 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:8 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:9 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:10 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:11 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:12 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:13 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:14 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:15 Changed 7 years ago by Owen Arnold

Last edited 7 years ago by Owen Arnold (previous) (diff)

comment:16 Changed 7 years ago by Owen Arnold

Michael, apologies for the above comments, which I have removed. I referenced the wrong ticket.

comment:17 Changed 7 years ago by Michael Reuter

Refs #9155. Updating DgsDiagnose wiki docs.

Changeset: bebea50be0c2f0e18df7edbf19477cb92a52d5a5

comment:18 Changed 7 years ago by Michael Reuter

  • Blocking 9165 added

comment:19 Changed 7 years ago by Michael Reuter

Refs #9155. Updating DgsAbsoluteUnitsReduction wiki docs.

Changeset: aede8af14f9dc5141cacb578f7e45644def55dcd

comment:20 Changed 7 years ago by Michael Reuter

Refs #9155. Updating DgsConvertToEnergyTransfer wiki docs.

Changeset: f67e909c9704920042c9058c40b74f985bc53391

comment:21 Changed 7 years ago by Michael Reuter

Refs #9155. Harmonizing the wiki docs.

Changeset: 294824e5c26c339c624afdf5eaf3b2ede8951725

comment:22 Changed 7 years ago by Michael Reuter

  • Status changed from inprogress to verify
  • Resolution set to fixed

The branch can be found ​here.

To test: Well, it'd be nice to see these on the wiki, but until they get into master any changes get clobbered by the automated job. You can push each algorithm into the wiki manually knowing the changes get blown away until the merge happens.

comment:23 Changed 7 years ago by Michael Reuter

  • Blocking 9127 removed

comment:23 Changed 7 years ago by Michael Reuter

  • Blocking 9127 added

If you test this, then grab #9127 too.

comment:24 Changed 7 years ago by Michael Reuter

  • Blocking 9127 removed

(In #9127) If you test this, grab #9155 too.

comment:25 Changed 7 years ago by Andrei Savici

  • Status changed from verify to verifying
  • Tester set to Andrei Savici

comment:27 Changed 7 years ago by Michael Reuter

Refs #9155. Clarifying a chart element.

Changeset: 18d176cc0a9c03be9de62d873a0bff63125a02bd

comment:28 Changed 7 years ago by Andrei Savici

  • Status changed from verifying to reopened
  • Resolution fixed deleted

Make sure the offline help looks right (no wikitable)

comment:29 Changed 7 years ago by Michael Reuter

  • Status changed from reopened to verify
  • Resolution set to fixed

The last request is outside the scope of this ticket as there are other algorithms that have similar issues. A global solution needs to be found.

comment:30 Changed 7 years ago by Karl Palmen

  • Status changed from verify to verifying
  • Tester changed from Andrei Savici to Karl Palmen

comment:31 Changed 7 years ago by Karl Palmen

I've run wikimaker for all the algorithms shown to be modified in the code review and found they produced good quality flowcharts. I also found the same flowcharts in the xml files stored in the code.

I see you have made use of new feautures. I would like an explanation of these added to ticket #9180 so a lengend can be constructed for them.

comment:32 Changed 7 years ago by Karl Palmen

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9155_dgs_workflowalg_wikidocs'

Full changeset: ​57962028c280a604265d576fef46374cc263c36a

comment:33 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​9998

Note: See TracTickets for help on using tickets.