Pull requests tests documentation for contributors #8483

sivaschenko · 2021-01-07T10:36:31Z

Purpose of this pull request

This pull request (PR) introduces information for contributions on working with pull request tests, launching them, viewing test results and linking related pull requests for testing

Affected DevDocs pages

whatsnew
Added a new topic describing how contributors can work with pull request tests.

lenaorobei · 2021-01-07T15:41:10Z

Overall, the content looks good to me.

However, I noticed that the most of the information that is related to the contribution flow is located here - https://devdocs.magento.com/contributor-guide/contributing.html
Probably, it make sense to move sections like "Magento contributor assistant" or "Forks and pull requests" to child pages as well.

slavvka

Please address my comments

src/contributor-guide/pull-request-tests.md

sivaschenko · 2021-01-08T16:06:00Z

@lenaorobei thatks for the review. I've added the link to the added page from pull request creation steps. I think it's a good idea to break currently huge Contribution Guide to several pages for better readability, however, I think it would be better to do in a separate pull request. The goal of this one is to provide missing documentation on pull request tests

sivaschenko · 2021-01-19T21:46:39Z

@slavvka thanks for the review! I have removed extra details from the description of the builds and kept more general tests description (see responses to your comments). Can you please review the PR again?

…wiki

src/contributor-guide/contributing.md

src/contributor-guide/pull-request-tests.md

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

jeff-matthews · 2021-01-20T21:04:16Z

running tests

jeff-matthews · 2021-01-20T21:19:36Z

Jenkins failed on link checking:

