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

Clarify where to ask questions #3378

Merged
merged 1 commit into from
Mar 23, 2015
Merged

Conversation

ahocevar
Copy link
Member

No description provided.

@@ -7,8 +7,5 @@ Welcome to [OpenLayers 3](http://openlayers.org/)!
## Examples
Check out the [hosted examples](http://openlayers.org/en/master/examples/), the [workshop](http://openlayers.org/ol3-workshop/) or poke around the evolving [API docs](http://openlayers.org/en/master/apidoc/).

## Questions
Copy link
Member

Choose a reason for hiding this comment

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

Personally I'd keep this section in the README since it's more likely to get viewed.
I think the chance of people clicking a link in the README is pretty low.

Copy link
Member Author

Choose a reason for hiding this comment

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

I removed it from the README.md and added it to the website and CONTRIBUTING.md instead. The reason is that when you create an issue, you have a clickable link to CONTRIBUTING.md. And when you're looking for documentation, you'll first go to the website and not to the github repo.

Copy link
Member

Choose a reason for hiding this comment

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

That's a good point.

@@ -2,6 +2,18 @@

Thanks for your interest in contributing to OpenLayers 3.

## Asking Questions

Please ask questions about using the library and its API on [stackoverflow using the tag 'openlayers-3'](http://stackoverflow.com/questions/tagged/openlayers-3).
Copy link
Member

Choose a reason for hiding this comment

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

I am wondering what "and its API" brings. To me, StackOverflow makes sense for questions about using the library. Everything else can go to the mailing list.

Copy link
Member Author

Choose a reason for hiding this comment

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

"and its API" removed.

@elemoine
Copy link
Member

Please merge when you think this is ready Andreas. Thanks for lot for your edits.

ahocevar added a commit that referenced this pull request Mar 23, 2015
Clarify where to ask questions
@ahocevar ahocevar merged commit b75f7f9 into openlayers:master Mar 23, 2015
@ahocevar ahocevar deleted the questions branch March 23, 2015 13:24
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.

5 participants