MCLOUD-6977: Update documentation about routes #7912

NadiyaS · 2020-09-22T18:18:25Z

Purpose of this pull request

Fixes #7444 .
Updates the Configure routes topic to clarify configuration for HTTP and HTTPS requests and improve examples.

Affected DevDocs pages

https://devdocs.magento.com/cloud/project/routes.html

devops-devdocs · 2020-09-22T18:19:02Z

An admin must run tests on this PR before it can be merged.

src/cloud/project/routes.md

Co-authored-by: Margaret Eker <[email protected]>

meker12 · 2020-09-22T21:20:15Z

src/cloud/project/routes.md

+   {:.no-copy}
+
+- If the configuration specifies only the HTTPS route, then all HTTP requests redirect to HTTPS.
+For example, for the default domain `example.com`, the route `https://{default}/` resolves to URL `https://example.com/` and redirect `http://example.com/` to `https://example.com/`.


Suggested change

For example, for the default domain `example.com`, the route `https://{default}/` resolves to URL `https://example.com/` and redirect `http://example.com/` to `https://example.com/`.

For example, for the default domain `example.com`, the route `https://{default}/` resolves to URL `https://example.com/` and redirects `http://example.com/` to `https://example.com/`.

src/cloud/project/routes.md

Co-authored-by: Margaret Eker <[email protected]>

… MCLOUD-6977

BarnyShergold

As this is complex I decided to read the majority in the file to get a proper view. Most looks ok but there is a passage that wasn't changed but indicates something different from reality.

{{site.data.var.ee}} also generates routes for every active Integration environment. For Integration environments, {default} is replaced with the following domain name:

[branch]-[project-id].[region].magentosite.cloud
{:.no-copy}

For example, the refactorcss branch for the mswy7hzcuhcjw project hosted in the us cluster has the following the domains:

http://www-refactorcss-mswy7hzcuhcjw.us.magentosite.cloud/

https://refactorcss-mswy7hzcuhcjw.us.magentosite.cloud/blog

Two projects checked show that the Integration domain seems to actually be formed thus :
[branch]-[random string]-[project-id].[region].magentosite.cloud

EG on our sandbox account -
https://barnyshergold-ym3j7iq-z3ek236yy2yv2.eu-4.magentosite.cloud/
https://pwastudio-7mqr7yq-z3ek236yy2yv2.eu-4.magentosite.cloud/
https://integration-5ojmyuq-z3ek236yy2yv2.eu-4.magentosite.cloud/

Other checked projects reflect the same - the second section has no pattern but exists. Can an explanation be included in the documentation?

src/cloud/project/routes.md

meker12 · 2020-09-22T22:40:38Z

src/cloud/project/routes.md

@@ -120,11 +145,11 @@ The following sample route does not redirect from the `www` to the apex domain;
 ```yaml
 "http://{default}/":


Add Example 2: line to label the second example.

Change explanatory text to

"In the following example, the route configuration does not redirect URLs from the www domain to the apex domain. Instead, requests are served from both the www and apex domain."

meker12 · 2020-09-22T22:44:39Z

src/cloud/project/routes.md

+
+- If the configuration specifies only the HTTPS route, then all HTTP requests redirect to HTTPS. For example, for the default domain `example.com`, the route `https://{default}/` resolves to URL `https://example.com/` and redirects `http://example.com/` to `https://example.com/`.
+
+What is similar to


As discussed, the phrase "What is similar to" and example can be deleted as the preceding bullet point explains the concept.

Co-authored-by: Margaret Eker <[email protected]>

Co-authored-by: Barny Shergold <[email protected]>

NadiyaS · 2020-09-23T16:09:27Z

Hi @BarnyShergold ,
Thanks for that notice.
I changed the pattern.

src/cloud/project/routes.md

Co-authored-by: Margaret Eker <[email protected]>

src/cloud/project/routes.md

# Conflicts: # src/cloud/project/routes.md

BarnyShergold

All good for me - just @meker12 's change needed

Co-authored-by: Margaret Eker <[email protected]>

ghost · 2020-09-23T17:16:53Z

Hi @NadiyaS, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

* MCLOUD-6977: Update documentation about routes * Update src/cloud/project/routes.md Co-authored-by: Margaret Eker <[email protected]> Co-authored-by: Barny Shergold <[email protected]> Co-authored-by: Nadiya Syvokonenko <[email protected]>

