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

Updated What's New for documentation updates since Aug 9, 2019 #5212

Merged
merged 6 commits into from
Aug 20, 2019

Conversation

meker12
Copy link
Contributor

@meker12 meker12 commented Aug 19, 2019

Purpose of this pull request

This pull request updates the What's New page with the documentation changes published since the last update on August 9.

Affected DevDocs pages

@meker12 meker12 self-assigned this Aug 19, 2019
@meker12 meker12 added 2.x Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies Internal Dev Differentiates work between community and Magento staff and removed Progress: review labels Aug 19, 2019
@meker12 meker12 requested a review from dshevtsov August 19, 2019 20:36
@meker12 meker12 requested a review from shrielenee August 20, 2019 15:15
Copy link
Collaborator

@dshevtsov dshevtsov left a comment

Choose a reason for hiding this comment

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

General comments:

  1. Run rake preview locally to test HTML
  2. Test all new links manually by clicking each link

See my comments at the changed files.

type: Major update
date: August 13, 2019
link: https://github.com/magento/devdocs/pull/5161
- description: Added documentation for the [TrimInput widget](https://devdocs.magento.com//guides/v2.3/javascript-dev-guide/widgets/widget_trim-input.html)
Copy link
Collaborator

Choose a reason for hiding this comment

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

The link https://devdocs.magento.com//guides causes double slash failure when I generate a preview with rake.

Copy link
Collaborator

Choose a reason for hiding this comment

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

The link is redirected to home page. There is no such file guides/v2.3/javascript-dev-guide/widgets/widget_trim-input.md.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dshevtsov Did you refresh? I don't have the *.md file in the files that I generated. Nor do I have a double slash.

Copy link
Collaborator

@dshevtsov dshevtsov Aug 20, 2019

Choose a reason for hiding this comment

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

I didn't mean you have .md files in links.
The link points to the HTML page, but the page does not exist, because there is no corresponding .md file in the source.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for clarifying.

type: New topic
date: August 13, 2019
link: https://github.com/magento/devdocs/pull/5135
- description: Added an optional step to the [Cloud Docker]( https://devdocs.magento.com/guides/v2.3/cloud/docker/docker-config.html)
Copy link
Collaborator

@dshevtsov dshevtsov Aug 20, 2019

Choose a reason for hiding this comment

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

the link starts from a space

Copy link
Contributor Author

@meker12 meker12 Aug 20, 2019

Choose a reason for hiding this comment

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

@dshevtsov The space is added when the entry is generated from the What's New script. I don't see why because the comment in the PR looks fine.

Copy link
Collaborator

Choose a reason for hiding this comment

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

If you open the PR description in raw format, you'll see the issue.
GitHub UI resolves the issue with spaces, but our tool uses GitHub API and gets raw Markdown.

@meker12 meker12 requested a review from dshevtsov August 20, 2019 19:49
Copy link
Collaborator

@dshevtsov dshevtsov left a comment

Choose a reason for hiding this comment

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

Added a couple comments.

date: August 15, 2019
link: https://github.com/magento/devdocs/pull/5123
- description: Added the [Change increment ID for a database entity on particular
store](http://devdocs.magento.com/guides/v2.2/config-guide/multi-site/change-increment-id.html)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not critical, but the link should point to the topic from latest version.

date: August 14, 2019
link: https://github.com/magento/devdocs/pull/5182
- description: Provided details about what happens when you run the [Data Migration
Tool](https://devdocs.magento.com/guides/v2.2/migration/migration-migrate-data.html).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not critical, but the link should point to the topic from latest version.

@meker12
Copy link
Contributor Author

meker12 commented Aug 20, 2019

running tests

@meker12 meker12 merged commit 723ce06 into master Aug 20, 2019
@ghost
Copy link

ghost commented Aug 20, 2019

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

@meker12 meker12 deleted the whats-new-aug-19-2019 branch August 22, 2019 23:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.x 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.

3 participants