Firefox Support Docs #2225
Firefox Support Docs #2225
Conversation
jennifer-shehane
changed the title
amirrustam
requested review from
bahmutov and
trydionel
and removed request for
trydionel
|
@bahmutov and @jennifer-shehane would appreciate a review on nailing the final language, and major content changes can come via other iterations. Remaining items:
|
There was a problem hiding this comment.
@amirrustam Make sure to run the documentation locally when editing, it will help you catch mistakes like broken links. For example, you would see this output showing that a few of the links were written incorrectly in the new doc.
The tests seems to have caught some things to, like the fact the link in the sidebar has 'Cross Browser', but the page title is 'Cross-Browser' with a hyphen.
I feel like we should prefer non-hyphenated. That's what MDN docs use too. https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Cross_browser_testing/Introduction Looks cleaner and maybe will be better for search. Let me know if there's disagreement, but our opinion should be reflected in the textlintrc so that it's consitent, so I've added it there.
Overall, the vocabulary seems a bit more advanced than I would like to see in our documentation. We have a lot of people who are not strong English speakers, so words like 'velocity', 'granular', 'concise','versatility', 'allocate' while maybe slightly more accurate - they likely have a simpler equivalent that could be used. Just for future consideration.
|
@jennifer-shehane thanks for your review and feedback. I've incorporated some of your recommendations, and also thinking through some of the ones I haven't commented on yet.
|
|
Changing base to v4.0 branch which is targeted release. |
# Conflicts: # package-lock.json # source/api/plugins/browser-launch-api.md # source/guides/references/configuration.md
|
I'm going to merge this into the v4.0 branch. Any more changes necessary should be made in that branch. |
* add 4.0 migration guide * fix linting issues * add migration guide to all language’s sidebars * add dropping cjsx support to 4.0 migration guide * update reference to new mocha version * improve spy/stub reset change description and add example * fix location of spy/stub item * fix lint errors * fix one more lint error * add migration-guide to pt-br.yml * fix link to migration guide mocha section * Remove our own reasoning - Node reaching end of life is enough * State we're supporting 8+ more explicitly going forward. * Add base 4.0.0 changelog * Add better formatting to Migration Guide - before/after sections + smaller headings * Add isFinite assertion, supported in Chai 4+ * fix eslint error * Add 'migration guide' title for russian pages * add edge to the list of browsers (#2416) * add edge to the list of browsers * Add edge to launching-browsers list / remove 'new' mention (this will become outdated) Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com> * Firefox Support Docs (#2225) * Initial commits for Firefox support * Add 'isBrowser' and 'isBrowserType' to docs (introduced in Firefox PR) * packagelock * Remove 'firefox support' from roadmap + tradoff of no cross browser support * Add notes about chromeWebSecurity only working in Chrome family browsers. * add cross-browser guide * Add 'cross-browser' to textlintrc * Update use of 'cross-browser' hyphenated. * minor editing / mostly fixing broken links and 'url' links * remove references to open --browser flag * add helpful info on cron expressions * rename cross browser guide * add localized titles for cross browser guide * fix typo * package-lock again * add cross browser testing to russian titles * add isBrowser pages to russian titles Co-authored-by: Amir Rustamzadeh <334337+amirrustam@users.noreply.github.com> * remove Node from textlint rules * Begin writing changelog for 4.0 * Fix broken examples for writeFile yields change + add to migration guide * Write descriptions of features / bugfixes relating to issues in Changelog. * remove isbrowsertype doc per changes in Firefox branch. * Improve the isBrowser doc * Add a summary and features for browser support. * Make updates based off of feedback for migration guide + changelog * update migration guide version references * Update dep versions from latest changes. * Cypress issue#92: cy.contains() doc. (#2397) * New option for cy.contains() * Added migration guide for cy.contains(). * Added more documentation for contains(). * Fixed wording. * Fix typo. * Update source/guides/references/migration-guide.md Co-Authored-By: James Hollowell <jamesthollowell@gmail.com> * 3.8.4 Release (#2455) * 3.8.4 Release * Document process profiler (#2407) * Document process profiler * Update source/guides/guides/debugging.md Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com> * minor updates + add image of example process profiler output Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com> * Update docs for browser type changes (#2454) * Add 'Chromium based browser 'family' to migration guide * Add migration guide for --browser flag changes * Use one line per shell run * Add more closed issues to 4.0.0 changelog + fix broken links * remove --browser canary deprecation - it is still supported * add example for selecting chromium-based * add cross linking between parallelization, CI, and cross browser guides * add note about ff gc issue to cross browser guide * add firefoxGcInterval config docs * add doc changes to 4.0.0 changelog * update wording for isBrowser * update isBrowser docs * Update isBrowser to match the signature of other doc pages. * Add 'see also' links to for newer docs * Fix syntax error in example * Update type of isCy arg to be Object * Remove extraneous doc update mentions in 4.0 changelog * Add notes about video recording not working in Firefox headless and Electron headed * Add section around firefoxGcInterval - interlink to section * Add warning note about Firefox headless video recording - reduce size of GC warning and instead refer to official doc section. * before:browser:launch api changes (#2458) * before:browser:launch api changes * Add to 4.0 changelog + add history to browser-launch-api * add docs for changing browser preferences * update browser extensions docs * Update source/guides/references/migration-guide.md Co-Authored-By: Brian Mann <brian.mann86@gmail.com> * Add headings for sections * Make sure comments mention 'Chromium-based' instead of static Chrome * update before:browser:launch, document breaking electron change Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com> Co-authored-by: Zach Bloomquist <github@chary.us> Co-authored-by: Brian Mann <brian.mann86@gmail.com> * Remove warning about Firefox headless browser from cross browser * Make note that Firefox is run in headed by default * Add issue for plugin event types to changelog * Updates to isbrowser * remove windowSize from browser-launch-api docs * document --browser canary breaking * update docs for firefox headless * Add section to TypeScript doc for plugins (#2466) * Minor updates * Make sure that Firefox is mentioned as 'beta' support * Add Edge Beta, Canary, Dev support to browsers list * fix broken isbrowser links * Document actual properties for all browser methods/hooks * Update photo of browser list dropdown in include all browsers * update descriptions of browser properties off of feedback * Style images within notes to have no margin * Add link to track progress for firefoxGcInterval issue * Other updates for guides from final review Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com> Co-authored-by: Gleb Bahmutov <gleb.bahmutov@gmail.com> Co-authored-by: Amir Rustamzadeh <334337+amirrustam@users.noreply.github.com> Co-authored-by: Kukhyeon Heo <sainthkh@naver.com> Co-authored-by: James Hollowell <jamesthollowell@gmail.com> Co-authored-by: Zach Bloomquist <github@chary.us> Co-authored-by: Ben Kucera <14625260+Bkucera@users.noreply.github.com> Co-authored-by: Brian Mann <brian.mann86@gmail.com>
Docs for Firefox support: cypress-io/cypress#1359
Launching tests with different browsers in Open and Headless mode
--browserCLI parameterBest practices on using Chrome and Firefox in CI
close Add docs for Firefox support #420