* Update prereq-overview.md * Update prereq-overview.md Reword following review * Update prereq-overview.md Clarify MySQL version for 2.4 * Update prereq-overview.md Version fix * Update src/guides/v2.3/install-gde/prereq/prereq-overview.md Suggested change Co-authored-by: Barny Shergold <[email protected]> * Update src/guides/v2.4/install-gde/prereq/prereq-overview.md Suggested change Co-authored-by: Barny Shergold <[email protected]> * Update contributing.md * Static fixes * Fixed MD formatting * Update ui-columnscontrols.md <setting> is Invalid XML tag, correct tag is <settings> * Fix return for extractAdjustment * Update src/guides/v2.3/extension-dev-guide/price-adjustments.md Co-authored-by: Yaroslav Rogoza <[email protected]> * Capitalize MySQL * Capitalize MySQL * Added Sequence Load information * Update message-queues-stores.md Remote Warning for required patch * Fix missing "\" in new implementation example * Fix broken link (#7915) * formatting change * Editorial/elastic variable (#7919) * Update Additional search configuration section * Grammar update * Update src/cloud/project/services-elastic.md Co-authored-by: Barny Shergold <[email protected]> Co-authored-by: Donald Booth <[email protected]> Co-authored-by: Margaret Eker <[email protected]> * Grammar and formatting * I linted myself. * typo * Usage examples are added * Markdown fixes * MCLOUD-6977: Update documentation about routes (#7912) (#7927) * MCLOUD-6977: Update documentation about routes * Update src/cloud/project/routes.md Co-authored-by: Margaret Eker <[email protected]> Co-authored-by: Barny Shergold <[email protected]> Co-authored-by: Nadiya Syvokonenko <[email protected]> * [WIP] Added Slave Database Connection Information (#7924) * Added Slave Database Connection Information * Update src/cloud/project/services-mysql.md * Update services-mysql.md Co-authored-by: Barny Shergold <[email protected]> Co-authored-by: Margaret Eker <[email protected]> * (maintenance) Add init to build:stage (#7941) * Add init to build:stage Required for new CI/CD staging * Fix syntax * Improving the create a new page layout topic * Update project-routes-more-redir.md Removed extra curly brace * Grammar and formatting * Update GraphQL index page Co-authored-by: DominicWatts <[email protected]> Co-authored-by: Barny Shergold <[email protected]> Co-authored-by: Stanislav Idolov <[email protected]> Co-authored-by: Jeff Matthews <[email protected]> Co-authored-by: Keyur Shah <[email protected]> Co-authored-by: Iftakharul Alam <[email protected]> Co-authored-by: Yaroslav Rogoza <[email protected]> Co-authored-by: Donald Booth <[email protected]> Co-authored-by: Barny Shergold <[email protected]> Co-authored-by: Lyzun Oleksandr <[email protected]> Co-authored-by: Brett P <[email protected]> Co-authored-by: Margaret Eker <[email protected]> Co-authored-by: hguthrie <[email protected]> Co-authored-by: Kevin Harper <[email protected]> Co-authored-by: Nadiya Syvokonenko <[email protected]> Co-authored-by: Dmitry Shevtsov <[email protected]> Co-authored-by: eduard13 <[email protected]> Co-authored-by: Kevin Harper <[email protected]>

