Ticket #10563 (closed: fixed)
Write offline documentation for new Reflectometry UI
| Reported by: | Harry Jeffery | Owned by: | Harry Jeffery |
|---|---|---|---|
| Priority: | critical | Milestone: | Release 3.3 |
| Component: | Documentation | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | #10148, #10238, #10599, #10600 | Tester: | Owen Arnold |
Description
The new documentation should:
- Identify and explain the different parts of the reflectometry ui
- Demonstrate a sample workflow
- Identify potential pitfalls, problems, and errors, and explain how to resolve them
- Be reasonably concise. Unreadable documentation is useless documentation.
Change History
comment:1 Changed 6 years ago by Harry Jeffery
- Status changed from new to assigned
- Blocking 10148 added
comment:3 Changed 6 years ago by Harry Jeffery
Refs #10563 Add interfaces category to offline documentation
Changeset: 5b04b60ebf8dd4a6d338a2277dc23079bdf28482
comment:4 Changed 6 years ago by Harry Jeffery
Refs #10563 Add initial ISIS Reflectometry interface documentation
Changeset: 8a137c9b62464531e1877108942f5df914dd7d82
comment:5 Changed 6 years ago by Harry Jeffery
Refs #10563 Add "help" action to Reflectometry UI
Changeset: d4319281e99d8cf593fcec120a5de3ee035f3886
comment:6 Changed 6 years ago by Harry Jeffery
Refs #10563 Add python bindings for createSubWindow
We need this to generate documentation screenshots of c++ custom interfaces
Changeset: 751931e42ad7b7c40b0abbc12b77033c7d6cf5eb
comment:7 Changed 6 years ago by Harry Jeffery
Refs #10563 Generate screenshots for custom interface documentation
Changeset: 66e728f68a4ec5bebfe5bb0a928d4205b222eab9
comment:8 Changed 6 years ago by Harry Jeffery
Refs #10563 Add troubleshooting instructions to Refl UI documentation
Changeset: 9d3b4d08db2f11a2dee0418a8aa10105dee6cc53
comment:9 Changed 6 years ago by Harry Jeffery
Refs #10563 Christen the new Refl UI
Changeset: 45bf269464f86075d1b1c4f333f1eb89b7de5384
comment:10 Changed 6 years ago by Harry Jeffery
Refs #10563 Insert TOC manually
Changeset: c9b534090547f826d802647dc656e2f08643477f
comment:11 Changed 6 years ago by Harry Jeffery
Refs #10563 Add "widget" option to interface directive
This option allows you to specify a widget's name to screenshot just that widget.
Changeset: 74561d71994931663b066d387486aa215ffc77ae
comment:12 Changed 6 years ago by Harry Jeffery
Refs #10563 Support custom alignment
Changeset: 457ef303bbabd0679c4257b6690932c20123ea7a
comment:13 Changed 6 years ago by Harry Jeffery
Refs #10563 Use widget screenshots in Refl UI docs
Changeset: b082d34f649a8a6ae70753619536166498758bc6
comment:14 Changed 6 years ago by Harry Jeffery
Refs #10563 Add example workflow to refl ui docs
Changeset: d9fd7624af65b2d4f7037a1570ef96991febed08
comment:15 Changed 6 years ago by Harry Jeffery
- Status changed from inprogress to verify
- Resolution set to fixed
Testing'
- Open the ISIS Reflectometry (Polref) interface.
- Click the help button (question makr)
- Review the documentation
- Inspect code changes
- Verify tests are passing
comment:16 Changed 6 years ago by Harry Jeffery
- Blocking 10238 added
(In #10238) Blocked by documentation, as this would have to update the new documentation before it could be merged.
comment:17 Changed 6 years ago by Owen Arnold
- Status changed from verify to verifying
- Tester set to Owen Arnold
comment:18 Changed 6 years ago by Owen Arnold
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/10563_new_refl_ui_offline_documentation'
Full changeset: 727d50d301d7b00966a85494ee3e946db34739f9
comment:20 Changed 6 years ago by Owen Arnold
This is excellent!
comment:22 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 11405
