Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Added Note for 404 error regarding /robots.txt files #5255

Merged
merged 8 commits into from
Aug 23, 2019

Conversation

hickskenh
Copy link
Contributor

Purpose of this pull request

This pull request (PR) adds a note regarding /robots.txt errors telling users to open a Support ticket.

Affected DevDocs pages

fixes #5237

If the `<domain.your.project>/robots.txt` file generates a `404 error`, [submit a Support ticket](https://support.magento.com/hc/en-us/articles/360019088251-Submit-a-support-ticket) to change the redirect from `/robots.txt` to `/media/robots.txt`.
@hickskenh hickskenh added Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies Internal Dev Differentiates work between community and Magento staff 2.3.x Magento 2.3 related changes labels Aug 22, 2019
@hickskenh hickskenh self-assigned this Aug 22, 2019
#### To generate a `sitemap.xml` file in version 2.2 and later

1. Access the Magento Admin panel.
1. On the _Marketing_ menu, click **Site Map** in the _SEO & Search_ section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume italicizing UI areas you don't click on is a cloud style thing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when doing a search for "menu,", i found other references to menus (Marketing x3, Extension x2, Content x2, Account x2). Marketing and Content have the ital formatting, Account and Extension do not.

Copy link
Contributor

@meker12 meker12 Aug 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the style in Cloud, but I know that it is not consistently applied. In this topic, it is consistent. I think that it is potentially confusing not to have any formatting on UI element titles that are mentioned in the text of a procedure step.

Looking at our style guide, it seems that the only formatting we apply to UI elements is bold. When I first started, I remember reading about using italics to reference UI element names, but I don't see that anywhere now.

Checking out the Google style guide, they bold all UI element mentions whether they are referenced by title, or referenced as a clickable element. https://developers.google.com/style/ui-elements

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There has been much discussion about what to do here. It's ongoing... I just wish we were consisten across repos/doc sets!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leaving menu titles in ital for this topic

- **Filename**:`sitemap.xml`
- **Path**:`/media/`
1. Click **Save & Generate**. The new site map becomes available in the _Site Map_ grid.
1. Click the path in the `Link for Google` column.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this in backticks, but other UI areas are in italics?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in a search for " column", i found instances where the name of a column is in `s, in bold, and with no formatting.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aiming for consistency within a topic, the other column names in the procedure are in italics.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing Link for Google column name to ital.

@hickskenh
Copy link
Contributor Author

running tests

@hickskenh hickskenh merged commit 3cbe191 into master Aug 23, 2019
@ghost
Copy link

ghost commented Aug 23, 2019

Hi @hickskenh, 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.

@hickskenh hickskenh deleted the ken-gh5237-robot-errors branch August 23, 2019 19:11
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.3.x Magento 2.3 related changes Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies Internal Dev Differentiates work between community and Magento staff
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contact support when robots.txt 404s
4 participants