This repository holds the sources to the "Engineering Digital Twins" book website: https://digital-twin-book.org/
We welcome contributions from the community! If you'd like to improve this website, fix a problem, or add content, follow these steps:
- Fork the Repository: Click the "Fork" button at the top right of this page to create your own copy of the repository.
- Clone Your Fork: Clone your forked repository to your local machine using
git clone. - Create a New Branch: Create a new branch for your changes using a descriptive name (e.g.,
feature/add-new-section). - Make Your Changes: Edit files, add content, or fix issues. Be sure to follow any existing conventions.
- Commit and Push: Commit your changes and push them to your forked repository.
- Submit a Pull Request (PR): Go to the original repository and click "New Pull Request." Select your branch and describe your changes. We'll review your PR!
If you encounter any issues with the website, please open an issue. Provide details about the problem, steps to reproduce it, and any relevant context.
We appreciate your contributions! When submitting a pull request:
- Keep it focused: Address one issue or feature per PR.
- Provide context: Explain what your changes achieve.
- Pass tests: Ensure that the website can be deployed (see Website Maintenance below).
- Follow guidelines: Use a code review checklist if available.
- Install ruby and all dependencies for Jekyl websites:
- Test serve and inspect result: http://127.0.0.1:4000/
bundle exec jekyll serve - Git commit and push
- Check that the workflow is successful in https://github.com/INTO-CPS-Association/DTEngineeringBook/actions
- Enabling mathjax in markdown content: https://www.iangoodfellow.com/blog/jekyll/markdown/tex/2016/11/07/latex-in-markdown.html
- Enabling
$as math delimiters: https://docs.mathjax.org/en/latest/input/tex/delimiters.html#tex-delimiters