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

Updates for events overhaul #967

Closed
wants to merge 86 commits into from

Conversation

chrisbreiding
Copy link
Contributor

@chrisbreiding chrisbreiding commented Sep 17, 2018

TODO

Closes #890

- update plugins -> background
- create Catalog of Events table
- break out events into own pages
- make browser and background events conform to same format
- add Usage section to all browser events
Copy link
Contributor

@richdouglasevans richdouglasevans left a comment

Choose a reason for hiding this comment

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

Some surface level review comments.

I'm only about halfway through this mega PR 😫I'll likely have some deeper commentary after I've slept on it.

😄

Good stuff though! I'm learning a lot 🙇

source/api/commands/task.md Outdated Show resolved Hide resolved
source/api/events/before-window-load-event.md Outdated Show resolved Hide resolved
source/api/events/before-window-load-event.md Outdated Show resolved Hide resolved

# Usage

This example demonstrates testing that your application was redirected
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a final period to end the sentence.

source/api/events/command-end-event.md Outdated Show resolved Hide resolved
source/api/events/command-start-event.md Outdated Show resolved Hide resolved
source/api/events/command-end-event.md Outdated Show resolved Hide resolved
source/api/events/configuration-event.md Outdated Show resolved Hide resolved
source/api/events/fail-event.md Outdated Show resolved Hide resolved
source/api/events/fail-event.md Outdated Show resolved Hide resolved
chrisbreiding and others added 8 commits September 17, 2018 14:57
- since the next link is a redirect, it breaks the pagination.
- rearranging sentences to read better mostly
- remove ‘Event’ from title
- Add chart for each environment showing checkmarks for where it works
- Add links to headers of event table
- Add missing environment from task event doc
- fix mis-alphabetization of sidebar
- Have all arguments follow same format for command args.
- always specify where usage takes place
- break out examples vs usage
- always have usage below arguments
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

I made a bunch of updates to mostly normalize the views across all of the events.

Have a couple other things that needed addressing.

The only other thing that nags me is this use of the word "Environment" for background vs browser, especially since this has many different meanings within Cypress. Is it possible to rename this to something more precise. Context maybe?

source/guides/tooling/background-process.md Show resolved Hide resolved
source/guides/references/changelog.md Outdated Show resolved Hide resolved
source/api/events/file-preprocessor-event.md Outdated Show resolved Hide resolved
@chrisbreiding
Copy link
Contributor Author

I understand the concern about "environment", but I'm not sure "context" is any better. It's a pretty vague term. Maybe "process" as in browser process and background process, but browser process sounds kind of weird to me.

Need to come up with something since we'll probably use it extensively when we create the 'Architecture' guide that describes the browser/background processes/contexts/environments...

@chrisbreiding
Copy link
Contributor Author

I'm not a big fan of the table format for Environment. The event name (e.g. file:preprocessor) is redundant, especially since it links to the page you're already on.

screen shot 2018-09-18 at 3 10 29 pm

Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

👍

@chrisbreiding chrisbreiding mentioned this pull request May 21, 2019
18 tasks
@chrisbreiding chrisbreiding changed the title Updates for 4.0 Updates for 5.0 May 22, 2019
@CLAassistant
Copy link

CLAassistant commented Jul 7, 2019

CLA assistant check
All committers have signed the CLA.

@jennifer-shehane jennifer-shehane changed the title Updates for 5.0 Updates for 4.0 Oct 11, 2019
@jennifer-shehane jennifer-shehane changed the title Updates for 4.0 Updates for 5.0 Oct 11, 2019
@jennifer-shehane jennifer-shehane marked this pull request as draft May 15, 2020 08:01
@jennifer-shehane jennifer-shehane changed the title Updates for 5.0 Updates for events overhaul Aug 20, 2020
@amirrustam amirrustam closed this Feb 22, 2021
@matthamil matthamil deleted the issue-890-background-updates branch April 14, 2021 19:42
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.

Add/update docs for 6.0 changes
6 participants