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

DDS-1906 store raw Tech Overview #1539

Merged
merged 2 commits into from
Jul 16, 2024

Conversation

aishling-scilifelab
Copy link
Collaborator

@aishling-scilifelab aishling-scilifelab commented Jul 15, 2024

Read this before submitting the PR

  1. Always create a Draft PR first
  2. Go through sections 1-5 below, fill them in and check all the boxes
  3. Make sure that the branch is updated; if there's an "Update branch" button at the bottom of the PR, rebase or update branch.
  4. When all boxes are checked, information is filled in, and the branch is updated: mark as Ready For Review and tag reviewers (top right)
  5. Once there is a submitted review, implement the suggestions (if reasonable, otherwise discuss) and request an new review.

If there is a field which you are unsure about, enter the edit mode of this description or go to the PR template; There are invisible comments providing descriptions which may be of help.

1. Description / Summary

Add a summary of the changes in this PR and the related issue.

2. Jira task / GitHub issue

Link to the github issue or add the Jira task ID here.

3. Type of change

What type of change(s) does the PR contain?

Check the relevant boxes below. For an explanation of the different sections, enter edit mode of this PR description template.

  • New feature
    • Breaking: Why / How? Add info here.
    • Non-breaking
  • Database change: Remember the to include a new migration version, or explain here why it's not needed.
  • Bug fix
  • Security Alert fix
    • Package update
      • Major version update
  • Documentation
  • Workflow
  • Tests only

4. Additional information

5. Actions / Scans

Check the boxes when the specified checks have passed.

For information on what the different checks do and how to fix it if they're failing, enter edit mode of this description or go to the PR template.

  • Black
  • Prettier
  • Yamllint
  • Tests
  • CodeQL
  • Trivy
  • Snyk

- This is not the PDF which is currently displayed so is obsolete.
- Git can keep the history of the older PDFs for us.
- Raw (i.e. not PDF) doc was kept out of repo. Move here for
tracking
- Some minor formatting changes relate to previous PDF (e.g.
updated font to Lato to match web)
- Deleted Section 3: 'What is the invoicing model?'. This
is not technical information. We should make this available
elsewhere. Also, this info is only relevant to users using
the DC-hosted instance.
- Add individual SVG files for the images in the overview
- Delete PDFs of images
- Update SPRINTLOG.md with PR
- Set prettier to ignore technical-overview.md. As noted,
it is not formatting the grid tables correctly.
- Next step is creating PDF as GitHub Action (hence no
docs on creating PDF from MD).
Copy link

codecov bot commented Jul 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.49%. Comparing base (cdad1a7) to head (7b16b4b).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1539   +/-   ##
=======================================
  Coverage   92.49%   92.49%           
=======================================
  Files          29       29           
  Lines        4850     4850           
=======================================
  Hits         4486     4486           
  Misses        364      364           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aishling-scilifelab aishling-scilifelab marked this pull request as ready for review July 15, 2024 14:45
@rv0lt
Copy link
Member

rv0lt commented Jul 16, 2024

Didn't saw any big changes in the end result of the pdf.

Only some style changes, I guess because of being compiled differently. But nothing crazy.

@aishling-scilifelab aishling-scilifelab merged commit abccb24 into dev Jul 16, 2024
14 checks passed
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.

2 participants