Revise Going Live section to be up to date and clearer #472

Crell · 2017-01-21T00:46:31Z

The Going Live page is long, hard to follow, and contains way too much information about SSL for most mortals. Let's fix all of those.

(This is still a WIP; I just wanted a place to store it.)

…too technical for most people.

Crell · 2017-01-23T21:50:27Z

src/configuration/routes.md

+    to: "https://{default}/"
+```
+
+Alternatively, if you define only routes that use HTTPS Platform.sh will automatically create redirects from the HTTP to HTTPS version of each route.


Someone please verify this is the case. @damz @ralt ?

I confirm this ... I tested that before I wrote that

Crell · 2017-01-23T21:51:00Z

src/configuration/routes.md

-to your application properly. However, request to
-`*---add-theme-vmwklxcpbi6zq.eu.platform.sh` will not be routed since it is not
-a legitimate domain name.
+Let's say we have a project on the EU cluster whose ID is "vmwklxcpbi6zq" and we created a branch called "add-theme". The generated apex domain of this environment will be `add-theme-vmwklxcpbi6zq.eu.platform.sh`. If we have a `http://*.{default}/` route defined, the generated route will be `http://*---add-theme-vmwklxcpbi6zq.eu.platform.sh/`. This means you could put any subdomain before the triple dashes to reach your application. HTTP request to both `http://foo---add-theme-vmwklxcpbi6zq.eu.platform.sh/` and `http://bar---add-theme-vmwklxcpbi6zq.eu.platform.sh/` URLs will be routed to your application properly. However, request to `http://*---add-theme-vmwklxcpbi6zq.eu.platform.sh/` will not be routed since it is not a legitimate domain name.


I am torn on whether this belongs in the routing section or the going live section. There's a lot of overlap there, still, which makes me quite uncomfortable. Input welcome.

It's wrong, anyway. The generated route will now include a random string after add-theme...

Updated the paragraph for that change. That still doesn't answer where it goes. 😄

Crell · 2017-01-23T21:59:03Z

src/development/going-live/multi-app.md

@@ -0,0 +1,75 @@
+# Serving multiple applications


This page is still incomplete, pending it being way easier to add multiple domains in the first place. Feedback still welcome but it's likely buggy.

Crell · 2017-01-23T21:59:50Z

src/development/going-live/ssl.md

@@ -0,0 +1,180 @@
+# SSL in Production


I am not sure if this page is needed at all, frankly. Shouldn't most 3rd party SSL providers have their own instructions and generate keys for you? Do we really need this?

There are so many problems with this page. I agree it should be deleted.

Possibly there are tiny bits that could be re-used, like "Use the Platform.sh CLI to add the certificate".

I've removed that page and moved selected sections to the main document. For now I stuck the SSL page into the old directory just in case we ever want that content back.

Crell · 2017-01-23T22:01:35Z

src/development/going-live.md


-Configure your DNS provider to point your domain to your
-[Platform.sh](https://platform.sh) Master environment.
+## Old Stuff, is it relevant?


Anything past here in this page I am not sure if we should keep or reword. My registrar lets me CNAME to foo.com just fine. Also, my read of this section is "you can't actually serve foo.com from us even though all of our documentation says you can, because reasons." Which... seems both incorrect and not a good thing to say. 😄 If kept it would still need to be greatly rewritten.

xtfer · 2017-01-23T22:55:36Z

src/development/going-live.md

-If you want your site to only be available at `http://mydomain.com` and
-have `http://www.mydomain.com` redirect to `http://mydomain.com`, you
-need define your `routes.yaml` as follow:
+The way to do so will vary somewhat depending on your registrar, but nearly all registrars should allow you to set a CNAME.  Some will call it an Alias or similar alternate name, but either way the intent is to say "this domain should always resolve to... this other domain".  Add a CNAME record from your desired domain (`example.com`) to the master environment hostname you wrote down earlier.


I see what you are trying to achieve here in terms of simplicity, however I think this will confuse anyone who actually understands CNAMEs, and their inability to be used on apex records. The instruction to add a CNAME from "example.com", for example, is both misleading and almost impossible. :)

I would suggest an alternative approach where we first provide advice on the apex domain, then on subdomains. Happy to take a shot at that.

