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

Update xml-instructions.md #2391

Merged
merged 1 commit into from
Jul 3, 2018
Merged

Update xml-instructions.md #2391

merged 1 commit into from
Jul 3, 2018

Conversation

convenient
Copy link
Contributor

This PR is a:

  • New topic
  • Content fix or rewrite
  • Bug fix or improvement

Summary

When this pull request is merged, it will correctly display <remove>.

Additional information

N/A

@jeff-matthews
Copy link
Contributor

Thanks @convenient. There are actually several other related issues on this page. For example, headings with special characters aren't displaying properly in the On this page navigation box:

layout_instructions___magento_2_developer_documentation

We either need to see if we can escape the special characters in markdown or remove the special characters from the headings, like we do in the MFTF guide. I have a feeling we may need to just remove them.

Also, this topic has a confusing mix of HTML and markdown. Pure markdown is preferable, but converting this topic would be tedious work.

At a minimum, we should fix the headings.

@convenient
Copy link
Contributor Author

Fair. I was just correcting any bits and pieces I see while preparing for my certification. I don't have time to correct the further issues you have described so I'll just close this PR now, if anyone wants they can cherry-pick my commit across or redo the work or whatever 👍

@jeff-matthews
Copy link
Contributor

We appreciate that fix @convenient! I'd like to keep this open so that someone on the doc team orr maybe a community maintainer can take it on.

Copy link
Contributor

@bdenham bdenham left a comment

Choose a reason for hiding this comment

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

Thanks, @convenient. Good catch!

@bdenham bdenham merged commit 5ce76ed into magento:develop Jul 3, 2018
@bdenham bdenham added Site Improvements Updates to tools, processes, and site architecture that improve reader and contributor experience 2.2.x 2.3.x Magento 2.3 related changes Cleanup labels Jul 3, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.2.x 2.3.x Magento 2.3 related changes Site Improvements Updates to tools, processes, and site architecture that improve reader and contributor experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants