-
Notifications
You must be signed in to change notification settings - Fork 2
Technical debt stand down Documentation
This page describes the work done as part of the documentation stand down on 2nd February 2018.
- Developer: Dom
- Reviewer: None
- Current status: In progress
The IOC pages are messy, I will tidy them up
- Developer: Adrian/Tom
- Reviewer: None
- Current status: In progress
As a developer, I would like the wiki to be spell checked so that I can be confident in the high quality of language use in the documentation.
I'm writing this as a general purpose unit test framework for the wikis so that we can add additional tests later on.
- Developer: John
- Reviewer: None
- Current status: In progress
Complete the page Major-Components-of-Ibex-Server.
- None directly
- Spell checker provides a test report for mis-spelled words in the wiki, along with their location
- There are no false positives reported by the spell checker. Common project specific words will be ignored
- The test can be run on individual files or the whole wiki
- The spell checker supports RST and markdown format (i.e. can be used on developer and user manual)
- Developer: Aidan
- Reviewer: None
- Current status: In progress
As a user I would like a more complete glossary for terms I may not have come across before.
- Developer: Freddie
- Reviewer: None
- Current status: Ready for review at https://github.com/ISISComputingGroup/ibex_user_manual/wiki/Switching-Between-IBEX-and-SECI
As an instrument scientist I would like to know how to move between SECI and IBEX
Move work in progress here when it's ready for review.
- Developer: Eilidh
- Reviewer: Tom
- Current status: Ready for review: Page Link . Linked from Dev Manual under 'New Starters'.
As a new member of the IBEX team, I'd like accessible and comprehensive info on getting started with EPICS/IBEX.