Skip to content

Conversation

@rachaelkiteme
Copy link
Collaborator

@rachaelkiteme rachaelkiteme commented Jul 19, 2018

In your PR did you:
Fixes #967

  • Include a description of the changes?
  • Mention the issue the PR addresses?
  • Include screenshots of any changes to the UI?
  • Isolate any changes to gems (meaning that any new, updated, or removed gems and resulting code changes should be in their own PR)?
  • Add and/or update specs for your code?

@rlgreen91
Copy link
Contributor

Ah, I guess I was a bit unclear - I'd like for you to add the actual content as well. Explain how to add a case (including that you should be logged in first!), include screenshots, etc. Same for editing cases.

@rachaelkiteme
Copy link
Collaborator Author

rachaelkiteme commented Jul 23, 2018 via email

@rlgreen91
Copy link
Contributor

Hmm, I see what you mean. I still think we need to have a page on how to use and contribute to the website, separate from a general contribution page that has links to the page I just mentioned, a link to Github, link to donate, etc.

Tell you what - please copy over the sections on adding a new case and editing a case onto the new page you've made. Make those the collapsible sections I mentioned in the issue, and add screenshots where you see fit.

@rlgreen91
Copy link
Contributor

@rachaelkiteme Is this a WIP? Would it help for me to make a label for WIP that you can apply for stuff you don't want me to review just yet?

@rachaelkiteme rachaelkiteme changed the title Added case guide subsections Added case guide subsections[WIP] Jul 25, 2018
@rlgreen91
Copy link
Contributor

@rachaelkiteme What's the status on this PR?

@rachaelkiteme
Copy link
Collaborator Author

I did it partly. I had this challenge where once I rake db:seed locally no data is displayed. You were to help on this.

@rlgreen91
Copy link
Contributor

Right, I'm looking into that, but...oh. Okay, so, in general, when you make documentation, you want to make it from the perspective of the person who'll read it, right? In this case, since this is something that a user will read when learning how to use our site, you'll want to go through the steps on the actual website and make the docs based on that, not your local dev environment.

Depressingly enough, here's a link to a database of potential cases: https://www.washingtonpost.com/graphics/national/police-shootings/. From there you can find a case to add and one to edit.

@rachaelkiteme rachaelkiteme changed the title Added case guide subsections[WIP] Added case guide subsections Aug 10, 2018
@rlgreen91 rlgreen91 merged commit b16cb0d into master Aug 11, 2018
@rlgreen91 rlgreen91 deleted the add_example_of_added_and_updated_case_guide_#967 branch August 11, 2018 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants