search

OfficeDev / microsoft-teams-apps-greatideas

An “innovation challenge” system that lets employees submit and share ideas and insights, with voting and contests. An app using which employees can submit an innovative idea in a selected category to be visible to all colleagues and leadership, ideas can be voted upon and a leader board of best idea contributors can be shared. This app can also be a route to file patent ideas by anyone in an organization.
MIT License
84 stars 35 forks source link

Suggestions for deployment guide clarity #11

Open kriszentner opened 3 years ago

kriszentner commented 3 years ago

Hi Folks,

I've gone through the deployment guide, and have a couple suggestions after going through it from beginning to end:

Step 3, number 10 and 15:

This references api://fully-qualified-domain-name.com/{BotID}, and api://subdomain.example.com:6789/c6c1f32b-5e55-4997-881a-753cc1d563b7/access_as_user

It seems like both of these should just be the Azure Front Door URI (at least this is what I used). Otherwise it's difficult to know where fully-qualified-domain-name.com is coming from. Also the use of the nonstandard port seem to imply something to the user that is not explicit. It would be good to better explain this, or just use the same url of [BaseResourceName].azurefd.net as in the rest of the documentation.

Step 4

This is almost obvious, but it would be good to tell the user to clone the git repo, where they'll find the manifest.json file. This wasn't immediately clear to me.

maxi07 commented 3 years ago

I agree, it's quite hard to follow the instructions. Also, the api://<<applicationurl>>/<<botId>> in the webApplicationInfo section is not present in the current manifest.json build. The current structure in webApplicationInfo 

 "webApplicationInfo": {
    "id": "",
    "resource": ""
  }

is not referenced in your deployment guide and I was not able to get it running.