githubbob42 / mingle2github2

0 stars 1 forks source link

Documentation Web Site #2125

Closed githubbob42 closed 10 years ago

githubbob42 commented 10 years ago

Mingle Card: 2365 We want the Alpine documentation to be easy for customers to access. The documentation needs to be available only for people who have the product installed so it needs to be protected by a SFDC username and password.

The Heroku app is

App URL:

http://fieldfxdocs.herokuapp.com/

Git URL:

git@heroku.com:fieldfxdocs.git 

Analysis

Do we need to keep this restricted based on salesforce credentials. Why not make this public and searchable. 

Why do we need to create and manage our own site. Can't we use a third party tool that specializes in hosting documents and provides a much richer interface.

Ignoring reservations, to simply setup the site would require that we...

1. Create new Repo for Document Site on Github. 

2. Build up a new site using mimosa. Mimosa will auto-generate server side code basic(express js)

Keep it very simple. create a static site.

Look for the app.configure section server.js(in Alpine Mobile) as reference when setting up express js code/configuration. Mainly Login and Logoff.

3. App should pull sforce configuration from heroku/windows environment to use to connect with salesforce. Configure Heroku environment with sforce parameters. 

FORCE_CLIENTID,
FORCE_CLIENTSECRET,
FORCE_REDIRECTURI,
FORCE_APIVERSION,
FORCE_ENVIRONMENT
 

4. Documentation/Content for now will be hosted on heroku site to keep things simple and in the same domain.

5. For now, make a hard coded list of document links on the landing page. Info dev can edit this page and add, delete, or change links.

6. Landing Page should also have a LogOut button.  

7. Deployment should be as simple as pushing up the github repo to heroku, similar to how we push alpine mobile.

githubbob42 commented 10 years ago

Feature: #87 Authentication and Security (Mingle)