* MCLOUD-6977: Update documentation about routes (#7912) * Update src/cloud/project/routes.md * Update project-routes-more-redir.md Removed extra curly brace * Update src/cloud/project/routes.md - Moved description for Example 1 in Simple routes section to correct location * Additional cleanup and corrections - Cleaned up formatting and presentation of examples to improve readability - Corrected the command and example for routing a non-mapped domain Co-authored-by: hguthrie <[email protected]> Co-authored-by: Nadiya Syvokonenko <[email protected]>

MCLOUD-6977: Update documentation about routes

3a4e253

meker12 self-requested a review September 22, 2020 18:44

meker12 suggested changes Sep 22, 2020

View reviewed changes

m2-community-project bot assigned meker12 Sep 22, 2020

m2-community-project bot added the Progress: changes requested label Sep 22, 2020

meker12 added Internal Dev Differentiates work between community and Magento staff 2.x Technical Updates to the code or processes that alter the technical content of the doc labels Sep 22, 2020

NadiyaS and others added 5 commits September 22, 2020 14:25

Update src/cloud/project/routes.md

31b38a5

Co-authored-by: Margaret Eker <[email protected]>

Update src/cloud/project/routes.md

2b221d7

Co-authored-by: Margaret Eker <[email protected]>

Update src/cloud/project/routes.md

66c41fc

Co-authored-by: Margaret Eker <[email protected]>

Update src/cloud/project/routes.md

01ec89b

Co-authored-by: Margaret Eker <[email protected]>

Update src/cloud/project/routes.md

8beaee0

Co-authored-by: Margaret Eker <[email protected]>

meker12 requested a review from BarnyShergold September 22, 2020 19:28

NadiyaS added 3 commits September 22, 2020 16:09

MCLOUD-6977: Update documentation about routes

cc1dff4

MCLOUD-6977: Update documentation about routes

f59167b

MCLOUD-6977: Update documentation about routes

4d7679d

meker12 reviewed Sep 22, 2020

View reviewed changes

src/cloud/project/routes.md Outdated Show resolved Hide resolved

NadiyaS and others added 3 commits September 22, 2020 16:21

Update src/cloud/project/routes.md

64cd5eb

Co-authored-by: Margaret Eker <[email protected]>

MCLOUD-6977: Update documentation about routes

f68c0f3

Merge branch 'MCLOUD-6977' of github.com:magento-thunder/devdocs into…

c5a9114

… MCLOUD-6977

BarnyShergold suggested changes Sep 22, 2020

View reviewed changes

src/cloud/project/routes.md Outdated Show resolved Hide resolved

m2-community-project bot assigned BarnyShergold Sep 22, 2020

meker12 suggested changes Sep 22, 2020

View reviewed changes

meker12 reviewed Sep 22, 2020

View reviewed changes

NadiyaS and others added 3 commits September 23, 2020 10:12

Update src/cloud/project/routes.md

1d65957

Co-authored-by: Margaret Eker <[email protected]>

Update src/cloud/project/routes.md

f26e31a

Co-authored-by: Margaret Eker <[email protected]>

Update src/cloud/project/routes.md

34775e7

Co-authored-by: Barny Shergold <[email protected]>

NadiyaS added 3 commits September 23, 2020 10:37

MCLOUD-6977: Update documentation about routes

99992d2

MCLOUD-6977: Update documentation about routes

b59a1f2

MCLOUD-6977: Update documentation about routes

c4fd8ee

m2-community-project bot assigned NadiyaS Sep 23, 2020

m2-community-project bot added Progress: review and removed Progress: changes requested labels Sep 23, 2020

meker12 reviewed Sep 23, 2020

View reviewed changes

src/cloud/project/routes.md Outdated Show resolved Hide resolved

Update src/cloud/project/routes.md

90e63a4

Co-authored-by: Margaret Eker <[email protected]>

meker12 reviewed Sep 23, 2020

View reviewed changes

src/cloud/project/routes.md Outdated Show resolved Hide resolved

NadiyaS added 2 commits September 23, 2020 11:47

MCLOUD-6977: Update documentation about routes

c9cf294

Merge remote-tracking branch 'thunder/MCLOUD-6977' into MCLOUD-6977

a437283

# Conflicts: # src/cloud/project/routes.md

meker12 self-requested a review September 23, 2020 16:51

meker12 approved these changes Sep 23, 2020

View reviewed changes

meker12 requested a review from BarnyShergold September 23, 2020 16:59

BarnyShergold approved these changes Sep 23, 2020

View reviewed changes

m2-community-project bot added Progress: approved and removed Progress: review labels Sep 23, 2020

Update src/cloud/project/routes.md

5d75dd8

Co-authored-by: Margaret Eker <[email protected]>

meker12 changed the base branch from master to integrate-routes-pr September 23, 2020 17:16

meker12 merged commit e4b7b9d into magento:integrate-routes-pr Sep 23, 2020

m2-community-project bot removed the Progress: approved label Sep 23, 2020

meker12 mentioned this pull request Sep 23, 2020

MCLOUD-6977: Update documentation about routes (#7912) #7927

Merged

	For example, for the default domain `example.com`, the route `https://{default}/` resolves to URL `https://example.com/` and redirect `http://example.com/` to `https://example.com/`.
	For example, for the default domain `example.com`, the route `https://{default}/` resolves to URL `https://example.com/` and redirects `http://example.com/` to `https://example.com/`.

		@@ -120,11 +145,11 @@ The following sample route does not redirect from the `www` to the apex domain;
		```yaml
		"http://{default}/":


		- If the configuration specifies only the HTTPS route, then all HTTP requests redirect to HTTPS. For example, for the default domain `example.com`, the route `https://{default}/` resolves to URL `https://example.com/` and redirects `http://example.com/` to `https://example.com/`.

		What is similar to

MCLOUD-6977: Update documentation about routes #7912

MCLOUD-6977: Update documentation about routes #7912

Uh oh!

Conversation

NadiyaS commented Sep 22, 2020 • edited by meker12 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of this pull request

Affected DevDocs pages

Uh oh!

devops-devdocs commented Sep 22, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

meker12 Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BarnyShergold left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

meker12 Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

NadiyaS Sep 23, 2020

Choose a reason for hiding this comment

Uh oh!

meker12 Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

NadiyaS Sep 23, 2020

Choose a reason for hiding this comment

Uh oh!

NadiyaS commented Sep 23, 2020

Uh oh!

Uh oh!

Uh oh!

BarnyShergold left a comment

Choose a reason for hiding this comment

Uh oh!

ghost commented Sep 23, 2020

Uh oh!

Uh oh!

NadiyaS commented Sep 22, 2020 •

edited by meker12

Loading