Not just in this DNS document but perhaps generally, do we need many reminders to replace a demo-thing (ID, password, domain, whatever is being demonstrated) with a real-thing? It used to seem silly, but after getting many versions of Disqus comments like "that sample doesn't work" and responding with many variations of "that's because you have to put your real credentials there" I've started to think we have to point out the demo-ness of demos much more emphatically.

From: Ruben Orduz <notifications@github.com<mailto:notifications@github.com>>
Reply-To: "rackerlabs/developer.rackspace.com" <reply@reply.github.com<mailto:reply@reply.github.com>>
Date: Monday, June 2, 2014 at 4:13 PM
To: "rackerlabs/developer.rackspace.com" <developer.rackspace.com@noreply.github.com<mailto:developer.rackspace.com@noreply.github.com>>
Cc: Rose Coste <rose.coste@rackspace.com<mailto:rose.coste@rackspace.com>>
Subject: Re: [developer.rackspace.com] incorporate feedback on consistency of SDK Quickstart with API doc (#290)


In src/docs/cloud-dns/getting-started/samples/create_record.rst:

> @@ -5,7 +5,7 @@
>  .. code-block:: javascript
>
>    var recDetails = {
> -    name: 'app.domain.com',
> +    name: 'app.example.com',


My argument is that as a getting started dev, I copy and paste that line, it will throw the exception and I will assume it's the code, not the back end service constraints or IANA stuff. We could add a comment to the narrative explaining that whatever placeholder we end up using, it's a place holder and should be changed to a real domain name as it will not work if ran as-is.

—
Reply to this email directly or view it on GitHub<https://github.com/rackerlabs/developer.rackspace.com/pull/290/files#r13307568>.