digitalearthafrica/deafrica-sandbox-notebooks

Update tags in all notebooks

caitlinadams opened this issue · 3 comments

caitlinadams commented

We should go through each notebook and apply common fixes:

  • Keywords (delete tags, move to top of document. Template available)
  • add last tested field, remove last modified field (see Template)
  • Remove logo from first cell

Some guidance on keywords to use: https://github.com/digitalearthafrica/deafrica-sandbox-notebooks/wiki/List-of-Documentation-Keywords

Tags need to be changed in every notebook, according to the following practices:

  • We're now going to refer to tags as keywords, and you should think of them as such. Importantly: what are the five most important concepts that will help a user (1) Understand what the notebook is about (2) quickly find the information they want if they're looking at the Docs page index.
  • Keywords can be hierarchical: for example data; landsat 8 and data; sentinel 2 would show up as the header "data" followed by subheaders for "landsat 8" and "sentinel-2" (both of which would link back to the pages they were used on.
  • We're going to move the Keywords up to the top of the notebook (tags were kept at the bottom). This means if a user goes to the notebook by using a keyword in the index, they'll be taken to the top of the notebook rather than the bottom. The keywords cell should sit just below the first cell (which contains the title and the data used)

Examples of output using hierarchies:
Screen Shot 2021-03-03 at 4 27 19 pm

Screen Shot 2021-03-03 at 4 27 12 pm

Screen Shot 2021-03-03 at 4 26 59 pm

Beginner's Guide - Caitlin

  • 01_Jupyter_notebooks.ipynb

Keywords used:
:index:beginner's guide; jupyter notebook, :index:jupyter notebook; beginner's guide, :index:jupyter notebook; markdown cell, :index:jupyter notebook; raw cell, :index:jupyter notebook; code cells

  • 02_Products_and_measurements.ipynb

Keywords used:
:index:beginner's guide; products, :index:beginner's guide; measurements, :index:products; beginner's guide, :index:measurements; beginner's guide, :index:data used; landsat 8

  • 03_Loading_data.ipynb

Keywords used:
:index:beginner's guide; loading data, :index:loading data; beginner's guide, :index:data used; landsat 8 geomedian, :index:data used; WoFS, :index:data methods; resampling :index:data methods; reprojecting, :index:data attributes; coordinate reference system

  • 04_Plotting.ipynb
  • 05_Basic_analysis.ipynb
  • 06_Intro_to_numpy.ipynb
  • 07_Intro_to_xarray.ipynb
  • 08_Parallel_processing_with_dask.ipynb

Datasets - Ee-Faye

  • Climate_Data_ERA5_AWS.ipynb
  • Fractional_cover.ipynb
  • Landsat_collections.ipynb
  • Landsat_collections_quick-guide.ipynb
  • Sentinel_1.ipynb
  • Sentinel_2.ipynb
  • Soil_Moisture.ipynb
  • Water_Observations_from_Space.ipynb

Frequently Used Code - Chad

  • Analyse_multiple_polygons.ipynb

Keywords used:
:index:spatial analysis; polygons, :index:data used; landsat 8, :index:python package; GeoPandas, :index:band index; NDVI

  • Animated_timeseries.ipynb
  • Applying_WOfS_bitmasking.ipynb
  • Calculating_band_indices.ipynb
  • Contour_extraction.ipynb
  • Exporting_GeoTIFFs.ipynb
  • Generating_composites.ipynb
  • Generating_geomedian_composites.ipynb
  • Geomedian_composites.ipynb
  • Image_segmentation.ipynb
  • Imagery_on_web_map.ipynb
  • Integrating_external_data.ipynb
  • Masking_data.ipynb
  • Monitoring_water_quality.ipynb
  • Principal_component_analysis.ipynb
  • Rasterise_vectorise.ipynb
  • Rasterize_vectorize.ipynb
  • Reprojecting_data.ipynb
  • Tidal_modelling.ipynb
  • Urban_index_comparison.ipynb
  • Using_load_ard.ipynb
  • Vegetation_phenology.ipynb
  • Working_with_time.ipynb

Real World Examples

  • Burnt_area_mapping.ipynb
  • Change_filmstrips.ipynb
  • Chlorophyll_monitoring.ipynb
  • Coastal_erosion.ipynb
  • Crop_health.ipynb
  • Intertidal_elevation.ipynb
  • Machine_learning_with_ODC.ipynb
  • Mangrove_analysis.ipynb
  • Radar_water_detection.ipynb
  • Urban_change_detection.ipynb
  • Vegetation_change_detection.ipynb
  • Water_extent.ipynb
  • Wetlands_insight_tool.ipynb
cbur24 commented

Should the changes to Tags/keywords be done in the minty-fresh-sandbox branch or the minty-fresh-indexing branch?

caitlinadams commented

Probably best to do in minty-fresh-indexing, but can be done in minty-fresh-sandbox if you're confident you're not working on the same notebook as someone else who is doing a different kind of change. As long as we keep merging the updated minty-fresh-sandbox branch into minty-fresh-indexing there shouldn't be any issues

  • 👍1
caitlinadams commented

Note that changes on the built docs page will only appear if they're made to minty-fresh-sandbox, so we'll have to go back and check for issues on the built page whenever we merge minty-fresh-indexing into minty-fresh-sandbox.