Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-17196

Improve user guide for Fields (particularly ConfigurableField and RegistryField)

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: pex_config
    • Labels:
      None
    • Templates:
    • Team:
      Data Access and Database

      Description

      The current user guide for pex_config is seeded from its original README (DM-11558). In the review it was suggested that the this content would benefit from additional examples around ConfigurableField:

      Using RegistryField for subtasks is a bit of an edge case (usually we'd use ConfigurableField), so while this is an important example, it's a bit jarring to have it without a ConfigurableField example.

      We should probably pull out and expand the bit about the Configurable concept from the RegistryField docs and make it a topic page that includes examples of both ConfigurableField and RegistryField.

       

      I'd suggest:

      • Have a full topic page on ConfigurableField for configuring subtasks
      • Improve the existing registry-intro.rst
      • Improve field-types.rst so that it first summarizes the purpose of each configuration field, and then has a section dedicated to each configuration field that provides examples.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                jsick Jonathan Sick
                Watchers:
                John Swinbank, Jonathan Sick
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel