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

Issue 1526: Updates to tech doc subdir #1616

Merged
merged 11 commits into from
Feb 8, 2022

Conversation

ADPennington
Copy link
Collaborator

@ADPennington ADPennington commented Feb 7, 2022

Summary of Changes

Provide a brief summary of changes
Pull request closes #1526
Acceptance criteria as stated in the issue

@codecov
Copy link

codecov bot commented Feb 7, 2022

Codecov Report

Merging #1616 (92b0c29) into raft-tdp-main (41c40f4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff               @@
##           raft-tdp-main    #1616   +/-   ##
==============================================
  Coverage          97.31%   97.31%           
==============================================
  Files                 80       80           
  Lines               1902     1902           
  Branches             249      249           
==============================================
  Hits                1851     1851           
  Misses                24       24           
  Partials              27       27           
Flag Coverage Δ
dev-backend 99.10% <ø> (ø)
dev-frontend 94.01% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 41c40f4...92b0c29. Read the comment docs.

+ **[Sprint-Review](./docs/Sprint-Review)**: Summaries of delivered stories per sprint
+ **[Technical-Documentation](./docs/Technical-Documentation)**: Architectural Decision Records, System documentation; technical workflows
+ **[User-Experience](./docs/User-Experience)**: Research-related project background, strategy and planning documents, and research syntheses
+ **[Frontend](./tdrs-frontend)**: Frontend ReactJS codebase
+ **[Backend](./tdrs-backend)**: Django codebase for backend
+ Codebase
Copy link
Collaborator Author

@ADPennington ADPennington Feb 7, 2022

Choose a reason for hiding this comment

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

@abottoms-coder wondering if you think its worth referencing any of the following herein:

  • scripts/
  • terraform/
  • commands.sh
  • secrets scanning-related files (e.g. regexes.json)

Copy link
Collaborator

Choose a reason for hiding this comment

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

@abottoms-coder wondering if you think its worth referencing any of the following herein:

  • scripts/
  • terraform/
  • commands.sh
  • secrets scanning-related files (e.g. regexes.json)

Yes on terraform but I don't think the others match in context.

@@ -28,3 +28,7 @@
* Data Files page as OFA Admin - searching for files by STT, year and quarter
* Data Files upload as both user types
* Welcome page shows expected permissions.

## Notes
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@abottoms-coder feel free to update as appropriate.

README.md Show resolved Hide resolved
added terraform ref link
@ADPennington ADPennington changed the title [DRAFT] Issue 1526: Updates to tech doc subdir Issue 1526: Updates to tech doc subdir Feb 8, 2022
@ADPennington ADPennington added the raft review This issue is ready for raft review label Feb 8, 2022
Copy link

@valcollignon valcollignon left a comment

Choose a reason for hiding this comment

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

LGTM

@ADPennington ADPennington marked this pull request as ready for review February 8, 2022 19:36
@ADPennington
Copy link
Collaborator Author

I updated the main readme with the latest links, so @abottoms-coder this is ready for raft review. cc: @valcollignon

@andrew-jameson andrew-jameson added Ready to Merge and removed raft review This issue is ready for raft review labels Feb 8, 2022
@andrew-jameson andrew-jameson merged commit ed8871c into raft-tdp-main Feb 8, 2022
@andrew-jameson andrew-jameson deleted the techdocs-updates-1526 branch February 8, 2022 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update TANF-app/doc/Technical-Documentation/
3 participants