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

Landing Page Summarizing the Demo Apps #93

Open
bradley-holt opened this issue Sep 15, 2017 · 11 comments
Open

Landing Page Summarizing the Demo Apps #93

bradley-holt opened this issue Sep 15, 2017 · 11 comments
Assignees
Labels
Milestone

Comments

@bradley-holt
Copy link
Contributor

bradley-holt commented Sep 15, 2017

We should create a landing page to aggregate these different demo apps, somewhat similar to:
https://hnpwa.com/

This should be created as a GitHub pages website using a gh-pages branch of the main shopping-list repo (which would place the URL for this at http://ibm-watson-data-lab.github.io/shopping-list/). For each implementation we should capture (at a minimum):

  • The name of the stack it was built on (e.g. "Vue.js and PouchDB")
  • Link to the GitHub repo
  • More detailed stack information
  • A link to view the live app
  • Author(s)

Much of this info is already in the README file, but we can make this information more digestable on a landing page.

@bradley-holt bradley-holt added this to the Sprint 01 milestone Sep 15, 2017
@ptitzler ptitzler self-assigned this Sep 26, 2017
@ptitzler ptitzler added the Epic label Sep 26, 2017
@ptitzler
Copy link
Contributor

ptitzler commented Sep 26, 2017

According to the documentation https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/ we cannot use a branch other than master:

If your site is a User or Organization Page that has a repository named .github.io or .github.io, you cannot publish your site's source files from different locations. User and Organization Pages that have this type of repository name are only published from the master branch.

Oddly enough this does work.

@isc-rsingh
Copy link
Member

isc-rsingh commented Sep 27, 2017

I think you're misunderstanding the docs @ptitzler (I went back over it multiple times too). They mean if your repo name is something.github.io, it has to use the master branch for GH publication. This repo's name is shopping-list so that rule doesn't apply.

@bradley-holt
Copy link
Contributor Author

@ptitzler What @rajrsingh said. 😄

You should be able to create new orphan gh-pages branch with something like the following:

git checkout --orphan gh-pages
git rm -rf .
touch index.html
git add index.html
git commit -m "Make index"
git push -u origin gh-pages

@ptitzler
Copy link
Contributor

Yup, my interpretation wasn't correct. I tested this in my own org.

@ptitzler
Copy link
Contributor

ptitzler commented Sep 28, 2017

Catalogued the following demo app implementations:

Each entry is backed by a metadata file in https://github.com/ibm-watson-data-lab/shopping-list/tree/gh-pages/_how_tos. The structure of each metadata file is as shown in the following example:

---
title:      Cordova and PouchDB
headline:   Learn how to build an Offline First shopping list demo app using <a href="http://cordova.apache.org">Cordova</a> and <a href="https://pouchdb.com">PouchDB</a>
repo_url:   https://github.com/ibm-watson-data-lab/shopping-list-cordova-pouchdb
tutorial_url:   
demo_url: 
type: Hybrid Mobile App
author:     Glynn Bird
author_url: https://github.com/glynnbird
---

The title, headline, repo_url, author and author_url properties are required.
The following type values are considered valid: Progressive Web App, Native Mobile App, Hybrid Mobile App and Desktop App. (case matters!)

To add another demo app simply create a new metadata file in https://github.com/ibm-watson-data-lab/shopping-list/tree/gh-pages/_how_tos, using the following naming convention: <app_framework>_<offline_framework>.

@isc-rsingh
Copy link
Member

@ptitzler can PWAs be the first/default tab on the page?

@bradley-holt
Copy link
Contributor Author

@ptitzler Following on the comment from @rajrsingh, the ideal tab order would be:

  1. Progressive Web Apps
  2. Hybrid Mobile Apps
  3. Native Mobile Apps
  4. Desktop Apps

@ptitzler
Copy link
Contributor

@vabarbosa
Copy link
Member

@ptitzler
Copy link
Contributor

ptitzler commented Oct 4, 2017

Metadata was added @vabarbosa

@vabarbosa
Copy link
Member

@bradley-holt bradley-holt modified the milestones: Sprint 01, Sprint 02 Jan 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants