dnsimple / addon-github-pages Goto Github PK

Mostly for consistency across connectors (the Heroku add-on does it).

It should simply add a CNAME for the www subdomain pointing to the apex.

If I have the one-click GH pages service enabled on a domain and I switch to this connector, the connector should remove the one-click service.

The client ID and secret should not be on the config/dev.exs file.

Right now if a record (that is not there because of the 1 click service) is present on the root domain, the connection will fail. The same thing will happen with the wwwsubdomain once we start adding the CNAME record.

We have to decide what to do about it.

Right now create and delete are supported, but updating a connection (for example, changing the domain pointing at a repo) are not.

For now the app is using one I've set up under my own GitHub account. We should use one owned by DNSimple.

Discussing the addon UX with @sbastn we talked about how the experience should be given that we are handling a file on behalf of the customer. There are two scenarios:

• The customer doesn't have a CNAME file, so we create it.
• The customer has a CNAME file, so we modify it.

We agreed that we should show the contents of the CNAME file before overwriting it (because we don't want to overwrite a file without warning).

My plan is to add a confirmation step before actually creating the connection when we detect there is a CNAME file in the user's repo. This step will display the current content and the future content as if it were a GitHub diff (@sbastn's words).

If a domain already has a connection you should be editing that one instead of creating a new one.

For now the app is using one I've set up under my own DNSimple account. We should use one owned by DNSimple once the app is ready for the public.

Because CI rules...

The preferred method for error handling in Elixir is with tuples, not try/catch blocks.

For example, https://github.com/dnsimple/addon-connector-ghpages/blob/master/web/controllers/connection_controller.ex#L40 would be replaced with a case statement that checks for either {:ok, data} or {:error, reason}.

More details on this may be found here: http://elixir-lang.org/getting-started/try-catch-and-rescue.html