E12 Documentation changes to be made

[dc2007git]

Docker setup

• Step 4, using s/docker-init, doesn’t work. Need to specify the local-dev.yml file with sudo docker compose -f docker-compose.local-dev.yml exec web coverage run manage.py test

  • Note - this and other local-dev.yml problems I found can all be fixed by changing the command in the respective s/scripts
  • change all instances of a docker compose command over to use the relevant s/docker-* script

• When executing commands in the context of the web container, you need to have an active shell prompt, but the terminal is non-functional while the rcpch-audit-engine is being used in the same terminal.

  • Add instruction to open another terminal window

• Running docker compose down:

  • Need to use the -f flag and specify which docker configuration file to use (fixable using s/scripts)

Running tests

• Most recent instruction in Docs before this page is to close and destroy the Docker container. Should specify that before you run pytest, you need to have the Docker container built.
• Docker file specified is docker-compose.dev-init.yml. Should it not be .local-dev.yml if in the development branch (fixable with s/script changes)
  • Change this in the s/docker-compose.local-dev.yml file

Customisation and Useful Flags

• In the various code blocks throughout the page, there is the term ‘console’ from the .md file leaking into the webpage. This also removes the functionality of copying the command directly from the ‘copy’ button that mkdocs gives to the console boxes

  • fix any malformed code blocks

• Running the specific test_length_of_treatment Pytest doesn’t work, can’t locate the test

  • test_length_of_treatment has gone from epilepsy12/tests/model_tests/test_antiepilepsy_medicine.py #595

Test structure

• Doesn’t look like _meta_tests exists anymore
  • review _meta_tests

Factories and Fixtures

• Repeated ‘Conservative database access’ box
  • remove the repetition

Code Style

• VSCode settings have no settings found for ‘python linting’ #597

Logos and Branding

• Some E12 images don’t load properly #598

Project Structure

• The AppName code box needs to be corrected to say ‘epilepsy12’ as otherwise it may lead the user to look into rcpch-audit-engine top-level folder
• fix Mistype in constants folder explanation

Design decisions and rationale

• Parameters for page_elements could be spaced as bullet points instead of a paragraph for readability

Organisations, Trusts and Levels of Abstraction

• ‘The are 42 ICBs and trust’ should be ‘There are 42 ICBs and trusts’
• drop the capital T in The ICB model is taken directly from
• drop ‘the’ in ‘NHS Digital with the its boundary shapes for mapping’

Scoring the audit forms

• ‘focal epilepsy are exlcuded’ should be ‘excluded’