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

Step by step docs #78

Merged
merged 4 commits into from
Nov 1, 2024
Merged

Step by step docs #78

merged 4 commits into from
Nov 1, 2024

Conversation

emyers-ccdc
Copy link
Contributor

No description provided.

README.md Outdated
Comment on lines 172 to 176
After making any changes to these files, restart the stack using the following config files.

- docker-compose.yml
- docker-compose.ssl.yml
- Any other docker compose files which you have customised
Copy link
Contributor

Choose a reason for hiding this comment

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

This could also include the MMHUB file.

I think this section repeats the one above that explains which files should be included in your compose file. Could we reference that section instead, instructing to then append any customised compose files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated it to say "restart the stack as described above, adding in any docker compose files which you have customised".

README.md Outdated
If the WebCSD server is run without configuring SSL a built-in self-signed certificate will be used.
This is not recommended as it is insecure.

## Installation
### WebCSD Test Installation
Copy link
Contributor

Choose a reason for hiding this comment

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

Calling this a test installation makes it sound like it's separate to the actual installation. Could this be called WebCSD Basic Installation, or something similar, instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to "WebCSD Basic Installation".

@emyers-ccdc emyers-ccdc merged commit 4e6a547 into main Nov 1, 2024
3 checks passed
@emyers-ccdc emyers-ccdc deleted the step_by_step_docs branch November 1, 2024 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants