Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update for length, width, height units in containers for bulk edit and bulk create positions #6427

Closed
4 tasks
mvzhuang opened this issue Jun 21, 2023 · 10 comments
Assignees
Labels
Enhancement I think this would make Arctos even awesomer! Function-ContainerOrBarcode NeedsDocumentation When the issue is resolved in Arctos repository, this should be moved to the Documentation-wiki repo Priority-Normal (Not urgent) Normal because this needs to get done but not immediately.

Comments

@mvzhuang
Copy link

Instructions

This is a template to facilitate communication with the Arctos Code Table Committee. Submit a separate request for each relevant value. This form is appropriate for exploring how data may best be stored, for adding vocabulary, or for updating existing definitions.

Reviewing documentation before proceeding will result in a more enjoyable experience.


Initial Request

Want to add that length, width and height units have to be in centimeters because information more difficult to find without hunting around.

Proposed Value: Proposed new value. This should be clear and compatible with similar values in the relevant table and across Arctos.

Same values

Proposed Definition: Clear, complete, non-collection-type-specific functional definition of the value. Avoid discipline-specific terminology if possible, include parenthetically if unavoidable.

height no height of container in centimeters; "0" (no quotes) will update to NULL; blank will be ignored (no updates).
length no length of container in centimeters; "0" (no quotes) will update to NULL; blank will be ignored (no updates).
width no width of container in centimeters; "0" (no quotes) will update to NULL; blank will be ignored (no updates).
position_width yes Width in centimeters of the positions being created
position_length yes Length in centimeters of the positions being created
position_height yes Height in centimeters of the positions being created

Attribute data type If the request is for an attribute, what values will be allowed?
free-text, categorical, or number+units depending upon the attribute (TBA)

Attribute controlled values If the values are categorical (to be controlled by a code table), add a link to the appropriate code table. If a new table or set of values is needed, please elaborate.

Attribute units If numberical values should be accompanied by units, provide a link to the appropriate units table.

Context: Describe why this new value is necessary and existing values are not.

So that people don't accidentally choose their own units and units are readily available

Table: Code Tables are http://arctos.database.museum/info/ctDocumentation.cfm. Link to the specific table or value. This may involve multiple tables and will control datatype for Attributes. OtherID requests require BaseURL (and example) or explanation. Please ask for assistance if unsure.

Collection type: Some code tables contain collection-type-specific values. collection_cde may be found from https://arctos.database.museum/home.cfm

Priority: Please describe the urgency and/or choose a priority-label to the right. You should expect a response within two working days, and may utilize Arctos Contacts if you feel response is lacking.

Example Data: Requests with clarifying sample data are generally much easier to understand and prioritize. Please attach or link to any representative data, in any form or format, which might help clarify the request.

Available for Public View: Most data are by default publicly available. Describe any necessary access restrictions.

Project: Add the issue to the Code Table Management Project.

Discussion: Please reach out to anyone who might be affected by this change. Leave a comment or add this to the Committee agenda if you believe more focused conversation is necessary.

@ArctosDB/arctos-code-table-administrators

Approval

All of the following must be checked before this may proceed.

The How-To Document should be followed. Pay particular attention to terminology (with emphasis on consistency) and documentation (with emphasis on functionality). No person should act in multiple roles; the submitter cannot also serve as a Code Table Administrator, for example.

  • Code Table Administrator[1] - check and initial, comment, or thumbs-up to indicate that the request complies with the how-to documentation and has your approval
  • Code Table Administrator[2] - check and initial, comment, or thumbs-up to indicate that the request complies with the how-to documentation and has your approval
  • DBA - The request is functionally acceptable. The term is not a functional duplicate, and is compatible with existing data and code.
  • DBA - Appropriate code or handlers are in place as necessary. (ID_References, Media Relationships, Encumbrances, etc. require particular attention)

Rejection

If you believe this request should not proceed, explain why here. Suggest any changes that would make the change acceptable, alternate (usually existing) paths to the same goals, etc.

  1. Can a suitable solution be found here? If not, proceed to (2)
  2. Can a suitable solution be found by Code Table Committee discussion? If not, proceed to (3)
  3. Take the discussion to a monthly Arctos Working Group meeting for final resolution.

Implementation

Once all of the Approval Checklist is appropriately checked and there are no Rejection comments, or in special circumstances by decree of the Arctos Working Group, the change may be made.

Review everything one last time. Ensure the How-To has been followed. Ensure all checks have been made by appropriate personnel.

Make changes as described above. Ensure the URL of this Issue is included in the definition.

Close this Issue.

DO NOT modify Arctos Authorities in any way before all points in this Issue have been fully addressed; data loss may result.

Special Exemptions

In very specific cases and by prior approval of The Committee, the approval process may be skipped, and implementation requirements may be slightly altered. Please note here if you are proceeding under one of these use cases.

  1. Adding an existing term to additional collection types may proceed immediately and without discussion, but doing so may also subject users to future cleanup efforts. If time allows, please review the term and definition as part of this step.
  2. The Committee may grant special access on particular tables to particular users. This should be exercised with great caution only after several smooth test cases, and generally limited to "taxonomy-like" data such as International Commission on Stratigraphy terminology.
@Jegelewicz
Copy link
Member

These aren't code table items, but they are defined in the way described:

image

Why? Shouldn't these all be accompanied by units so that one could use whatever units they prefer?

@Jegelewicz Jegelewicz changed the title Code Table Request - documentation update for length, width, height units in containers for bulk edit and bulk create positions Documentation update for length, width, height units in containers for bulk edit and bulk create positions Jun 22, 2023
@Jegelewicz Jegelewicz added this to the Needs Discussion milestone Jun 22, 2023
@Jegelewicz Jegelewicz added Enhancement I think this would make Arctos even awesomer! Edit Container Object Tracking Find Container Edit Container Tool labels Jun 22, 2023
@Jegelewicz
Copy link
Member

@mvzhuang what were you doing where this wasn't clear?

@Jegelewicz
Copy link
Member

Nevermind - I see it was bulk stuff...

@Jegelewicz
Copy link
Member

This is not a code table issue - I am closing it in favor of an enhancement request - ArctosDB/dev#39

@dustymc
Copy link
Contributor

dustymc commented Jun 22, 2023

Choosing the wrong template is not grounds for rejection!

@dustymc dustymc reopened this Jun 22, 2023
@dustymc dustymc added NeedsDocumentation When the issue is resolved in Arctos repository, this should be moved to the Documentation-wiki repo and removed Edit Container Object Tracking Find Container Edit Container Tool labels Jun 22, 2023
@Jegelewicz
Copy link
Member

I did not reject it - I made a new issue with a more appropriate ask?

@mvzhuang
Copy link
Author

mvzhuang commented Jun 22, 2023 via email

@dustymc
Copy link
Contributor

dustymc commented Jun 22, 2023

made a new issue

??

@Jegelewicz
Copy link
Member

#6427 (comment)

@Jegelewicz
Copy link
Member

Jegelewicz commented Aug 10, 2023

I added the height, width, and length descriptions to the instructions on the Load csv page for https://arctos.database.museum/loaders/bulkCreateContainer.cfm?action=ld

and position_length, position_width and position_height descriptions to the instructions on the Load csv page for https://arctos.database.museum/tools/bulkCreateContainerPositions.cfm?action=ld

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement I think this would make Arctos even awesomer! Function-ContainerOrBarcode NeedsDocumentation When the issue is resolved in Arctos repository, this should be moved to the Documentation-wiki repo Priority-Normal (Not urgent) Normal because this needs to get done but not immediately.
Projects
None yet
Development

No branches or pull requests

3 participants