Ticket #10041 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Change the algorithm plugin to create links to the workspace types

Reported by: Nick Draper Owned by: Nick Draper
Priority: major Milestone: Release 3.3
Component: Documentation Keywords:
Cc: Blocked By: #9923
Blocking: Tester: Dan Nixon

Description


Change History

comment:1 Changed 6 years ago by Nick Draper

  • Blocked By 9923 added

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:3 Changed 6 years ago by Nick Draper

  • Blocked By 9923 removed

(In #9923) To Test:

  1. Build the documentation
  2. Check the concepts pages are created
  3. check the links between concepts pages work
  4. check the links between algorithms and concepts work
  5. and vice versa

This ticket does not cover:

  1. Changing the algorithm plugin to create links to the workspace types #10041
  2. Rewriting the concepts pages to be better aimed at users #10042
  3. creating redirects, or removing the old pages from the wiki #10043

comment:4 Changed 6 years ago by Nick Draper

  • Blocked By 9923 added

comment:5 Changed 6 years ago by Dan Nixon

  • Status changed from assigned to inprogress

Ignore this, I mistyped the ticket number of a commit.

Last edited 6 years ago by Dan Nixon (previous) (diff)

comment:6 Changed 6 years ago by Nick Draper

re #10041 Added links for property type and a couple of concept pages

Changeset: 0fcffd00b6b9f4b3b291c2fe64279b1239281f43

comment:7 Changed 6 years ago by Nick Draper

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

To test

  1. Build the docs
  2. Look at a few algorithms doc pages, the workspaces properties in the property table (just the type column) should now be links.
  3. I've also added Concepts pages for PeaksWorkspace and RectangularDetector, take a look at them as well.

comment:8 Changed 6 years ago by Dan Nixon

  • Status changed from verify to verifying
  • Tester set to Dan Nixon

comment:9 Changed 6 years ago by Dan Nixon

  • Status changed from verifying to reopened
  • Resolution fixed deleted

Couple of minor things:

  • The first bullet on Creating a PeaksWorkspace: Is MDWorkspace supposed to be a link, if so it is rendering as just [[MDWorkspace]]
  • Under The Peak Object: it looks like there should be a list here but it has not rendered as one. (I think line 29 needs a newline at the end)
  • Under Peak Python Interface: The quotes around p look a little odd when rendered: ‘’p’’

comment:10 Changed 6 years ago by Nick Draper

  • Status changed from reopened to inprogress

re #10041 formatting improvements for PeaksWorkspace

Changeset: c5d09c5705c1426a1ab1815ddef8aed21dc487b5

comment:11 Changed 6 years ago by Nick Draper

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

Items from comment 9 have been fixed.

comment:12 Changed 6 years ago by Dan Nixon

  • Status changed from verify to verifying

comment:13 Changed 6 years ago by Dan Nixon

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/10041_workspace_links_in_help_docs'

Full changeset: 8d47cd1a6c7774416454ea8436d573b8fd8f3770

comment:14 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10883

Note: See TracTickets for help on using tickets.