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

NWEA-Map: Add note about assessment ID #48

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

johncmerfeld
Copy link
Contributor

@johncmerfeld johncmerfeld commented May 22, 2024

Adds a maintenance note to the NWEA-Map bundle advising users to check the assessment ID used by their implementation.

@johncmerfeld johncmerfeld added the documentation Improvements or additions to documentation label May 22, 2024
@johncmerfeld johncmerfeld self-assigned this May 22, 2024
@susanxiong
Copy link
Contributor

I think this could move to around line 16-17

Copy link
Contributor

@susanxiong susanxiong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for doing this!

@susanxiong susanxiong requested a review from jalvord1 May 22, 2024 16:38
@susanxiong
Copy link
Contributor

related to #12

<details>
<summary> Assessment ID </summary>

The `assessmentIdentifier` used in this repo is "NWEA-Map." Some implementations may wish to spell or format this differently (e.g. "NWEA-MAP"). Double check your implementation and, if necessary, update the following files prior to running:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@johncmerfeld Does 'update the following files' mean using project composition? I think if so we should state that and maybe link to the PC part of the EM readme

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I don't think I understand project composition well enough to answer confidently, but I think no. All that's needed is to alter some string values in the listed files

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess what I was thinking is that if someone is just installing this bundle, they can't edit the files unless they created a branch of the bundles repo and kept their project on that branch. @susanxiong do you have thoughts here? Curious what Jeffco is doing for this one

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yeah that's fair. So far I've only been using bundles from a developer's perspective so hadn't thought too much about what more of an "end user" would do. Hm…

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oop, we don't have it set up to run automatically or anything, so to run MAP files, we have just been pulling down the repo locally and modifying the files as needed before running earthmover.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps we make assessment ID a runtime argument

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay gotcha! I think pushing people to use project composition in this situation is ideal since the goal of that feature is to allow people to make edits to the original bundle if something doesn't work for your particular implementation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants