sanger / limber

A config-driven LIMS built on Sequencescape, primarily for running library preparation pipelines in the laboratory
MIT License
3 stars 8 forks source link

Y24-109 - Rework Limber documentation for clarity on how SequenceScape & Limber interact and are setup #1759

Closed SHIV5T3R closed 2 months ago

SHIV5T3R commented 3 months ago

Closes #1709

Changes proposed in this pull request

Instructions for Reviewers

[All PRs] - Confirm PR template filled
[Feature Branches] - Review code
[Production Merges to main]
    - Check story numbers included
    - Check for debug code
    - Check version

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.48%. Comparing base (cfe817e) to head (cd1a03b). Report is 69 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1759 +/- ## =========================================== + Coverage 91.35% 91.48% +0.12% =========================================== Files 372 374 +2 Lines 7660 7809 +149 =========================================== + Hits 6998 7144 +146 - Misses 662 665 +3 ``` | [Flag](https://app.codecov.io/gh/sanger/limber/pull/1759/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sanger) | Coverage Δ | | |---|---|---| | [javascript](https://app.codecov.io/gh/sanger/limber/pull/1759/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sanger) | `93.65% <ø> (ø)` | | | [pull_request](https://app.codecov.io/gh/sanger/limber/pull/1759/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sanger) | `91.38% <ø> (?)` | | | [push](https://app.codecov.io/gh/sanger/limber/pull/1759/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sanger) | `91.35% <ø> (ø)` | | | [ruby](https://app.codecov.io/gh/sanger/limber/pull/1759/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sanger) | `91.19% <ø> (+0.15%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sanger#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

SHIV5T3R commented 3 months ago

I've changed the order of the steps so it's a little bit easier to figure out how to set things up. Any improvements needed @KatyTaylor @andrewsparkes

codeclimate[bot] commented 2 months ago

Code Climate has analyzed commit cd1a03be and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 91.0% (0.0% change).

View more on Code Climate.