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

Introduction tutorial #2280

Merged
merged 1 commit into from
Jul 3, 2014
Merged

Introduction tutorial #2280

merged 1 commit into from
Jul 3, 2014

Conversation

probins
Copy link
Contributor

@probins probins commented Jul 1, 2014

Suggestion for making a start on the tutorials. This is probably not complete (I shall probably remember things I've forgotten five minutes after submitting), but it can serve as a starting point.

I think tutorials should supplement what's in the api docs and examples, providing more detailed info on specific subjects. I would like to see more detailed tutorials on:

  • event handling
  • rendering process
  • projection handling
  • custom building

I can make a start on these, but I'm not an expert on the first two, so others would have to expand.

Not sure it's a good idea having these tutorials as hbs; not easy to read on Github.

@tschaub
Copy link
Member

tschaub commented Jul 1, 2014

Thanks for getting a start on these @probins.

Not sure it's a good idea having these tutorials as hbs; not easy to read on Github.

Our first goal should be to have them render nicely on the ol3 website. I'd like to change how the website is built, and it may be that these will become .md files (still with YAML front matter). So they may become more readable on GitHub as well. But I don't think that should be a primary goal.

@probins
Copy link
Contributor Author

probins commented Jul 2, 2014

I'd like to change how the website is built, and it may be that these will become .md files (still with YAML front matter). So they may become more readable on GitHub as well. But I don't think that should be a primary goal.

I've just been looking at the website repo, and AFAICS this should work with *.md files as is. There is no hbs markup in these tutorial files, so I don't see any need for them to be *.hbs. The layout pulls them in as md anyway. Let me know if you don't agree. Otherwise I'll change this tutorial to .md

@probins
Copy link
Contributor Author

probins commented Jul 2, 2014

ok, I set up the current website repo, and ran assemble with tutorials named *.md, and it works without problem. So I've renamed this tutorial .md.

ISTM this is better not only because it's readable on Github, but also from the point of view of separating content from presentation. What's in doc/ is 'raw' content; how that's presented on the website is up to the software in the website repo.

@probins
Copy link
Contributor Author

probins commented Jul 3, 2014

added mention that lib intended for both desktop and mobile devices

@pagameba
Copy link
Member

pagameba commented Jul 3, 2014

just read this through, very nice.

@marcjansen
Copy link
Member

Let's get this in. Future PRs may add or change content. Thanks for your efforts, @probins

marcjansen added a commit that referenced this pull request Jul 3, 2014
@marcjansen marcjansen merged commit 4fed441 into openlayers:master Jul 3, 2014
@probins probins deleted the intro branch July 3, 2014 19:00
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.

None yet

4 participants