Documentation improvement
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reviewing the existing documentation and front page, then compare them with the Intro to HPC course and its MediaCentral links. Done means adding relevant video links, recording documentation gaps and organisation suggestions as GitHub issues, and requesting feedback from Camilla, Fatima and Brian.
Written by the indexing model from the issue text.
Description
To do:
- Link to our two Moodle courses on our front page
- Link to relevant video sections from the Intro to HPC course using the MediaCentral links in suitable places throughout our docs
- Identify gaps in documentation and add these as GitHub issues in that repository.
- eg the walkthroughs section is fairly empty
- Identify whether there are changes to the organisation of our docs that would be helpful and add these suggestions as one or more GitHub issues in that repository.
- eg are there places you would expect certain information to be and it isn't
- are you looking for info and can't work out where it should be found
- After the first pass through and suggestions, see if Camilla, Fatima and Brian have any additional thoughts or feedback.
- Dominant language
- Rich Text Format
- Stars
- 41
- Forks
- 22
- Avg merge
- 1m
- Merged PRs (30d)
- 14
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.
More from UCL-ARC/mkdocs-rc-docs
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
UCL-ARC/mkdocs-rc-docs#177 · 1 comment ·
-
ACFS correction Open
Difficulty 1/5 Under an hour Newbie friendliness 72/100
UCL-ARC/mkdocs-rc-docs#76 · 2 comments ·
-
Licence missing Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
UCL-ARC/mkdocs-rc-docs#133 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
UCL-ARC/mkdocs-rc-docs#86 ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
UCL-ARC/mkdocs-rc-docs#63 · 3 comments ·
All issues in UCL-ARC/mkdocs-rc-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·