Scrub github wiki

[pjcozzi]

No description provided.

[pjcozzi]

Areas most in need of updates:

• Architecture
• CZML in Cesium
• Creating Custom Geometry and Appearances (future tutorial)
• JavaScript Coding Conventions- should be pretty concise and point to actual code examples
• Documentation Best Practices - should just point to a few representative examples in Cesium

[pjcozzi]

Pushing.

[nmschulte-aviture]

@pjcozzi, in looking to spin up on changes since the late beta days (b28 / 30 or so), I turned to the developers wiki, and noticed the out of date comment and this issue:

This is now out-of-date. There will be a new version as part of #1683.

Should I be ignoring the whole page, or just taking it all with the understanding that some bits have shifted concerns, etc.? What's the status of the new page? Thanks!

[pjcozzi]

A lot has changed since the beta. The wiki is still out of date. See http://cesiumjs.org/tutorials.html

Also, see the blog post for each release for the highlights. See CHANGES.md for all the details.

[nmschulte-aviture]

The Graphics Tech in Cesium blog posts have been very helpful; thank you!

http://cesiumjs.org/2015/05/26/Graphics-Tech-in-Cesium-Stack/
http://cesiumjs.org/2015/05/15/Graphics-Tech-in-Cesium-Architecture/
http://cesiumjs.org/2015/05/14/Graphics-Tech-in-Cesium/

[rutsky]

Regarding Coding Conventions:

1. Coding conventions for GLSL shaders are missing. Currently used style is not consistent with used JS style (e.g. curly brace in JS always on the same line as preceding expression, but in GLSL opening curly brace after main() usually on separate line, and after if () from time to time on same line, or on next line).
2. Coding convention says nothing about trailing spaces. @pjcozzi said in replace tabs with spaces in GLSL files #3029, that they are forbidden, but this is not constrained anywhere (I think jshint should check them).

[pjcozzi]

@rutsky you may be interested in #3312.

[rutsky]

Thanks, @pjcozzi, I see that #3312 covers mentioned by me issues.

[zwcloud]

So... where is Creating Custom Geometry and Appearances (future tutorial) after 3 years?

[ggetz]

Hi @zwcloud, we don't have this new tutorial yet, but we've definitely noticed a lot of people asking for more documentation regrading this. We have plans to create one within the next month or so, so keep an eye out.

[hpinkos]

@zwcloud the content of this tutorial is mostly still accurate, just some of the code examples need to be updated https://github.com/AnalyticalGraphicsInc/cesium/wiki/Geometry-and-Appearances

[zwcloud]

Actually I have already created one myself by guessing and digging into the source code of Cesium. See this gist.

a related discussion in the forum

[zwcloud]

@ggetz @hpinkos

We have plans to create one within the next month or so, so keep an eye out.

It is about Two months later, where is the new tutorial?

[ggetz]

Hi @zwcloud, the Cesium team has a lot of projects going on right now, and plans can change fast.

It's good to hear your excited for the tutorial, maybe you could help by researching and contributing some content yourself?

[sanjeetsuhag]

Revisiting this now, I parsed through the existing wiki and here's my recommendations for what to keep/move/remove:

Check into repository

• Offline Guide
• Fabric
• Geometry and Appearances (possibly transition to website)
• heightmap 1.0 spec (move to somewhere - not sure where)
• heightmap 1.0 terrain spec (move to somewhere - not sure where)
• Mobile Details (needs update)
• Release Guide
• Feature Checklist (possible migrate to new README?)

To Review/Delete:

• Architecture
• Cesium Logos (moved to website)
• CZML Content (moved to czml-writer)
• CZML History visualization details (roadmap)
• CZML Guide (moved to czml-writer)
• CZML in Cesium (out of date guide)
• CZML Structure (moved to czml-writer)
• Data Driven Renderer (old roadmap)
• Doc Sprint Ideas
• ESA Summer of Code (out of date)
• External Links
• Google Summer of Code (out of date)
• Google Summer of Code 2015 (out of date)
• JavaScript Coding Conventions (moved to repo)
• Maki Icon Generation (update or delete?)
• Material System Details (roadmap)
• Ocean Details (roadmap)
• Particle System Details (roadmap)
• Roadmap
• Screen Space Rendering Details (roadmap)
• Shortened URls
• Space Features (roadmap)
• Tutorials Details (roadmap)
• Visual Quality and Performance Details (roadmap)

[ggetz]

Thanks @sanjeetsuhag! The Feature Checklist is import for potential customers evaluating CesiumJS and should definitely continue to live somewhere. At one point this was on the website, but could make sense in the Documentation directory.

Setting aside the outdated roadmaps, there is a good deal of information here. Would you recommend any of these can be updated and become a blog post or tutorial instead? For example Architecture (in the same vein as the Renderer Architecture post?

[sanjeetsuhag]

@ggetz The existing architecture wiki page tackles the broader engine architecture and we could potentially write a blog about that - or check it into the repo and have it serve as a good on-ramping doc for new devs.

[ggetz]

Just to be clear here-- Feel free to leave ideas, but let's plan on holding off on deleting anything for now and only focus on what can be moved into the repo itself.