gee-contrib / gee-wiki Goto Github PK

I have been thinking about the documentation/tutorial platform. We originally thought we should just start out from a default GitHub Wiki so that collaboration could happen in traditional git style and new changes/content would auto-render.

However, there is a strange forking and rebinding process when trying to collaborate on a GitHub Wiki, and it also does not look very good.

I found a really good solution, I think. It is a Jekyll documentation theme that integrates with GitHub Pages, so is built from simple markdown and auto-renders whatever content is currently in the master branch of the repo. The theme has really handy sidenav and toc features. There is a little bit of work to set up the initial nav structure, but then can be easily added to. Content can be added and altered with pull requests.

• The Jekyll theme is here: https://pmarsceill.github.io/just-the-docs/
• I mocked up a doc page using it here: https://gee-community.github.io/GEE-Dev-Docs/
• The mocked up repo is here: https://github.com/gee-community/GEE-Dev-Docs

I think this is easier and looks better than the GitHub Wiki - it maybe does not have all the features of a more robust framework, but I think simplicity is paramount, and we get pretty much everything we need in markdown and some of the basic features of the Jekyll theme.

I can provide an example application of running LandTrendr to identify forest disturbance. The results of which will be displayed in the map and optionally exported to Google Drive

Maybe a list of "How to", for very standard question, that are coming again and again. For each, the N typical solutions, and when to use each of them.

I see it in a very short format : question ==> answer, not deep discussion that is maybe more reserved for more complete tutorials

I can provide an example of generating a segmented Landsat spectral times. The result is a time series free of inter-annual noise - useful for consistent predictive mapping through time when used as a model variable - a forest class is not likely to bounce between high structure mature and low structure mature because of minor differences in atmosphere and other image artifacts from year-to-year.