Skip to content

Rewrite docs relating to EIDF CES development environment#331

Merged
mikej888 merged 24 commits into
mainfrom
rm-ces-dev02-references-mikej888
Jun 4, 2026
Merged

Rewrite docs relating to EIDF CES development environment#331
mikej888 merged 24 commits into
mainfrom
rm-ces-dev02-references-mikej888

Conversation

@mikej888
Copy link
Copy Markdown
Contributor

@mikej888 mikej888 commented May 19, 2026

EIDF Documentation Pull Request

Description

Make the following updates:

  • Remove references to EIDF CES development environment eidf147-ces-dev02.
  • Replace with references to eidf147-ces-dev01.
  • Add instructions on how to request access to this host inc. contact RC.

Type of change

  • Additional Documentation
  • Incorrect Documentation
  • Formatting

What has to be reviewed

docs/safe-haven-services/shs-container-user-guide/:

introduction.md
development-workflow.md
workflow-examples.md
container-examples.md

The bulk of changes are to the first three, primarily for clarity and consistency, and, for introduction.md adding a new section on 'Accessing the EIDF CES test VM'.

Checklist

  • Documentation follows the project style guidelines
  • Self-review of documentation using mkdocs on local system
  • Spellcheck has been performed
  • Pre-commit has been run and passed

mikej888 added 3 commits May 19, 2026 17:47
An EIDF CES development environment is currently unsupported.
SHS Container Guide documentation has been updated accordingly.
Also did general formatting changes, for consistency.
@mikej888 mikej888 requested a review from kavousan May 19, 2026 16:57
@mikej888 mikej888 added the documentation Improvements or additions to documentation label May 19, 2026
@mikej888 mikej888 changed the title Removed references to EIDF CES development environment eidf147-ces-dev02 Rewrite docs relating to EIDF CES development environment Jun 2, 2026
@mikej888
Copy link
Copy Markdown
Contributor Author

mikej888 commented Jun 3, 2026

Hi @kavousan,

I've restored content relating to an 'EIDF CES test VM' to

introduction.md
development-workflow.md
workflow-examples.md

I've updated the text to refer to the VM as the 'EIDF CES test VM' to future proof the docs against changes in the name of the VM and said that those who get access will be told the VM name when their access is granted. On which note I've added a new section on Accessing the EIDF CES test VM to introduction.md on how to request access to this VM.

Copy link
Copy Markdown
Contributor

@kavousan kavousan left a comment

Choose a reason for hiding this comment

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

I think a couple of points may need discussion with Donald/Bianca.

Comment thread docs/safe-haven-services/shs-container-user-guide/development-workflow.md Outdated
Comment thread docs/safe-haven-services/shs-container-user-guide/development-workflow.md Outdated

## Accessing the EIDF CES test VM

A CES test VM is available within EIDF that allows for containers to be tested in an SHS-like environment without having to be logged into the SHS itself. Containers that run successfully within this VM can then be expected to run in the same way in the SHS.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

...SHS. It is optional to make use of this environment.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Agree

Comment thread docs/safe-haven-services/shs-container-user-guide/workflow-examples.md Outdated
Comment thread docs/safe-haven-services/shs-container-user-guide/workflow-examples.md Outdated
Comment thread docs/safe-haven-services/shs-container-user-guide/workflow-examples.md Outdated
@mikej888 mikej888 merged commit fb4191e into main Jun 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants