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

magento/devdocs#6337: Editorial. Replace mdash HTML special char. #6351

Merged
merged 2 commits into from
Jan 8, 2020
Merged

magento/devdocs#6337: Editorial. Replace mdash HTML special char. #6351

merged 2 commits into from
Jan 8, 2020

Conversation

atwixfirster
Copy link
Contributor

@atwixfirster atwixfirster commented Jan 7, 2020 •
edited by dobooth
Loading

Purpose of this pull request

This pull request (PR) fixes #6337.

@devops-devdocs
Copy link
Collaborator

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

1 similar comment
@devops-devdocs
Copy link
Collaborator

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

@atwixfirster atwixfirster mentioned this pull request Jan 7, 2020
Closed
@keharper
Copy link
Contributor

keharper commented Jan 7, 2020

@atwixfirster
We have stopped accepting changes to the v2.2 directory, so those changes have to be backed out.

Also, I built your branch to see if the --- syntax works in all instances. It does not The m-dashes need to remain as they were when they are in the frontmatter of a topic. For example: line 3 in src/guides/v2.3/config-guide/log/log-db.md

The substitution works as expected in regular text, links, and tables.

@atwixfirster
Copy link
Contributor Author

atwixfirster commented Jan 8, 2020 •
edited
Loading

We have stopped accepting changes to the v2.2 directory, so those changes have to be backed out.

reverted

Also, I built your branch to see if the --- syntax works in all instances. It does not The m-dashes need to remain as they were when they are in the frontmatter of a topic. For example: line 3 in src/guides/v2.3/config-guide/log/log-db.md

I've used titles from src/_data/toc/configuration-guide.yml, src/_data/toc/installation-guide.yml for the next ones:

  • src/guides/v2.3/config-guide/log/log-db.md
  • src/guides/v2.3/config-guide/multi-site/ms_apache.md
  • src/guides/v2.3/config-guide/multi-site/ms_nginx.md
  • src/guides/v2.3/install-gde/install/legacy-file-system-perms.md
  • src/guides/v2.3/install-gde/install/cli/dev_options.md

@dobooth dobooth requested a review from keharper January 8, 2020 17:27
shrielenee
shrielenee suggested changes Jan 8, 2020
View reviewed changes
Copy link
Contributor

@shrielenee shrielenee left a comment

Choose a reason for hiding this comment

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

Revert all changes to titles in the front matter back to their original, including the —. All other changes are relevant.

If you want to create another issue/PR addressing the title naming, like changing "Tutorial—Set up multiple websites with Apache" to "Set up multiple websites with Apache" or "Set up multiple websites with Apache tutorial", that will be a separate issue/PR.

@keharper Please also do a comprehensive review and submit any other comments/recommendations.

