Ticket #9035 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Improve documentation of Remote Algorithms

Reported by: Karl Palmen Owned by: Ross Miller
Priority: major Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #8917 Tester: Karl Palmen

Description

The documentation of the RemoteAlgorithms is inadaquate. Add wiki desciptions, summaries etc as needed.

You may see file attached to #8917 for more details.

Change History

comment:1 Changed 7 years ago by Nick Draper

  • Keywords maintenance removed
  • Status changed from new to assigned
  • Owner set to Ross Miller
  • Milestone changed from Backlog to Release 3.2

comment:2 Changed 7 years ago by Nick Draper

remove SSC keyword for child blocking tickets

comment:3 Changed 7 years ago by Nick Draper

  • Keywords SSC removed

comment:4 Changed 6 years ago by Ross Miller

  • Status changed from assigned to inprogress

comment:5 Changed 6 years ago by Ross Miller

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

Looks like all the existing algorithms docs survived the change to .rst files. No further work needed. Marking this ticket as complete.

comment:6 Changed 6 years ago by Karl Palmen

  • Status changed from verify to verifying
  • Tester set to Karl Palmen

comment:7 Changed 6 years ago by Karl Palmen

Branch containing work not found. I'll check master.

comment:8 Changed 6 years ago by Karl Palmen

  • Status changed from verifying to closed

I see that all the necessary changes have been made to the old wiki. Normally these changes would need to be in the code, so they are generated by wikimaker, but this method is no longer used.

The RST files need to have usage examples and the link to the "remote job submission API docs." page needs repairing. This is beyond the scope of this ticket. So I pass it.

comment:9 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​9878

Note: See TracTickets for help on using tickets.