Merge branch 'feature/more-planning-notes'

docs/source/index.rst

@@ -12,5 +12,5 @@ GÉANT Mapping Provider documentation
    :caption: Contents:
 
    api
-   planning
+   planning/index
 

docs/source/planning.rst → docs/source/planning/hld.rst

-Planning, Design, etc
+High-Level Design
 =====================================
 
 .. contents:: Contents
@@ -34,80 +34,13 @@ Ideas
 
 - For the Geant-managed heat maps: maybe nice to agree upon a simple grid-locked geo-node/edge approach
 
-Some R&E Samples
-----------------
-
-- ESNet - Netsage
-
-  - https://portal.netsage.global
-  - https://www.netsage.global
-  - https://github.com/GlobalNOC/globalnoc-networkmap-panel
-  - https://grafana.com/grafana/plugins/esnet-networkmap-panel/
-  - https://github.com/esnet/grafana-esnet-networkmap-panel/tree/main
-
-- Jisc - Netsight3
-
-  - https://www.jisc.ac.uk/netsight
-  - https://netsight3.ja.net/help/
-
-- SURF Netwerk Dashboard
-
-  - https://netwerkdashboard.surfnet.nl/
-
-- Reannz weathermap:
-
-  - https://weathermap.reannz.co.nz/
-
-- Funet network load map:
-
-  - https://netmap.funet.fi/
-
-- NORDUnet:
-
-  - https://stats.nordu.net/stat-q/load-map/ndn-map,,traffic,peak
-
-- Pionier/PSNC:
-
-  - https://pionier.net.pl/en/about-pionier/#interaktywna_mapa_sieci_pionier
-
-- Timemap (WP6, mainly GARR)
-
-  - https://timemap.geant.org/
-  - https://gitlab.geant.org/fabio.farina/timemap (New link https://gitlab.software.geant.org/fabio.farina/timemap )
-
-Misc Internal things
---------------------
-
-- IS/IS-driven: http://netdash.geant.net:8080/static/isis/geantISIS.svg
-- Intermapper
-
-  - https://weathermap.geant.org/g59bce200/document/_/!index.html?REFRESH=10+Seconds
-
-- ULAKBIM
-
-  - https://stat.ulakbim.gov.tr/ulaknet/
-
-
-NRENS with their network info
-------------------------------
-
-.. include:: nren-maps.html
-
-
-FrontEnd Technologies worth exploring
---------------------------------------
-
-- Openlayers : https://openlayers.org/
-- Leaflet : https://leafletjs.com/
-- GeoJson : https://geojson.io/#map=3.53/43.52/6.81
-
 
 High-Level Architecture
 -------------------------
 
 .. only:: drawio
 
-   .. drawio-image:: diagrams.drawio
+   .. drawio-image:: design.drawio
       :page-name: hl-arch
 
 Design/Edit concerns for subway map
@@ -135,7 +68,9 @@ Design/Edit concerns for subway map
       - front end will update svg based on mapping-provider overlay data
 
 
+FrontEnd Technologies worth exploring
+--------------------------------------
 
-
-
-
+- Openlayers : https://openlayers.org/
+- Leaflet : https://leafletjs.com/
+- GeoJson : https://geojson.io/#map=3.53/43.52/6.81

docs/source/planning/index.rst

+Planning, Design, etc
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   survey
+   hld
+   planning

docs/source/planning/planning.rst

+Planning Milestones
+=====================================
+
+.. contents:: Contents
+   :depth: 4
+   :local:
+
+
+Availability POC
+---------------------
+
+- mapping provider should
+  
+  - be deployed on test, uat, prod with a standard release pipeline
+  - serve some api's that give lists of routers, sites, trunks
+  - serve some api that gives availabilituy of each trunk
+
+- some mapping between human-readable trunk names and scid's
+- some simple svg that allows edge styles to be updated based on availability
+- Jira Version: `AVAILABILITY_POC <https://jira.software.geant.org/secure/RapidBoard.jspa?rapidView=126&projectKey=NGM&view=planning.nodetail&versions=visible&issueLimit=100&selectedVersion=12800#>`_

docs/source/planning/survey.rst

+Surveys of Existing Projects
+=====================================
+
+.. contents:: Contents
+   :depth: 4
+   :local:
+
+Some R&E Samples
+----------------
+
+- ESNet - Netsage
+
+  - https://portal.netsage.global
+  - https://www.netsage.global
+  - https://github.com/GlobalNOC/globalnoc-networkmap-panel
+  - https://grafana.com/grafana/plugins/esnet-networkmap-panel/
+  - https://github.com/esnet/grafana-esnet-networkmap-panel/tree/main
+
+- Jisc - Netsight3
+
+  - https://www.jisc.ac.uk/netsight
+  - https://netsight3.ja.net/help/
+
+- SURF Netwerk Dashboard
+
+  - https://netwerkdashboard.surfnet.nl/
+
+- Reannz weathermap:
+
+  - https://weathermap.reannz.co.nz/
+
+- Funet network load map:
+
+  - https://netmap.funet.fi/
+
+- NORDUnet:
+
+  - https://stats.nordu.net/stat-q/load-map/ndn-map,,traffic,peak
+
+- Pionier/PSNC:
+
+  - https://pionier.net.pl/en/about-pionier/#interaktywna_mapa_sieci_pionier
+
+- Timemap (WP6, mainly GARR)
+
+  - https://timemap.geant.org/
+  - https://gitlab.geant.org/fabio.farina/timemap (New link https://gitlab.software.geant.org/fabio.farina/timemap )
+
+Misc Internal things
+--------------------
+
+- IS/IS-driven: http://netdash.geant.net:8080/static/isis/geantISIS.svg
+- Intermapper
+
+  - https://weathermap.geant.org/g59bce200/document/_/!index.html?REFRESH=10+Seconds
+
+- ULAKBIM
+
+  - https://stat.ulakbim.gov.tr/ulaknet/
+
+
+NRENS with their network info
+------------------------------
+
+.. include:: nren-maps.html