keharper
keharper suggested changes Jan 8, 2020
View reviewed changes
src/_includes/install/file-system-perms-before.md
@@ -5,7 +5,7 @@ This topic discusses how to set read-write permissions for the web server group
The procedure you use is different, depending on whether you use [shared hosting](#perms-shared) and have one user or if you use a [private server](#perms-private) and have two users.

{:.bs-callout-info}
If you're using a Magento version*earlier than* 2.0.6, see [Appendix—Magento file system ownership and appendix (legacy)]({{ page.baseurl }}/install-gde/install/legacy-file-system-perms.html) instead.
If you're using a Magento version*earlier than* 2.0.6, see [Appendix---Magento file system ownership and appendix (legacy)]({{ page.baseurl }}/install-gde/install/legacy-file-system-perms.html) instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

In a separate PR, remove this callout and delete the target file (legacy-file-system-perms.md) from the v2.3 directory. Also delete all links to that file, including those in src/_includes/install/file-system-perms-before_22.md, src/_includes/install/file-system-umask-over.md, and others

Copy link
Contributor Author

Choose a reason for hiding this comment

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

PR: #6364

I hope I did all what you requested.

src/_site/assets/i/icons/tip.svg Outdated
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove this file from the PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It was mistakenly added to this PR. Sorry 😊

src/guides/v2.3/config-guide/log/log-db.md Outdated
@@ -1,6 +1,6 @@
---
group: configuration-guide
title: Example&mdash;logging database activity
title: Example - logging database activity
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this. Long term, it would be better if the title were changed so that that there's no em dash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

src/guides/v2.3/config-guide/multi-site/ms_apache.md Outdated
@@ -1,6 +1,6 @@
---
group: configuration-guide
title: Tutorial&mdash;Set up multiple websites with Apache
title: Tutorial—Set up multiple websites with Apache
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this. Long term, it would be better if the title were changed so that that there's no em dash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

src/guides/v2.3/config-guide/multi-site/ms_nginx.md Outdated
@@ -1,6 +1,6 @@
---
group: configuration-guide
title: Tutorial&mdash;Set up multiple websites or stores with nginx
title: Tutorial—Set up multiple websites or stores with nginx
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this. Long term, it would be better if the title were changed so that that there's no em dash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

src/guides/v2.3/install-gde/continue-to-install.md Outdated
@@ -2,7 +2,7 @@
group: installation-guide
subgroup: Z_continue
title:
menu_title: Next&mdash;Installation part 2, installing
menu_title: Next---Installation part 2, installing
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this. Long term, it would be better if the title were changed so that that there's no em dash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

src/guides/v2.3/install-gde/continue-to-verify.md Outdated
@@ -2,7 +2,7 @@
group: installation-guide
subgroup: ZZ_continue
title:
menu_title: Next&mdash;Installation part 3, post-installation
menu_title: Next---Installation part 3, post-installation
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this. Long term, it would be better if the title were changed so that that there's no em dash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

src/guides/v2.3/install-gde/continue-to-verify_cli.md Outdated
@@ -2,7 +2,7 @@
group: installation-guide
subgroup: W_continue
title:
menu_title: Next&mdash;Installation part 3, post-installation
menu_title: Next---Installation part 3, post-installation
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this. Long term, it would be better if the title were changed so that that there's no em dash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

src/guides/v2.3/install-gde/install/cli/dev_options.md Outdated
@@ -1,6 +1,6 @@
---
group: installation-guide
title: Contributing developers&mdash;update, reinstall Magento
title: Contributing developers—update, reinstall Magento
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this. Long term, it would be better if the title were changed so that that there's no em dash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

src/guides/v2.3/install-gde/install/legacy-file-system-perms.md Outdated
@@ -1,8 +1,8 @@
---
group: installation-guide
subgroup: 99_app
title: Appendix&mdash;Magento file system ownership and appendix (legacy)
menu_title: Appendix&mdash;Magento file system ownership and appendix (legacy)
title: Appendix—Magento file system ownership and appendix (legacy)
Copy link
Contributor

Choose a reason for hiding this comment

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

Revert this. Long term, it would be better if the title were changed so that that there's no em dash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@keharper keharper added 2.3.x Magento 2.3 related changes Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies labels Jan 8, 2020
@keharper
Copy link
Contributor

keharper commented Jan 8, 2020

running tests

@keharper
Copy link
Contributor

keharper commented Jan 8, 2020

running tests

@keharper keharper merged commit 0a39a37 into magento:master Jan 8, 2020
@ghost
Copy link

ghost commented Jan 8, 2020

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

@keharper
Copy link
Contributor

keharper commented Jan 8, 2020

Thanks, @atwixfirster

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
2 more reviewers

@keharper keharper keharper approved these changes

@shrielenee shrielenee shrielenee approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@keharper keharper

@shrielenee shrielenee

Labels
2.3.x Magento 2.3 related changes Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies Partner: Atwix partners-contribution PR created by Magento partner
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Editorial. Replace mdash HTML special char.
5 participants
@atwixfirster @devops-devdocs @keharper @shrielenee @magento-engcom-team