Needs clearer documentation

[ALydiard]

First off, I'm glad this was released as it will definitely help out with local development/debugging of services that need to utilize the Azure Service Bus without relying on an external cloud dependency and I sincerely am grateful for it being released.

However, there's some murky details within the existing documentation that make utilizing this much more difficult than it probably should be, and below are just some of the things I've noticed:

• No indication of what SAS_KEY_VALUE is or where it comes from (Is it the literal string of SAS_KEY_VALUE?)
• README.md links to a missing file (as noted in #13)
• Min/Max values for properties don't seem to be defined any where obvious where one might try looking initially (this is subjective, but I would imagine a documentation page or notes in the README.md would be a good place to indicate this), the only way I currently discovered the limitations was by parsing through the docker compose logs.
  • To that note, probably at-least a quick explanation of each setting would appreciated
• No troubleshooting information (yes I know There is no official support provided for Emulator) having at-least a few common things that maybe the development team encountered while testing might be helpful (e.g, if you're getting an error of No connection could be made because the target machine actively refused it. ErrorCode: ConnectionRefused, make sure the emulator is running and didn't crash and that the firewall isn't blocking the port if you're running this on an external machine))

I understand that the release literally just dropped today and will likely have improvements as time goes on, but I've combed over what information this is, and still having no luck getting connected to the emulator.

[tombiddulph]

FWIW I've got the emulator running sucessfuly on my Mac by folowing the steps in the readme, I haven't had to any extra configuration. The sql container failed to start the first time but I reran without issue.

Regarding your first point, I used the first connection string in the readme with the literal SAS_KEY_VALUE in it, eg Endpoint=sb://localhost;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true"

[krishankumar95]

@tombiddulph : SQL container crashing on Mac relates to an open issue at docker. Recycling the containers few times is one way out, there are other workaround available on the issue.

[krishankumar95]

@ALydiard Thanks for highlighting the gaps.

1. SAS_KEY_VALUE itself is the intended value. We generally expect the user to copy paste the connection string from the docs. But I do get the confusion here. We will probably add a note under the connection string section.

2. This has been fixed.

3. We have added a schema for the user specified .json config that describes the config and the limits : User Config Schema

Tagging @Saglodha for further comments on point 4 and any of previous points.