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

Dockerfile and Documentation Changes #53

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Conversation

shihab-dls
Copy link
Contributor

Documentation:

  • Documentation is now in updated python-copier template.
  • Documentation is split into three sections, representing the rootfs how to guides.
  • File structure for the inclusion of overarching tutorials, references, how-to, and explanations sections (such as in PandABlocks.github.io repo) is maintained, in case new additions to these sections is made in the future. These files are excluded in conf.py (to allow for build without references to them); thus, this must be amended for new additions.

Dockerfile:

  • Dockerfile now supports IRIS runners.
  • Local build routine remains one-to-one with previous dev-container. Alpha release 3.1a3 is currently used on FPGA runners; thus, once Dockerfile merged, runners should run on pandablock-dev-container:latest.

src/pandablocks/_version.py Outdated Show resolved Hide resolved
docs/how-to/building.md Outdated Show resolved Hide resolved
docs/how-to/building.md Outdated Show resolved Hide resolved
docs/how-to/building.md Show resolved Hide resolved
.github/CONTRIBUTING.md Show resolved Hide resolved
docs/how-to/remote.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/dependabot.yml Outdated Show resolved Hide resolved
Dockerfile Show resolved Hide resolved
Dockerfile Show resolved Hide resolved
@shihab-dls
Copy link
Contributor Author

Empty sidebar removed by setting html_sidebar = { "***" = [] } for the included pages. Must be amended if more files are included...

@tomtrafford tomtrafford requested a review from coretl May 22, 2024 07:33
tomtrafford
tomtrafford previously approved these changes Jul 2, 2024
@tomtrafford
Copy link
Contributor

@coretl would you be able to have a look through this PR too? It's got prerequisite changes to these changes in the FPGA repo

Copy link
Contributor

@coretl coretl left a comment

Choose a reason for hiding this comment

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

A skim looks ok, I recomment asking @gilesknap about whether this is the best way to make the container into an actions runner. I would at least put it in a different stage so you don't get it all when you use the container as a dev container

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants