Document available record mappings.

Open Beginner friendly
#752 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Start with the README's Mapping Configuration section and the settings page's Mappings tooltip/help text. Link both locations to the referenced InterSystems documentation so users can discover additional mappings such as LUT. The work is done when both locations explain that extra mappings are available and provide the documentation link.

Written by the indexing model from the issue text.

Description

When I installed v2.10.0 of this module, the default mappings were CLS, DFI, INC, MAC, and PTD. I did not realize adding LUT was an option and required for being able to export Data Lookup Tables. Pravin kindly pointed me to this documentation on this comment. (I have come to this module though the developer community and have never used ISC's cloud services, so I would not have thought to look there for documentation.)

I think this documentation should be linked to from the following places:

  • The Mapping Configuration section of the readme, which does not currently hint that additional extensions are possible beyond the ones included in the screenshot.
  • The settings page. The "Mappings" item has a tool tip/help text, but I think you should add some text and a hyperlink to that docs.intersystems.com page along these lines:

Image

Dominant language
ObjectScript
Stars
22
Forks
14
Avg merge
1d 9h
Merged PRs (30d)
5

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from intersystems/git-source-control

All issues in intersystems/git-source-control

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.