Skip to content

docs: update developer content #2409

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.

Sign up for GitHub

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

Jump to bottom
Merged
bennypowers merged 35 commits into from
Mar 28, 2023
Merged

docs: update developer content #2409

bennypowers merged 35 commits into from
Mar 28, 2023

Conversation

@zeroedin
Copy link
Contributor

@zeroedin zeroedin commented Mar 7, 2023 •
edited
Loading

What I did

  1. Updated content in the developer section

TODO:

  • Fix testing screenshot images with the latest UI

Testing Instructions

  1. View Deploy preview, review developer section of docs

Notes to Reviewers

  1. Review modified content, and suggest changes.

@changeset-bot
Copy link

changeset-bot bot commented Mar 7, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 495bb9d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@zeroedin zeroedin changed the title docs: update developer/setup content docs: update developer content Mar 7, 2023
@github-actions github-actions bot added work in progress POC / Not ready for review doc labels Mar 7, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2023 •
edited
Loading

✅ Deploy Preview for patternfly-elements ready!

Name Link
🔨 Latest commit 0f19838
😎 Deploy Preview https://deploy-preview-2409--patternfly-elements.netlify.app/

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added the AT passed Automated testing has passed label Mar 7, 2023
@zeroedin zeroedin marked this pull request as ready for review March 13, 2023 13:40
@zeroedin zeroedin requested a review from bennypowers March 13, 2023 13:40
@zeroedin zeroedin marked this pull request as draft March 13, 2023 13:40
@zeroedin
Copy link
Contributor Author

zeroedin commented Mar 13, 2023

Note, reverting back to draft: forgot I still wanted to replace screenshots.

brianferry
brianferry reviewed Mar 13, 2023
View reviewed changes
brianferry
brianferry reviewed Mar 13, 2023
View reviewed changes
@github-actions github-actions bot added the tools Development and build tools label Mar 13, 2023
bennypowers
bennypowers reviewed Mar 17, 2023
View reviewed changes
bennypowers
bennypowers reviewed Mar 17, 2023
View reviewed changes
bennypowers
bennypowers reviewed Mar 17, 2023
View reviewed changes
@zeroedin
Copy link
Contributor Author

zeroedin commented Mar 17, 2023 •
edited
Loading

@bennypowers npm run test:ci fails when testing the whole project. Failures in react/vue tests I think are the majority of the issues although I didn't go through the failures 1 by 1. My assumption is that these passes/fails are dependent on react/vue wrapper conversation.

For now, I modified the testing section and only suggested testing the pf-cool-element which passes and allowed me to add the screenshot. npm run test:ci --files elements/**/pf-cool-element.spec.ts.

I think ideally long term the preference would be to get the whole project passing npm run test:ci and then revert that change back in docs to the global test run. Is this worthy of its own issue? Or is it close enough related to: #2370

brianferry
brianferry reviewed Mar 17, 2023
View reviewed changes
@brianferry
Copy link
Collaborator

brianferry commented Mar 17, 2023

Do we use chai anymore in the app? No, right? If so we can remove that section from the 'testing' docs as well.

@bennypowers
Copy link
Member

bennypowers commented Mar 19, 2023

Do we use chai anymore in the app? No, right? If so we can remove that section from the 'testing' docs as well.

We do use chai. expect().to.whatever is chai

@zeroedin zeroedin mentioned this pull request Mar 21, 2023
Open
24 tasks
bennypowers
bennypowers requested changes Mar 23, 2023
View reviewed changes
@zeroedin zeroedin marked this pull request as ready for review March 28, 2023 13:32
@bennypowers bennypowers enabled auto-merge (squash) March 28, 2023 14:17
@bennypowers bennypowers merged commit 791d8ec into main Mar 28, 2023
@bennypowers bennypowers deleted the docs/develop-section branch March 28, 2023 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@brianferry brianferry brianferry left review comments

@bennypowers bennypowers bennypowers approved these changes

Assignees

@zeroedin zeroedin

Labels

AT passed Automated testing has passed work in progress POC / Not ready for review

Projects

None yet

Milestone

PatternFly Elements 2.x

Development

Successfully merging this pull request may close these issues.

5 participants

@zeroedin @brianferry @bennypowers @heyMP