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

[DUOS-2041][risk=no] Documentation Updates #1775

Merged
merged 15 commits into from
Aug 30, 2022
Merged

[DUOS-2041][risk=no] Documentation Updates #1775

merged 15 commits into from
Aug 30, 2022

Conversation

rushtong
Copy link
Contributor

@rushtong rushtong commented Aug 26, 2022

Addresses

https://broadworkbench.atlassian.net/browse/DUOS-2041

This PR covers documentation updates to cover:

  1. Separate dev documentation from high level app documentation
  2. Running locally with npm start
  3. Running with a proxy similarly to deployed instances with docker compose
  4. Cypress test documentation
  5. Removed the unused test command and a dev dependency that used it since we are testing in a more complex and comprehensive manner via actions.
  6. Updates @react-pdf/renderer and @react-pdf/font to get past compilation issues

Have you read Terra's Contributing Guide lately? If not, do that first.

  • Label PR with a Jira ticket number and include a link to the ticket
  • Label PR with a security risk modifier [no, low, medium, high]
  • PR describes scope of changes
  • Get a minimum of one thumbs worth of review, preferably two if enough team members are available
  • Get PO sign-off for all non-trivial UI or workflow changes
  • Verify all tests go green
  • Test this change deployed correctly and works on dev environment after deployment

@rushtong rushtong changed the title [WIP][risk=no] Documentation Updates [DUOS-2041][risk=no] Documentation Updates Aug 26, 2022
@rushtong rushtong marked this pull request as ready for review August 26, 2022 19:37
@rushtong rushtong requested a review from a team as a code owner August 26, 2022 19:37
DEVNOTES.md Outdated Show resolved Hide resolved
docker-compose.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@quazi-h quazi-h left a comment

Choose a reason for hiding this comment

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

Pending updates for Justin's comments I think these documentation updates look good.

@rushtong rushtong requested a review from JVThomas August 30, 2022 13:03
@rushtong
Copy link
Contributor Author

rushtong commented Aug 30, 2022

Seeing an unrelated build error since merging dev into this branch:

./node_modules/@react-pdf/font/lib/index.browser.es.js
Attempted import error: 'create' is not exported from 'fontkit' (imported as 'fontkit').

Looking into it.

Update: related to diegomura/react-pdf#1991

Copy link
Contributor

@shaemarks shaemarks left a comment

Choose a reason for hiding this comment

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

LGTM

@rushtong rushtong merged commit c9af0f8 into develop Aug 30, 2022
@rushtong rushtong deleted the doc_updates branch August 30, 2022 21:27
@eladonline
Copy link

when this commit be available in the npm ?

@rushtong
Copy link
Contributor Author

when this commit be available in the npm ?

@eladonline - You'll want to ask that question in https://github.com/diegomura/react-pdf instead of here. Good luck!

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.

5 participants