Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: normalize CT adapter readme documents #24590

Merged
merged 4 commits into from Nov 9, 2022

Conversation

astone123
Copy link
Contributor

@astone123 astone123 commented Nov 8, 2022

User facing changelog

n/a

Additional details

We want the documentation related to our mount commands to exist at https://docs.cypress.io. If someone is viewing the documentation for our adapter packages that we publish to NPM, they should be redirected to the Cypress docs instead. This way we only have to maintain one set of documentation.

Note that the links to the docs site here are the updated links in the release-11.0.0 branch, so they won't work on the production docs site right now. We won't merge this until that branch gets released to the docs site

Steps to test

Not much to test, just look at the readme for each package and verify that they are consistent and that they contain what we want them to.

I linked a docs PR in the tasks checklist that removes references to these readme documents since they have minimal information in them now.

How has the user experience changed?

n/a

PR Tasks

@astone123 astone123 self-assigned this Nov 8, 2022
@cypress-bot
Copy link

cypress-bot bot commented Nov 8, 2022

Thanks for taking the time to open a PR!

@@ -2,7 +2,7 @@

> **Note** this package is not meant to be used outside of cypress component testing.

This librares exports some shared types and utility functions designed to build adapters for components frameworks.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I figured that we should leave this one since it contains info that isn't captured in the docs, and it's a little different from our other adapter packages

@astone123 astone123 changed the title chore: normalize npm readme documents chore: normalize CT adapter readme documents Nov 8, 2022
@astone123 astone123 requested a review from a team November 8, 2022 15:21
Copy link
Contributor

@ZachJW34 ZachJW34 left a comment

Choose a reason for hiding this comment

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

I like it!

Copy link
Contributor

@rockindahizzy rockindahizzy left a comment

Choose a reason for hiding this comment

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

Nice, this is a much better way to go about this

@astone123 astone123 requested a review from a team November 8, 2022 15:53
@lmiller1990 lmiller1990 self-requested a review November 9, 2022 00:14
Copy link
Member

@lmiller1990 lmiller1990 left a comment

Choose a reason for hiding this comment

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

Great, I definitely prefer the minimal docs here, in favor of deferring to our official documentation.

npm/mount-utils/README.md Show resolved Hide resolved
npm/react18/README.md Outdated Show resolved Hide resolved
npm/vue/README.md Outdated Show resolved Hide resolved
npm/vue2/README.md Outdated Show resolved Hide resolved
@cypress
Copy link

cypress bot commented Nov 9, 2022



Test summary

46485 0 4326 0Flakiness 17


Run details

Project cypress
Status Passed
Commit 12bf338
Started Nov 9, 2022 5:08 PM
Ended Nov 9, 2022 5:26 PM
Duration 17:40 💡
OS Linux Debian -
Browser Multiple

View run in Cypress Dashboard ➡️


Flakiness

cypress/e2e/e2e/origin/cookie_behavior.cy.ts Flakiness
1 ... > same site / cross origin > XMLHttpRequest > sets cookie on same-site request if withCredentials is true, and attaches to same-site request if withCredentials is true
2 ... > same site / cross origin > fetch > sets same-site cookies if "include" credentials option is specified from request, but does not attach same-site cookies to request by default (same-origin)
3 ... > same site / cross origin > XMLHttpRequest > sets cookie on same-site request if withCredentials is true, and attaches to same-site request if withCredentials is true
4 ... > same site / cross origin > fetch > sets same-site cookies if "include" credentials option is specified from request, but does not attach same-site cookies to request by default (same-origin)
5 ... > same site / cross origin > XMLHttpRequest > sets cookie on same-site request if withCredentials is true, and attaches to same-site request if withCredentials is true
This comment includes only the first 5 flaky tests. See all 17 flaky tests in the Cypress Dashboard.

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@astone123 astone123 merged commit 141c799 into develop Nov 9, 2022
81 of 83 checks passed
@astone123 astone123 deleted the astone123/normalize-npm-readmes branch November 9, 2022 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Links on @cypress/vue2 are broken
4 participants