+ rake test:html
�[35mChecking HTML ...�[0m
Running ["ScriptCheck", "ImageCheck", "HtmlCheck", "LinkCheck", "LinkChecker::DoubleSlashCheck"] on ["_site"] on *.html... 


Ran on 2647 files!


- internally linking to /contributor-guide/pull-request-tests, which does not exist
  *  _site/contributor-guide/contributing.html (line 581)
     <a href="/contributor-guide/pull-request-tests">pull request tests</a>
- internally linking to /contributor-guide/pull-request-tests/, which does not exist
  *  _site/contributor-guide/backward-compatible-development/index.html (line 262)
     <a href="/contributor-guide/pull-request-tests/" class="spectrum-SideNav-itemLink ">Pull Request Tests</a>
  *  _site/contributor-guide/contributing.html (line 262)
     <a href="/contributor-guide/pull-request-tests/" class="spectrum-SideNav-itemLink ">Pull Request Tests</a>
  *  _site/contributor-guide/contributing_dod.html (line 262)
     <a href="/contributor-guide/pull-request-tests/" class="spectrum-SideNav-itemLink ">Pull Request Tests</a>
  *  _site/contributor-guide/contributors.html (line 262)
     <a href="/contributor-guide/pull-request-tests/" class="spectrum-SideNav-itemLink ">Pull Request Tests</a>
  *  _site/contributor-guide/maintainers.html (line 262)
     <a href="/contributor-guide/pull-request-tests/" class="spectrum-SideNav-itemLink ">Pull Request Tests</a>
  *  _site/contributor-guide/pull-request-tests.html (line 262)
     <a href="/contributor-guide/pull-request-tests/" class="spectrum-SideNav-itemLink ">Pull Request Tests</a>
  *  _site/contributor-guide/templates/basic_template.html (line 262)
     <a href="/contributor-guide/pull-request-tests/" class="spectrum-SideNav-itemLink ">Pull Request Tests</a>
rake aborted!
HTML-Proofer found 8 failures!

I'm checking locally to see what the problem is.

jeff-matthews

Adding the .html file extension to the new topic references appears to fix the link errors even though the links seem to work without the extension.

@dshevtsov, is this a configuration issue with the htmlproofer tool?

src/_data/toc/contributor-guide.yml

src/contributor-guide/contributing.md

dshevtsov · 2021-01-20T21:38:33Z

Adding the .html file extension to the new topic references appears to fix the link errors even though the links seem to work without the extension.

@dshevtsov, is this a configuration issue with the htmlproofer tool?

I'm not sure I understand the question. The system works as expected. We do not support implicit conversion of /dir/page.html onto /dir/page/.

jeff-matthews · 2021-01-20T21:42:27Z

Link check fails unless the link contains the file extension for the new topic. However, similar links to other topics do not fail. See the TOC entry for backward incompatible development:

- label: Backward compatible development
          url: /contributor-guide/backward-compatible-development/
          versionless: true

That seems like odd behavior for our link checking tool.

dshevtsov · 2021-01-20T21:45:59Z

Link check fails unless the link contains the file extension for the new topic. However, similar links to other topics do not fail. See the TOC entry for backward incompatible development:
- label: Backward compatible development
          url: /contributor-guide/backward-compatible-development/
          versionless: true
That seems like odd behavior for our link checking tool.

The url /contributor-guide/backward-compatible-development/ works because the source topic is located in the /contributor-guide/backward-compatible-development/index.md file. In this case, both /contributor-guide/backward-compatible-development/ and /contributor-guide/backward-compatible-development/index.html would work.

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

jeff-matthews · 2021-01-20T21:47:50Z

Correct. I still think it's odd that htmlproofer considers one a failure and not the other.

sivaschenko · 2021-01-20T21:48:23Z

@jeff-matthews I've applied the link fix, thanks

jeff-matthews · 2021-01-20T21:48:48Z

running tests

dshevtsov · 2021-01-20T21:52:55Z

Correct. I still think it's odd that htmlproofer considers one a failure and not the other.

The link checker reproduces exact behavior on the web server:

/contributor-guide/backward-compatible-development/ works
/contributor-guide/backward-compatible-development/index.html works
/contributor-guide/pull-request-tests/ would return 404

jeff-matthews · 2021-01-20T21:55:09Z

When I build locally, the extensionless URL to the new topic works. I haven't tried it on staging.

ghost · 2021-01-20T22:07:35Z

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

dshevtsov · 2021-01-21T05:25:09Z

When I build locally, the extensionless URL to the new topic works. I haven't tried it on staging.

Ah, good to know.

m2-community-project bot added the Progress: work in progress label Jan 7, 2021

slavvka suggested changes Jan 7, 2021

View reviewed changes

m2-community-project bot assigned slavvka Jan 7, 2021

m2-community-project bot added Progress: changes requested Progress: review and removed Progress: work in progress Progress: changes requested labels Jan 7, 2021

sivaschenko added a commit to sivaschenko/devdocs that referenced this pull request Jan 19, 2021

magento#8483: Code review changes

d3c0b97

Pull requests tests documentation

a397f7f

sivaschenko force-pushed the pull-request-tests branch from 722f786 to a397f7f Compare January 19, 2021 21:44

sivaschenko changed the title ~~[WIP] Pull requests tests documentation for contributors~~ Pull requests tests documentation for contributors Jan 19, 2021

sivaschenko marked this pull request as ready for review January 19, 2021 21:45

sivaschenko requested a review from slavvka January 19, 2021 21:46

Added link to Magento Automated Testing information on magento2 repo …

e1d4fb4

…wiki

slavvka approved these changes Jan 20, 2021

View reviewed changes

m2-community-project bot added Progress: approved and removed Progress: review labels Jan 20, 2021

sivaschenko requested a review from jeff-matthews January 20, 2021 16:49

jeff-matthews added Internal Dev Differentiates work between community and Magento staff New Topic A major update published as an entirely new document labels Jan 20, 2021

jeff-matthews suggested changes Jan 20, 2021

View reviewed changes

m2-community-project bot assigned jeff-matthews Jan 20, 2021

m2-community-project bot added Progress: changes requested and removed Progress: approved labels Jan 20, 2021

sivaschenko and others added 2 commits January 20, 2021 20:48

magento#8483: Apply suggestions from code review

23ef153

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

magento#8483: Removed contents

a6abfc8

jeff-matthews approved these changes Jan 20, 2021

View reviewed changes

m2-community-project bot added Progress: approved and removed Progress: changes requested labels Jan 20, 2021

Merge branch 'master' into pull-request-tests

e2b116b

jeff-matthews reviewed Jan 20, 2021

View reviewed changes

src/_data/toc/contributor-guide.yml Outdated Show resolved Hide resolved

src/contributor-guide/contributing.md Outdated Show resolved Hide resolved

m2-community-project bot added Progress: review and removed Progress: approved labels Jan 20, 2021

magento#8483: Apply suggestions from code review

195db9b

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

jeff-matthews enabled auto-merge (squash) January 20, 2021 21:48

jeff-matthews merged commit a0b7bc6 into magento:master Jan 20, 2021

m2-community-project bot added Progress: done and removed Progress: review labels Jan 20, 2021

Pull requests tests documentation for contributors #8483

Pull requests tests documentation for contributors #8483

Uh oh!

Conversation

sivaschenko commented Jan 7, 2021 • edited by jeff-matthews 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!

lenaorobei commented Jan 7, 2021

Uh oh!

slavvka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sivaschenko commented Jan 8, 2021

Uh oh!

sivaschenko commented Jan 19, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeff-matthews commented Jan 20, 2021

Uh oh!

jeff-matthews commented Jan 20, 2021

Uh oh!

jeff-matthews left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dshevtsov commented Jan 20, 2021

Uh oh!

jeff-matthews commented Jan 20, 2021

Uh oh!

dshevtsov commented Jan 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeff-matthews commented Jan 20, 2021

Uh oh!

sivaschenko commented Jan 20, 2021

Uh oh!

jeff-matthews commented Jan 20, 2021

Uh oh!

dshevtsov commented Jan 20, 2021

Uh oh!

jeff-matthews commented Jan 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Jan 20, 2021

Uh oh!

dshevtsov commented Jan 21, 2021

Uh oh!

Uh oh!

sivaschenko commented Jan 7, 2021 •

edited by jeff-matthews

Loading

dshevtsov commented Jan 20, 2021 •

edited

Loading

jeff-matthews commented Jan 20, 2021 •

edited

Loading