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

added functional component example to simulate doc #2248

Merged
merged 3 commits into from Oct 6, 2019

Conversation

@paulvollmer
Copy link
Contributor

commented Sep 30, 2019

added one more example to demonstrate the use at a functional component and how you can test an onChange event

ljharb and others added 2 commits Sep 28, 2019
…ple to simulate doc

added one more example to demonstrate the use at a functional component and how you can test an onChange event
@ljharb ljharb force-pushed the paulvollmer:patch-1 branch 2 times, most recently from f17aa40 to 8a2e505 Oct 6, 2019
@ljharb
ljharb approved these changes Oct 6, 2019
@ljharb ljharb force-pushed the paulvollmer:patch-1 branch from 8a2e505 to 3576b61 Oct 6, 2019
@ljharb ljharb merged commit 3576b61 into airbnb:master Oct 6, 2019
2 checks passed
2 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage increased (+0.2%) to 91.725%
Details
@paulvollmer paulvollmer deleted the paulvollmer:patch-1 branch Oct 10, 2019
@paulvollmer

This comment has been minimized.

Copy link
Contributor Author

commented Oct 10, 2019

@ljharb i try to update the gh-pages docs by running the yarn docs:publish command but i cannot send a PR because of a different commit history. to let the command run i changed the github repo urls from ...airbnb/enzyme.git to ...paulvollmer/enzyme.git. of course i could push to my fork but github cannot create a PR.

can you publish the docs?

the command looks also very hacky for me and the empty commit at the begin of the command chain should be the problem.

is there a reason why you overwrite the gh-pages branch history? if it is only because of make things done then i can work on this issue. small hacktoberfest task for me...


screenshot if i try to create a PR
Screenshot 2019-10-10 at 22 29 45

@ljharb

This comment has been minimized.

Copy link
Collaborator

commented Oct 10, 2019

@paulvollmer the published docs are only changed during a release of enzyme itself, and should not be updated otherwise.

The improvement I'd like to make to docs publishing is that each version's docs should be persistent - ie, what i'd like is each enzyme release to generate a new commit on top of gh-pages, that adds both a v1.2.3 directory, and updates the root to be the latest version, without altering previous versions. If that's something you're interested in, I'd be very happy to review that PR.

@paulvollmer

This comment has been minimized.

Copy link
Contributor Author

commented Oct 15, 2019

@ljharb okay, i got it.

the docs versioning task is interesting. for me it sounds like having the solution to surf the docs for a specific version.

maybe it make sense to add a select ui to choose which enzyme version you want to surf.

i think it is easy to refactor the script to build and publish to a directory of the name of the latest version. the challenge could be to generate the docs for the past versions. or did enzyme ever used the same docs build process?

@ljharb

This comment has been minimized.

Copy link
Collaborator

commented Oct 15, 2019

That's my thought - that it would default to the latest, but there'd be a dropdown in the corner to switch between versions.

It would be fine to make "fill in the past version" be a one-off script that's only ran once (with the latest build process), to backfill - once it's in place, moving forward, the build script would just have to generate the new version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.