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

Docker development stack docs #267

Merged
merged 4 commits into from
Dec 13, 2024
Merged

Docker development stack docs #267

merged 4 commits into from
Dec 13, 2024

Conversation

cc-a
Copy link
Contributor

@cc-a cc-a commented Dec 6, 2024

Description

Provides more detailed documentation on the dependencies of the project and how these are implemented in the our Docker development stack.

Fixes #251

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass (eg. python -m pytest)
  • The documentation builds and looks OK (eg. python -m sphinx -b html docs docs/build)
  • Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

@codecov-commenter
Copy link

codecov-commenter commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.03%. Comparing base (0af776b) to head (9a33ad4).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #267   +/-   ##
=======================================
  Coverage   86.03%   86.03%           
=======================================
  Files          38       38           
  Lines         580      580           
=======================================
  Hits          499      499           
  Misses         81       81           

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

Copy link
Contributor

@jamesturner246 jamesturner246 left a comment

Choose a reason for hiding this comment

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

Looks good. A few tiny things.

docs/development.md Show resolved Hide resolved
docs/development.md Show resolved Hide resolved
Copy link
Collaborator

@dalonsoa dalonsoa left a comment

Choose a reason for hiding this comment

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

I've just made a couple of suggestions, but ti looks good, otherwise.

docs/development.md Show resolved Hide resolved
docs/development.md Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
cc-a and others added 4 commits December 13, 2024 11:58
Co-authored-by: Diego Alonso Álvarez <6095790+dalonsoa@users.noreply.github.com>
Co-authored-by: James Paul Turner <jamesturner246@users.noreply.github.com>
@cc-a cc-a force-pushed the docker-stack-docs branch from 967b368 to 9a33ad4 Compare December 13, 2024 11:58
@cc-a cc-a enabled auto-merge December 13, 2024 11:58
@cc-a cc-a merged commit 9bcb02a into main Dec 13, 2024
4 checks passed
@cc-a cc-a deleted the docker-stack-docs branch December 13, 2024 11:58
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.

More detailed documentation on drunc and Docker stack
4 participants