processes

Author: Tom-Willemsen

doc/Deployment.md

@@ -1,4 +1,4 @@
-> [Wiki](Home) > [Deployment](Deployment)
+# Deployment
 
 - [Deployment Strategy](Deployment-strategy)
 - [Creating a Release](Creating-a-release)

doc/Instrument-Details.rst renamed to doc/Instrument-Details.md

@@ -1,12 +1,11 @@
-Instrument Details
-==================
+# Instrument Details
 
 These instrument details pages provide historical context about the devices on a specific instrument,
 at the time they were migrated to IBEX.
-
-.. toctree::
-   :titlesonly:
-   :glob:
-   :maxdepth: 1
 
-   instrument-details/*
+```{toctree} Instrument Details
+:glob:
+:maxdepth: 1
+
+instrument-details/*
+```

doc/Processes.md

@@ -1,40 +1,72 @@
-> [Wiki](Home) > [Processes](Processes)
+# Processes
 
 Various Processes or tasks and info into how they should work. Remember rules can be bent or broken but think about why you are doing that.
 
-- [Modifying Code on an instrument or Fixing bugs on an Instrument](Modifying-Code-on-an-instrument)
+## Patching
 
-- [Modifying/setting up a device on an instrument](Modifying-Device-on-an-Instrument)
+```{toctree}
+:glob:
+:titlesonly:
 
-**Workflow:**
-- [Tickets and their Workflow](Tickets-and-their-Workflow)
-- [Git Workflow](https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Git-workflow)
-- [Program Increment Planning](Program-Increment-Planning)
--  **Sprints:**
-    - [Meeting Roles and Rotas](Meeting-Roles-and-Rotas)
-    - [Estimating Sprint Capacity](Estimating-Sprint-Capacity)
-    - [Sprint Burn down Chart](Sprint-Burn-down-Chart)
-    - [The PM Workbook](PM-Workbook)
-    - **Meetings:**
-        - [Backlog Preparation/Pre-Planning](Backlog-Preparation) - This meeting is unlikely to occur
-        - [Sprint Planning](Sprint-Planning)
-        - [Sprint Review](Sprint-Review)
-        - [Sprint Retrospective](Sprint-Retrospective)
+processes/Modifying-Code-on-an-instrument
+processes/Modifying-Device-on-an-Instrument
+```
 
-- [External Contributions](External-Contributions)
+## Development
 
-- [Regular Demos of IBEX to Scientists](Regular-Demos-of-IBEX-to-Scientists) 
+```{toctree}
+:glob:
+:titlesonly:
 
-- Special Days
-    - [Friday Quality Time](Friday-Quality-Time) 
-    - [Technical Debt Stand-down](Technical-Debt-Stand-down)
+processes/Git-workflow
+processes/Tickets-and-their-Workflow
+processes/Umbrella-Tickets
+processes/Dependency-Updates
+processes/External-Contributions
+```
 
-- [Training Instrument Scientists in IBEX](Training-Instrument-Scientists-in-IBEX)
+## Internal meetings
 
-- [Prioritisation of tickets](Prioritisation-of-Tickets)
+```{toctree}
+:glob:
+:titlesonly:
 
-- [Umbrella Tickets](Umbrella-Tickets) Creation of an umbrella/epic tickets or spins inside an umbrella/epic ticket
+processes/Meeting-Roles-and-Rotas
+processes/Backlog-Preparation
+processes/Sprint-Planning
+processes/Sprint-Review-and-Retro
+processes/Program-Increment-Planning
+processes/Technical-Debt-Stand-down
+```
 
-- [Dependency Update](Dependency-updates)
+## External meetings
 
-- [Obtaining access to the Instrument Hall](Obtaining-access-to-the-Instrument-Hall)
+```{toctree}
+:glob:
+:titlesonly:
+
+processes/Regular-Demos-of-IBEX-to-Scientists
+processes/Training-Instrument-Scientists-in-IBEX
+```
+
+## Project management
+
+```{toctree}
+:glob:
+:titlesonly:
+
+processes/PM-Workbook
+processes/Estimating-Sprint-Capacity
+processes/Sprint-Burn-down-Chart
+processes/Prioritisation-of-Tickets
+```
+
+## Admin
+
+```{toctree}
+:glob:
+:titlesonly:
+
+processes/Obtaining-access-to-the-Instrument-Hall
+processes/Remote-Working
+```

doc/Retrospective-Notes.md

@@ -0,0 +1,11 @@
+# Sprint Retrospective Notes
+
+Notes from sprint retrospective meetings.
+
+```{toctree} Retrospective Notes
+:reversed:
+:glob:
+:maxdepth: 1
+
+retrospective-notes/*
+```

doc/Retrospective-Notes.rst

@@ -2,20 +2,28 @@ IBEX Developer's manual
 ===============
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Tutorial
-   :glob:
-
-   tutorial/overview.md
+   :maxdepth: 1
+   :caption: IBEX Server
+   
+.. toctree::
+   :maxdepth: 1
+   :caption: User Interface
+   
+.. toctree::
+   :maxdepth: 1
+   :caption: Deployment
+   
+   Deployment
 
 .. toctree::
    :maxdepth: 1
-   :caption: Instrument Details
+   :caption: Project Processes & Meetings
 
-   Instrument-Details.rst
+   Processes
+   Retrospective-Notes
 
 .. toctree::
    :maxdepth: 1
-   :caption: Retrospective Notes
+   :caption: Instrument Migration Notes
 
-   Retrospective-Notes.rst
+   Instrument-Details

doc/Sprint-Retrospective.md

@@ -1,3 +1,3 @@
-> [Wiki](Home) > [Processes](Processes) > [Backlog Preparation](Backlog-Preparation)
+# Sprint pre-planning
 
 This meeting is often called pre-planning. This meeting is just a pre-runner to sprint planning and shares the same process see  [Sprint Planning](Sprint-Planning).