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

[DEV] admin-only field to flag 'Stub' entries #765

Open
ascott opened this issue Oct 9, 2019 · 7 comments

Comments

@ascott
Copy link
Contributor

commented Oct 9, 2019

Allow entries to be marked as 1 of 5 completeness levels:

Stub = entire narrative is missing OR the entry is missing enough information to constitute an entire classroom assignment's worth of work to complete
Partial (content) = has about 50% of its narrative OR the entry is missing enough information to constitute HALF a classroom assignment's worth of work to complete.
Partial (citations) = an entry that is missing all citations (footnotes) but is otherwise complete (ie. would not make a good classroom assignment b/c the only things to add are references)***
Partial (edits) = an entry that needs significant improvements to its grammar/spelling. Can be any level of completeness.
Complete = anything above partial. Contains enough information to know what went on, and too much information to constitute half a classroom assignment.

Design issue and more discussion: #701

Backend Work for @paninee

Database

  • for each of these entry types ['cases', 'organizations', 'methods']
  • add a field called completeness which can accept 1 of the following keys
    ['stub', 'partial_content', 'partial_citations', 'partial_editing', 'complete']

Views

  • the completeness field should be passed with other entry data on the following pages/views
    • home/search page
    • reader page
    • edit form page

Updating

  • when the completeness field is passed (with one of the accepted keys) to the update action in the controller it should be saved
  • only admin’s can update this field
  • if an empty string or null value is passed, delete the currently saved value

Filters (cases only for now)

  • allow filtering on the completeness field
  • the following url should return only entries marked as stubs https://participedia.net/?selectedCategory=case&completeness=stub (and for each of the other completeness keys)
  • allow multiple filters on the completeness field. The user may filter for both 'stub', 'partial_content', for example.

Frontend Work for @ascott

Views

  • on reader view, add user prompt with link to edit form for article -
    design: #701 (comment)
  • on edit view, for admins only add select field with completeness options - design: #701 (comment)

Updating

  • pass completeness field up with the rest of the entry data to be save

Filters (cases only for now)

  • add filter option to list of filters, add Completeness as it's own pill
@ascott

This comment has been minimized.

Copy link
Contributor Author

commented Oct 9, 2019

@paninee let me know your thoughts on this breakdown and if you have any ideas to improve how we do this!

@ascott

This comment has been minimized.

Copy link
Contributor Author

commented Oct 9, 2019

@paninee i've started a branch this feature. let's both work off this branch, or feel free to work on another branch and submit a PR against this branch: master...feature/stub-completeness-flags

@jesicarson

This comment has been minimized.

Copy link

commented Oct 9, 2019

Note: @scottofletcher will draft the text for these 5 states values in the drop down menu in this document.

@scottofletcher

This comment has been minimized.

Copy link

commented Oct 9, 2019

@jesicarson yes good point, that does happen sometimes, and when it does, we tend to leave it up to the editor's discretion. I tend to use the grammar/spelling prompt in these cases, since it's kind of vague (I tried to write it so it wouldn't sound pejorative since some entries w/bad grammar are entered by our ESL partners). in cases where it's a partial (less than 50% of its narrative) and has bad spelling/grammar and/or is missing citations, I just use the partial prompt (ie. 'the following entry is incomplete...etc').

@jesicarson

This comment has been minimized.

Copy link

commented Oct 9, 2019

sorry @scottofletcher can you post the above comment in the design issue? thanks, i realized i should have done that and moved my comment there - #701 (comment)

@jesicarson

This comment has been minimized.

Copy link

commented Oct 10, 2019

@ascott while you're in there, please change the "Overview" chip to read "Issues"

@ascott

This comment has been minimized.

Copy link
Contributor Author

commented Oct 16, 2019

@paninee can you please link me to the branch you've got the backend work in? i'd like to pull it into my front-end branch to test the flow end to end. thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.