docpad integration

[nkhine]

Chapter Static Site Generator

One of the many goals of the ZMGC is to enable chapters to easily setup an on-line presence.

Procedure

1. Once a user has been made a Chapter Co-Ordinator either the the Global or National level, they will get a new button called Create Chapter similar to https://github.com/mikeumus/docpad-instance-spawn/blob/master/docpad-instance-spawn.js
2. On clicking this, the application will use https://github.com/ajaxorg/node-github to first check if the user has a GitHub account - if not it will create one. a. Create an Organisation b. Create a repository in this Organisation to store the web site. d. A CNAME form will be displayed requesting the user to add a domain.tld e. The app, will verify if this has been setup as per https://help.github.com/articles/setting-up-a-custom-domain-with-pages#setting-up-dns - if not display instructions.
3. Compile the latest template code and push this to the gh-branch for the website repository.
4. Github usually sends an email once the site has been built successfully to the user's account - maybe it is possible to intercept this and display it in the result.

   Milestones

   • Wireframes
   • Template design and development
   • DocPad integration - https://github.com/cauld/docpad-collections-editor
   • Node-Github API
   • index/search content - provide interface - maybe integrate lunr.js although DocPad has a built in.
   • Authentication- access back to the admin interface in the main zmgc.net site for the user - look at https://github.com/docpad/docpad-plugin-authenticate and http://browserver.org/

[mikeumus]

Hey @nkhine, we're looking into this now.

[mikeumus]

So it seems at this time that the GitHub API cannot create users or organizations. We may direct users at this point in the interaction to go to github.com and secure a username and org, or just the username and then make their chapter a branch from the main org's repo.

[nkhine]

i would go the route of creating a chapter as part of the main organisation and just either request the user to login using the GitHub federated login or create an account on github.

[ofShard]

So if I'm understanding correctly, the flow would go something like this?

• Authenticate app with a Github user w/ ZMGC organization owner permissions.
• User clicks "Create Chapter", fills in name of team/chapter/repo, domain, etc.
• Using Github API:
  • create new Team
  • add user's Github account to team.
  • create new Repo
  • push skeleton to master branch (include CNAME)
  • compile (or use precompiled) skeleton.
  • push compiled html to gh-pages branch
• Add site to ZMGC's DB.

Any editor would then be hosted on and accessed from the ZMGC site (which seems to be down).

[nkhine]

that is correct

for the site, i have an issue with the domain provider so for now it is hosted at http://serene-depths-3284.herokuapp.com - i have not updated the Federated Login so this would not work.