Except I did it on my own web site by adding a CNAME for @.garfieldtech.com to www.garfieldtech.com, which in turn CNAMEs to Platform.sh.

Do I simply have a rare non-crappy registrar? 😄

xtfer · 2017-01-23T22:59:36Z

src/development/going-live.md


-### HTTPS
+### Set your domain


This appears to duplicate the Set your domain section, above

This is a 3-rd level section; the previous is 2nd level. The intent is to mirror the section above with a concrete, non-abstract example.

Fix numbered list only

Crell · 2017-01-25T20:49:03Z

I've updated the DNS section to reintegrate the discussion of Apex domains and then removed the rest of the redundant content. I also dropped the multi-domain go-live page for now; it's in another branch to come back to once that's made approachable enough to document.

I consider this now ready for real review, so removing the WIP tag.

OriPekelman

This is approved. By an approver.

mrkschan · 2017-02-07T00:13:30Z

src/development/going-live.md

-a certificate for the root domain, e.g. `example.com`, and expect to
-secure `www.example.com`. The inverse is also true. Each domain can have
-one certificate and it can be attached to the main domain or subdomain.
+However, using an A Record is not possible as the IP address of the server may change from time to time, especially with frequent redeployments as in Platform.sh's case.


I don't get this ... The IP address will be those on our gateways. They are considered stable. And, some DNS provider supports adding multiple 'A' records and load balance them. Customer may consider using this kind of 'A' records when 'CNAME' record is not applicable.

On the other hand, some DNS provider supports HTTP/HTTPS redirect on apex domain. That can be used as well when 'CNAME' is not applicable.

Crell added the WIP label Jan 21, 2017

Crell added 5 commits January 23, 2017 15:47

Move HTTP configuration from Going Live to Routing.

93f3b4f

Break the SSL section of Going Live off to its own page, as it's far …

7df4f6c

…too technical for most people.

Fix broken internal link.

cac7075

Revise Going Live text.

b41b6a5

Minor language cleanup and formatting.

b44dac9

Crell force-pushed the going-live branch from 97f8148 to 354a1a2 Compare January 23, 2017 21:49

Crell commented Jan 23, 2017

View reviewed changes

Crell mentioned this pull request Jan 23, 2017

Review and clarify how to set up a new domain name and DNS records #420

Closed

xtfer reviewed Jan 23, 2017

View reviewed changes

Crell and others added 3 commits January 25, 2017 14:47

Pronoun correction.

89ac313

Update going-live.md

e871830

Fix numbered list only

Merge apex domain information back into main document flow.

4600db5

Crell force-pushed the going-live branch from 85fa2a9 to 4600db5 Compare January 25, 2017 20:47

Crell removed the WIP label Jan 25, 2017

Update for new environment naming.

b963592

Crell mentioned this pull request Jan 30, 2017

URL Mangling has triply dashes #481

Closed

Crell added 3 commits February 1, 2017 11:38

Move selected SSL information into the main Going Live page.

daf7b3e

Remove old SSL page as irrelevant.

20be555

Further clarify apex domains.

7887a69

OriPekelman approved these changes Feb 6, 2017

View reviewed changes

OriPekelman merged commit 874f272 into master Feb 6, 2017

Crell deleted the going-live branch February 6, 2017 19:02

mrkschan reviewed Feb 7, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise Going Live section to be up to date and clearer #472

Revise Going Live section to be up to date and clearer #472

Crell commented Jan 21, 2017

Crell Jan 23, 2017

mrkschan Feb 7, 2017

Crell Jan 23, 2017 •

edited

Loading

pjcdawkins Jan 25, 2017

Crell Jan 27, 2017

Crell Jan 23, 2017

Crell Jan 23, 2017

pjcdawkins Feb 1, 2017

Crell Feb 1, 2017

Crell Jan 23, 2017

xtfer Jan 23, 2017

Crell Jan 24, 2017

xtfer Jan 23, 2017

Crell Jan 24, 2017

Crell commented Jan 25, 2017

OriPekelman left a comment

mrkschan Feb 7, 2017

Revise Going Live section to be up to date and clearer #472

Revise Going Live section to be up to date and clearer #472

Conversation

Crell commented Jan 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Crell Jan 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Crell commented Jan 25, 2017

OriPekelman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Crell Jan 23, 2017 •

edited

Loading