-
-
Notifications
You must be signed in to change notification settings - Fork 59
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
Add documentation for micro-manager installation #270
Add documentation for micro-manager installation #270
Conversation
IMO, this should go under "tools" and only be linked. The actual content should be in the micro-manager repo. Similarly to e.g. the OpenFOAM adapter. |
path = imported/aste | ||
url = https://github.com/precice/aste.git | ||
branch = develop | ||
[submodule "imported/micro-manager"] | ||
path = imported/micro-manager | ||
url = https://github.com/precice/micro-manager.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why no branch
for the micro-manager
here?
I guess the workflow is failing because the pages don't yet exist in the default branch (main): https://github.com/precice/micro-manager/tree/main/docs
Subproject: imported/openfoam-adapter/docs
Adding pages: README.md, openfoam-support.md, config.md, get.md, extend.md
Tutorials: No subproject found at imported/micro-manager/docs
Subproject: imported/micro-manager/docs
------------------------------------------------
Jekyll 4.2.2 Please append `--trace` to the `build` command
for any additional information or backtrace.
------------------------------------------------
/home/runner/work/precice.github.io/precice.github.io/website/_plugins/subprojects.rb:22:in `block in generate': No subproject found at imported/micro-manager/docs (RuntimeError)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for noticing this! The website building still fails, but this was definitely an issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know, but I am confused by this line:
Tutorials: No subproject found at imported/micro-manager/docs
Where should the Tutorials:
come from?
The pipeline fails because the micro-manager submodule is imported at this commit for some reason and not at develop as specified in |
Ah it was already described in the README :) |
Correct.
Almost... The website points to specific submodule commits, but triggering this workflow on the website repository updates the submodules. This is done automatically by workflows in each of the source repositories, with such a workflow. You actually should add a similar file here as well. |
The first release of the micro-manager is coming up, adding information on installation on the website would be ideal.
However, as the micro manager is not directly a language binding or an adapter, I am not sure where to put the information. The two options I see are with the provided adapters or in the installation tab under the language bindings.