search

RefugeRestrooms / refugerestrooms

REFUGE restrooms indexes and maps safe restroom locations for trans, intersex, and gender nonconforming individuals.
http://www.refugerestrooms.org
GNU Affero General Public License v3.0
894 stars 261 forks source link

add wiki to README #436

Closed mi-wood closed 6 years ago

mi-wood commented 6 years ago

Closes https://github.com/RefugeRestrooms/refugerestrooms/issues/321

DeeDeeG commented 6 years ago

I dig it, generally.

Wiki before CONTRIBUTING.md makes logical sense.

Would like to look it over and think more about phrasing before merging this, if that's okay. I came up with the sentence explaining what the Wiki is about in under a minute, but README.md gets a lot of eyeballs on it, so worth extra consideration, I think. Thanks for making this a PR!

tkwidmer commented 6 years ago

This looks good to me.

DeeDeeG commented 6 years ago

Hi, I came up with some alternative text, but I'm really not sure which is better.

+For more information on how to contribute to Refuge Restrooms, or how the technology works, see the Wiki. + +To test your changes to Refuge Restrooms before before deploying them to the web, see CONTRIBUTING.md

Compare vs.:

+For more information on how the technology powering Refuge Restrooms works, or how to get started from scratch, see the Wiki. + +If you just want to get your environment setup for making changes locally and testing, you can head directly to the [CONTRIBUTING.md](https://github.com/RefugeRestrooms/ @refugerestrooms/blob/develop/CONTRIBUTING.md).

Thoughts/preferences?

Edit: I kinda like my alt text for the top sentence, but the bottom sentence I lean toward preferring the text in this PR.

DeeDeeG commented 6 years ago

Whoops, I think I pushed to the upstream branch instead of my local branch by mistake.

@mi-wood, if you still have your commits for this somewhere, you might want to force-push to this branch?

Otherwise, the whole added content of your commit was quoted in this comment: https://github.com/RefugeRestrooms/refugerestrooms/pull/436#issuecomment-363474782

FWIW I think this might be the best text:

For more information on how to contribute to Refuge Restrooms, or how the technology works, see the [Wiki](https://github.com/RefugeRestrooms/refugerestrooms/wiki).

If you just want to get your environment set up for making changes locally and testing, you can head directly to [`CONTRIBUTING.md`](https://github.com/RefugeRestrooms/ @refugerestrooms/blob/develop/CONTRIBUTING.md).

But I don't want to hold this PR up, and I defer to your judgment, @mi-wood @tkwidmer

mi-wood commented 6 years ago

I like that last quoted text you posted 👍 feel free to push and merge that