umbraco / UmbracoDocs

The official Umbraco Documentation
https://docs.umbraco.com
MIT License
269 stars 780 forks source link

Config Transforms Doesn't Mention Latch Prefix #1284

Closed Nicholas-Westby closed 5 years ago

Nicholas-Westby commented 5 years ago

This is the page with issues: https://github.com/umbraco/UmbracoDocs/edit/master/Umbraco-Cloud/Set-Up/Config-Transforms/index.md

That page doesn't mention that Umbraco Cloud adds a file called Latch.Web.live.xdt.config by default. Note that it contains a "Latch." prefix. This does not match the format mentioned on the page, which is {config-file name}.{environment}.xdt.config. If it were following that format, the filename would be Web.live.xdt.config.

So now I'm confused, and these questions come to mind:

It would be useful if this page clarified some of these points.

nul800sebastiaan commented 5 years ago

Just follow the documentation, which is clear and correct.

As noted in the Latch.Web.live.xdt.config:

This is the default Umbraco Cloud Latch transform file - It is used to ensure that the live site will be running via https and force redirects from http to https. It does so by setting the "umbracoUseSSL" setting to true, which will tell the Umbraco Backoffice to serve URLs via https and it adds a redirect rule that will force the site to run via https, except for when running localhost.

To disable the forced https, simply remove this file from your repository. This is not advised, as all domains on Umbraco Cloud will be running https, as a certificate will be issued for custom domains by the Latch feature, and all [alias].s1.umbraco.io domains will already be protected.

For more info about how this file is working check: https://our.umbraco.com/documentation/Umbraco-Cloud/Set-Up/Config-Transforms/ Documentation for the redirect rule can be found on our: https://our.umbraco.com/documentation/Umbraco-Cloud/Set-up/Manage-Domains/Rewrites-on-Cloud/#running-your-site-on-https-only

Nicholas-Westby commented 5 years ago

I'm not sure what you mean. The documentation page does not mention the "Latch." prefix at all. It also doesn't mention the mechanism by which this file pattern can work.

Why isn't the file simply called "Web.live.xdt.config", for example? What would happen if both "Latch.Web.live.xdt.config" and "Web.live.xdt.config" were present? The documentation implies the latter should be the case, yet the former is the present file.

Could I also create "WhateverPrefix.Web.live.xdt.config"? There is a lot this documentation does not mention.

nul800sebastiaan commented 5 years ago

It's a special file for our Latch product.

Have you tried following the documentation, which specifies how we expect people to work with config transforms? It mentions you can use development-specific transforms and package-specific transforms.

Nicholas-Westby commented 5 years ago

@nul800sebastiaan I must have missed the section about package-specific transforms. That's my mistake. Thank you for pointing me in the right direction.