oceanhackweek / oceanhackweek/oceanhackweek.github.io
Verify setup for ohw-tutorials submodule
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 12
- Forks
- 49
- Avg merge
- 19m
- Merged PRs (30d)
- 1
Description
@abkfenris:
I'm copying your comment from https://github.com/oceanhackweek/oceanhackweek.github.io/pull/261#issuecomment-1650373948
The tutorials are linked via a git submodule which is defined here, but there is an incantation for adding them that I don't remember at the moment, but here is the PR when I set things up that way.
The .gitmodules setup seems straightforward. Once we have a tutorials OHW23 branch, we'll copy and adapt the ohw22 block to this:
[submodule "ohw23/tutorials"]
path = ohw23/tutorials
url = https://github.com/oceanhackweek/ohw-tutorials.git
branch = OHW23
The incantation you referred to seems to be the
with:
submodules: true
blocks in workflows/check_sphinx_build.yml and workflows/deploy-docs.yml. If so, it looks like nothing more needs to be done.
Does that look right?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .gitmodules and compare the existing ohw22 block with PR 199, then inspect .github/workflows/check_sphinx_build.yml and .github/workflows/deploy-docs.yml. Verify whether the OHW23 tutorials submodule and both submodule-enabled workflow blocks are sufficient; done means confirming the setup or documenting the missing change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github-actions
- Domain
- build-system, ci-cd
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100