Ticket #6147 (closed: fixed)
wikimaker restructure algorithm pages
| Reported by: | Nick Draper | Owned by: | Owen Arnold |
|---|---|---|---|
| Priority: | blocker | Milestone: | Release 2.5 |
| Component: | Mantid | Keywords: | |
| Cc: | Blocked By: | #6628 | |
| Blocking: | #6690, #6709 | Tester: | Nick Draper |
Description
- update wikimaker to handle the updated format for algorithm pages
- review all pages to check that they are all sourced from code documantation
- update all pages
Change History
comment:2 Changed 8 years ago by Nick Draper
- Milestone changed from Release 2.4 to Release 2.5
Moved at the code freeze for release 2.4
comment:5 Changed 8 years ago by Owen Arnold
refs #6147 Include image link.
Changeset: d28244d4f0869cc0421d4acbe92d2abbaf954e7a
comment:7 Changed 8 years ago by Owen Arnold
refs #6147. Python Signature Section.
Changeset: 43fbb763db6135fae61ea6a0087e112f9db07a8f
comment:8 Changed 8 years ago by Owen Arnold
refs #6147. Add Image Link.
Changeset: fe9a6025b895456d58ee708c0c91af84e5f83bdc
comment:9 Changed 8 years ago by Owen Arnold
refs #6147 Identify bot.
Better way to identify that the last edit changes were the wikimaker. Also allows users to run wikimaker as their personal user, and therfore makes things more accountable.
Changeset: 490b0ed96886a655b8d5b03b9ca7a7d7dd94aa99
comment:10 Changed 8 years ago by Owen Arnold
refs #6147. Python Signature Section.
Changeset: 43fbb763db6135fae61ea6a0087e112f9db07a8f
comment:11 Changed 8 years ago by Owen Arnold
refs #6147. Add Image Link.
Changeset: fe9a6025b895456d58ee708c0c91af84e5f83bdc
comment:12 Changed 8 years ago by Owen Arnold
refs #6147 Identify bot.
Better way to identify that the last edit changes were the wikimaker. Also allows users to run wikimaker as their personal user, and therfore makes things more accountable.
Changeset: 490b0ed96886a655b8d5b03b9ca7a7d7dd94aa99
comment:13 Changed 8 years ago by Owen Arnold
refs #6147. isValid is property in old api.
Changeset: 20a8fcc0a7dcaef90e6704ff4230faf72feeb2da
comment:15 Changed 8 years ago by Owen Arnold
refs #6147. isValid is property in old api.
Changeset: 20a8fcc0a7dcaef90e6704ff4230faf72feeb2da
comment:16 Changed 8 years ago by Owen Arnold
refs #6147. Fix z-index and layout.
Changeset: 8d004937ef0e060ce196328727826615caf5bd07
comment:17 Changed 8 years ago by Owen Arnold
refs #6147. Skip confirmation option.
This will be required by the wikimaker when run as part of the jenkins job.
Changeset: a0b345f0bab9d828fafe297943b4c4078ebdc535
comment:18 Changed 8 years ago by Owen Arnold
refs #6147. Skip confirmation option.
This will be required by the wikimaker when run as part of the jenkins job.
Changeset: a0b345f0bab9d828fafe297943b4c4078ebdc535
comment:19 Changed 8 years ago by Owen Arnold
- Status changed from accepted to verify
- Resolution set to fixed
Branch is https://github.com/mantidproject/mantid/tree/feature/6147_format
Tester : The wikimaker page layout should now be exactly what Nick Draper wants, so the first thing would be to confirm it with him after running the wikimaker on some target algorithm.
There are two important things to note.
1) There is a new usage section, which should contain the python signature for that algorithm.
2) There should also be an image of the algorithm dialog associated with that image.
Another thing to confirm is that the wikimaker has a new option 'continue-confirm', which should skip over any confirmation inputs if set. This is going to be required for automated runs of all algorithms by the wikimaker.
comment:20 Changed 8 years ago by Owen Arnold
refs #6147. Correct minor mistake.
Changeset: 72852e16eda979f7e1e2623fb651f463d61a3799
comment:21 Changed 8 years ago by Owen Arnold
refs #6147. Correct minor mistake.
Changeset: 72852e16eda979f7e1e2623fb651f463d61a3799
comment:22 Changed 8 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:23 Changed 8 years ago by Nick Draper
- Status changed from verifying to reopened
- Resolution fixed deleted
comment:24 Changed 8 years ago by Owen Arnold
- Status changed from reopened to accepted
Reopened because the python usage does not provide a return type.
Either want this to be an output workspace or a tuple. For the tuple case, Nick has already emailed me the template to use.
comment:25 Changed 8 years ago by Owen Arnold
refs #6147. Smarter python usage.
Uses the output properties to complete the python signature.
Changeset: 706c345c699ccd6abaecf395df1b85d85353e46f
comment:26 Changed 8 years ago by Owen Arnold
- Status changed from accepted to verify
- Resolution set to fixed
Tester (a.k.a Nick) : The usage has been updated. For examples of this running on different workspaces with different numbers of output types see.
- Rebin (1 workspace output )
- Stitch1D ( 1 workspace output and one value output )
- LoadParameterFile ( No outputs )
comment:28 Changed 8 years ago by Nick Draper
- Status changed from verifying to closed
passed, but a further ticket will handle usage and special exceptions for FIT and LOAD
comment:29 Changed 8 years ago by Owen Arnold
refs #6147. Python Signature Section.
Changeset: 43fbb763db6135fae61ea6a0087e112f9db07a8f
comment:30 Changed 8 years ago by Owen Arnold
refs #6147. Add Image Link.
Changeset: fe9a6025b895456d58ee708c0c91af84e5f83bdc
comment:31 Changed 8 years ago by Owen Arnold
refs #6147 Identify bot.
Better way to identify that the last edit changes were the wikimaker. Also allows users to run wikimaker as their personal user, and therfore makes things more accountable.
Changeset: 490b0ed96886a655b8d5b03b9ca7a7d7dd94aa99
comment:32 Changed 8 years ago by Owen Arnold
refs #6147. isValid is property in old api.
Changeset: 20a8fcc0a7dcaef90e6704ff4230faf72feeb2da
comment:33 Changed 8 years ago by Owen Arnold
refs #6147. Fix z-index and layout.
Changeset: 8d004937ef0e060ce196328727826615caf5bd07
comment:34 Changed 8 years ago by Owen Arnold
refs #6147. Skip confirmation option.
This will be required by the wikimaker when run as part of the jenkins job.
Changeset: a0b345f0bab9d828fafe297943b4c4078ebdc535
comment:35 Changed 8 years ago by Owen Arnold
refs #6147. Correct minor mistake.
Changeset: 72852e16eda979f7e1e2623fb651f463d61a3799
comment:36 Changed 8 years ago by Owen Arnold
refs #6147. Smarter python usage.
Uses the output properties to complete the python signature.
Changeset: 706c345c699ccd6abaecf395df1b85d85353e46f
comment:38 Changed 8 years ago by Owen Arnold
refs #6147. Python Signature Section.
Changeset: 43fbb763db6135fae61ea6a0087e112f9db07a8f
comment:39 Changed 8 years ago by Owen Arnold
refs #6147. Add Image Link.
Changeset: fe9a6025b895456d58ee708c0c91af84e5f83bdc
comment:40 Changed 8 years ago by Owen Arnold
refs #6147 Identify bot.
Better way to identify that the last edit changes were the wikimaker. Also allows users to run wikimaker as their personal user, and therfore makes things more accountable.
Changeset: 490b0ed96886a655b8d5b03b9ca7a7d7dd94aa99
comment:41 Changed 8 years ago by Owen Arnold
refs #6147. isValid is property in old api.
Changeset: 20a8fcc0a7dcaef90e6704ff4230faf72feeb2da
comment:42 Changed 8 years ago by Owen Arnold
refs #6147. Fix z-index and layout.
Changeset: 8d004937ef0e060ce196328727826615caf5bd07
comment:43 Changed 8 years ago by Owen Arnold
refs #6147. Skip confirmation option.
This will be required by the wikimaker when run as part of the jenkins job.
Changeset: a0b345f0bab9d828fafe297943b4c4078ebdc535
comment:44 Changed 8 years ago by Owen Arnold
refs #6147. Correct minor mistake.
Changeset: 72852e16eda979f7e1e2623fb651f463d61a3799
comment:45 Changed 8 years ago by Owen Arnold
refs #6147. Smarter python usage.
Uses the output properties to complete the python signature.
Changeset: 706c345c699ccd6abaecf395df1b85d85353e46f
comment:46 Changed 8 years ago by Owen Arnold
refs #6147. Python Signature Section.
Changeset: 43fbb763db6135fae61ea6a0087e112f9db07a8f
comment:47 Changed 8 years ago by Owen Arnold
refs #6147. Add Image Link.
Changeset: fe9a6025b895456d58ee708c0c91af84e5f83bdc
comment:48 Changed 8 years ago by Owen Arnold
refs #6147 Identify bot.
Better way to identify that the last edit changes were the wikimaker. Also allows users to run wikimaker as their personal user, and therfore makes things more accountable.
Changeset: 490b0ed96886a655b8d5b03b9ca7a7d7dd94aa99
comment:49 Changed 8 years ago by Owen Arnold
refs #6147. isValid is property in old api.
Changeset: 20a8fcc0a7dcaef90e6704ff4230faf72feeb2da
comment:50 Changed 8 years ago by Owen Arnold
refs #6147. Fix z-index and layout.
Changeset: 8d004937ef0e060ce196328727826615caf5bd07
comment:51 Changed 8 years ago by Owen Arnold
refs #6147. Skip confirmation option.
This will be required by the wikimaker when run as part of the jenkins job.
Changeset: a0b345f0bab9d828fafe297943b4c4078ebdc535
comment:52 Changed 8 years ago by Owen Arnold
refs #6147. Correct minor mistake.
Changeset: 72852e16eda979f7e1e2623fb651f463d61a3799
comment:53 Changed 8 years ago by Owen Arnold
refs #6147. Smarter python usage.
Uses the output properties to complete the python signature.
Changeset: 706c345c699ccd6abaecf395df1b85d85353e46f
comment:54 Changed 8 years ago by Owen Arnold
refs #6147. Python Signature Section.
Changeset: 76ddfd128c96560d6eccadf55683f67395d6dee3
comment:55 Changed 8 years ago by Owen Arnold
refs #6147. Add Image Link.
Changeset: 770f6d6c63f4e61ac9b0c07f4311f9c4a2f41065
comment:56 Changed 8 years ago by Owen Arnold
refs #6147 Identify bot.
Better way to identify that the last edit changes were the wikimaker. Also allows users to run wikimaker as their personal user, and therfore makes things more accountable.
Changeset: 60f0cffae22689beb530cda17eaf75244b78f762
comment:57 Changed 8 years ago by Owen Arnold
refs #6147. isValid is property in old api.
Changeset: dfee530847557b13a866f49d0f24e026944cfc59
comment:58 Changed 8 years ago by Owen Arnold
refs #6147. Fix z-index and layout.
Changeset: 2dd06811ae30b0bd67fbff241c7fa9b47a60ec8b
comment:59 Changed 8 years ago by Owen Arnold
refs #6147. Skip confirmation option.
This will be required by the wikimaker when run as part of the jenkins job.
Changeset: 901565847688712074c34479decfe62e8c6818cd
comment:60 Changed 8 years ago by Owen Arnold
refs #6147. Correct minor mistake.
Changeset: d87adb8cfe98bac12272179377a4330fcfc687e2
comment:61 Changed 8 years ago by Owen Arnold
refs #6147. Smarter python usage.
Uses the output properties to complete the python signature.
Changeset: 0bc65c489806cb84d5c83fab182cef1db7a7e278
comment:62 Changed 8 years ago by Owen Arnold
refs #6147. Python Signature Section.
Changeset: 43fbb763db6135fae61ea6a0087e112f9db07a8f
comment:63 Changed 8 years ago by Owen Arnold
refs #6147. Add Image Link.
Changeset: fe9a6025b895456d58ee708c0c91af84e5f83bdc
comment:64 Changed 8 years ago by Owen Arnold
refs #6147 Identify bot.
Better way to identify that the last edit changes were the wikimaker. Also allows users to run wikimaker as their personal user, and therfore makes things more accountable.
Changeset: 490b0ed96886a655b8d5b03b9ca7a7d7dd94aa99
comment:65 Changed 8 years ago by Owen Arnold
refs #6147. isValid is property in old api.
Changeset: 20a8fcc0a7dcaef90e6704ff4230faf72feeb2da
comment:66 Changed 8 years ago by Owen Arnold
refs #6147. Fix z-index and layout.
Changeset: 8d004937ef0e060ce196328727826615caf5bd07
comment:67 Changed 8 years ago by Owen Arnold
refs #6147. Skip confirmation option.
This will be required by the wikimaker when run as part of the jenkins job.
Changeset: a0b345f0bab9d828fafe297943b4c4078ebdc535
comment:68 Changed 8 years ago by Owen Arnold
refs #6147. Correct minor mistake.
Changeset: 72852e16eda979f7e1e2623fb651f463d61a3799
comment:69 Changed 8 years ago by Owen Arnold
refs #6147. Smarter python usage.
Uses the output properties to complete the python signature.
Changeset: 706c345c699ccd6abaecf395df1b85d85353e46f
comment:70 Changed 8 years ago by Owen Arnold
refs #6147. Python Signature Section.
Changeset: 43fbb763db6135fae61ea6a0087e112f9db07a8f
comment:71 Changed 8 years ago by Owen Arnold
refs #6147. Add Image Link.
Changeset: fe9a6025b895456d58ee708c0c91af84e5f83bdc
comment:72 Changed 8 years ago by Owen Arnold
refs #6147 Identify bot.
Better way to identify that the last edit changes were the wikimaker. Also allows users to run wikimaker as their personal user, and therfore makes things more accountable.
Changeset: 490b0ed96886a655b8d5b03b9ca7a7d7dd94aa99
comment:73 Changed 8 years ago by Owen Arnold
refs #6147. isValid is property in old api.
Changeset: 20a8fcc0a7dcaef90e6704ff4230faf72feeb2da
comment:74 Changed 8 years ago by Owen Arnold
refs #6147. Fix z-index and layout.
Changeset: 8d004937ef0e060ce196328727826615caf5bd07
comment:75 Changed 8 years ago by Owen Arnold
refs #6147. Skip confirmation option.
This will be required by the wikimaker when run as part of the jenkins job.
Changeset: a0b345f0bab9d828fafe297943b4c4078ebdc535
comment:76 Changed 8 years ago by Owen Arnold
refs #6147. Correct minor mistake.
Changeset: 72852e16eda979f7e1e2623fb651f463d61a3799
comment:77 Changed 8 years ago by Owen Arnold
refs #6147. Smarter python usage.
Uses the output properties to complete the python signature.
Changeset: 706c345c699ccd6abaecf395df1b85d85353e46f
comment:78 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 6993
What is the new format for algorithm pages? Do you mean adding in a usage example? Or just moving the property table down to be the last item on the page?