Skip to content
This repository has been archived by the owner on Nov 27, 2018. It is now read-only.

flesh out Oghliner template app #7

Closed
mykmelez opened this issue Sep 22, 2015 · 3 comments
Closed

flesh out Oghliner template app #7

mykmelez opened this issue Sep 22, 2015 · 3 comments
Assignees
Milestone

Comments

@mykmelez
Copy link
Contributor

The built-in Oghliner template app in its app/ subdirectory, which GitHub publishes to https://mozilla.github.io/oghliner/, is too basic. It doesn't contain any images nor CSS files, so there's no guidance about where to put those files in the source directory structure. Nor are there other common files, like favicon.ico or robots.txt.

Nor does it even explain the Oghliner project or point to more info about it. I might not expect that info in a template that gets created by a command-line tool, but I would expect it in a template that is itself published as an app, which is the case here.

By contrast, compare to the app/ subdirectory of the Yeoman gulp-webapp template (mkdir my-app && cd my-app && yo gulp-webapp), which contains:

apple-touch-icon.png
favicon.ico
fonts
images
index.html
robots.txt
scripts
scripts/main.js
styles
styles/main.scss

Or the Angular template (mkdir my-app && cd my-app && yo angular), whose app/ subdirectory has:

404.html
favicon.ico
images
images/yeoman.png
index.html
robots.txt
scripts
scripts/app.js
scripts/controllers
scripts/controllers/about.js
scripts/controllers/main.js
styles
styles/main.scss
views
views/about.html
views/main.html

Or the template built into Ember (npm install -g ember-cli && ember new my-app), whose app/ subdirectory includes:

app.js
index.html
router.js
styles
styles/app.css
templates
templates/application.hbs

We should flesh out the Oghliner template app with a set of files that is more representative of the apps that users are going to build. Also, since the template app is itself published by GitHub as an app, we should include content that is useful to users who browse that site.

Perhaps we can use GitHub's Automatic Page Generator to generate an attractive basic page for the template, per Instantly Beautiful Project Pages. And then add content similar to the content in the README (or a basic description of the project along with a link to the README for further info).

@mykmelez mykmelez modified the milestone: v1 Oct 7, 2015
@marco-c
Copy link
Contributor

marco-c commented Oct 15, 2015

I think this was done in #17, right? @brendandahl

@mykmelez
Copy link
Contributor Author

#17 separated the template from the website for the Oghliner project itself, and it fleshed out the template a bit, so it now includes images and style; but it's still fairly basic. It also uses third-party code under a (permissive, open source) license, whereas we want to release template files to the public domain (per #38). So I think there's still work to do here. (I'd also like to spiffy up the website for the Oghliner project itself, but I'll file that as a separate issue.)

@marco-c
Copy link
Contributor

marco-c commented Nov 4, 2015

Fixed by #130.

@marco-c marco-c closed this as completed Nov 4, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants