Merge branch 'master' into NA/guides_17

Author: nanaeaubry

docker/NotebookImage.Dockerfile

@@ -1,30 +1,31 @@
 ARG python_version="3.11"
-FROM quay.io/jupyter/base-notebook:python-${python_version}
+FROM quay.io/jupyter/minimal-notebook:python-${python_version}
 
 ARG python_version
-ARG arcgis_version="2.3.1"
+ARG arcgis_version="2.4.0"
 ARG sampleslink="https://github.com/Esri/arcgis-python-api/releases/download/v${arcgis_version}/samples.zip"
 ARG githubfolder="arcgis-python-api"
-ENV DOCKER_STACKS_JUPYTER_CMD="notebook"
+ARG env_name=arcgis
 
 LABEL org.opencontainers.image.authors="[email protected]"
-LABEL org.opencontainers.image.description="Jupyter Notebook with the latest version of the ArcGIS API for Python and its Linux dependencies preinstalled"
+LABEL org.opencontainers.image.description="Jupyter environment preconfigured for ArcGIS API for Python"
 LABEL org.opencontainers.image.licenses=Apache
 LABEL org.opencontainers.image.source=https://github.com/Esri/arcgis-python-api
 
-USER root
-
-RUN apt-get update --yes && \
-    apt-get install --yes --no-install-recommends unzip && \
-    apt-get clean && rm -rf /var/lib/apt/lists/*
-
 USER ${NB_UID}
 
 # Install Python API from Conda
-RUN conda install -c esri arcgis=${arcgis_version} -y \
+RUN conda create -n ${env_name} -c esri -c defaults arcgis=${arcgis_version} python=${python_version} -y --quiet --override-channels \
     && conda clean --all -f -y \
     && find /opt/conda -name __pycache__ -type d -exec rm -rf {} +
 
+# Install arcgis-mapping if arcgis_version >= 2.4.0
+RUN (dpkg --compare-versions $arcgis_version ge 2.4.0 \
+    && conda install -n ${env_name} -c esri -c defaults arcgis-mapping -y --quiet --override-channels \
+    && conda clean --all -f -y \
+    && find /opt/conda -name __pycache__ -type d -exec rm -rf {} +;) \
+    || echo "[INFO] Skipped installing arcgis-mapping for version $arcgis_version (>= 2.4.0 required for arcgis-mapping)"
+
 # Fetch and extract samples from GitHub
 RUN mkdir /home/${NB_USER}/$githubfolder && \
     wget -O samples.zip $sampleslink \
@@ -36,7 +37,34 @@ RUN mkdir /home/${NB_USER}/$githubfolder && \
            work/ \
            talks/ \
            environment.yml\
+    # remove .DS_Store and __MACOSX from home directory:
+    && find /home/${NB_USER} -name ".DS_Store" -delete \
+    && rm -rf /home/${NB_USER}/__MACOSX \
     && fix-permissions /home/${NB_USER}
 
-RUN rm /opt/conda/lib/python${python_version}/site-packages/notebook/static/base/images/logo.png
-COPY --chown=${NB_USER}:users jupyter_esri_logo.png /opt/conda/lib/python${python_version}/site-packages/notebook/static/base/images/logo.png
+# See https://jupyter-docker-stacks.readthedocs.io/en/latest/using/recipes.html#add-a-custom-conda-environment-and-jupyter-kernel
+# Create Python kernel and link it to jupyter
+RUN "${CONDA_DIR}/envs/${env_name}/bin/python" -m ipykernel install --user --name="${env_name}" && \
+    fix-permissions "${CONDA_DIR}" && \
+    fix-permissions "/home/${NB_USER}"
+
+
+# More information here: https://github.com/jupyter/docker-stacks/pull/2047
+USER root
+
+# Set DOCKER_STACKS_JUPYTER_CMD to "notebook" for versions less than 2.4.0
+RUN \
+    (dpkg --compare-versions $arcgis_version lt 2.4.0 \
+    && echo 'DOCKER_STACKS_JUPYTER_CMD="notebook"' >> /etc/environment \
+    && echo "[INFO] Set DOCKER_STACKS_JUPYTER_CMD to notebook for arcgis < 2.4.0") \
+    || echo "[INFO] Using default DOCKER_STACKS_JUPYTER_CMD (lab) for arcgis >= 2.4.0"
+
+RUN \
+    # This changes a startup hook, which will activate the custom environment for the process
+    echo conda activate "${env_name}" >> /usr/local/bin/before-notebook.d/10activate-conda-env.sh && \
+    # This makes the custom environment default in Jupyter Terminals for all users which might be created later
+    echo conda activate "${env_name}" >> /etc/skel/.bashrc && \
+    # This makes the custom environment default in Jupyter Terminals for already existing NB_USER
+    echo conda activate "${env_name}" >> "/home/${NB_USER}/.bashrc"
+
+USER ${NB_UID}

guide/02-api-overview/deprecation-notices.ipynb

@@ -28,6 +28,7 @@
     "- `Swipe.edit` - deprecated in **2.4.0** removed in future major release. Use the `content` property setter instead.\n",
     "- `MapAction` - deprecated in **2.4.0** removed in future major release. Use the `MediaAction` class instead.\n",
     "- `JournalStoryMap` - deprecated in **2.0.0** removed in **2.4.0**.  Template was removed from the ArcGIS platform.\n",
+    "- `Hub.initiatives` - deprecated in **2.4.0** removed in a future release. Use `Hub.sites` instead.\n",
     "\n",
     "\n",
     "### `arcgis.learn` Module\n",
@@ -189,7 +190,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.14"
+   "version": "3.11.5"
   }
  },
  "nbformat": 4,

guide/02-api-overview/overview24.ipynb

@@ -20,6 +20,17 @@
     "Primary Python Support is for version 3.11.  Secondary support is provided for Python 3.10 and 3.12.  We have dropped Support for Python 3.9."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "ff163308-2526-4b3a-965b-5b430738c5f8",
+   "metadata": {},
+   "source": [
+    "> **Note:** The ArcGIS API for Python 2.4.0 release is supported with:\n",
+    "* ArcGIS Pro 3.4 and later cloned environments\n",
+    "* ArcGIS Enterprise 11.4 and later\n",
+    "* Stand-alone _conda_ and Python environments"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "3da4c48b-3c82-490f-9b76-d2063307b56c",
@@ -481,7 +492,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.11.10"
   }
  },
  "nbformat": 4,

guide/02-api-overview/release_notes_240.ipynb

@@ -7,6 +7,8 @@
    "source": [
     "# What's new in version 2.4.0\n",
     "\n",
+    "> **Note:** The ArcGIS API for Python 2.4.0 release is supported with ArcGIS Pro 3.4 and later cloned environments for use with _arcpy_.  The 2.4.0 _arcgis_ and _arcgis-mapping_ packages are incompatible with ArcGIS Pro 3.3.x and earlier cloned environments.  The default ArcGIS Pro 3.3.x environment can be cloned and upgraded to _arcgis_ packages of 2.3.x.\n",
+    "\n",
     "## New\n",
     "Reorganized modules and refactored functionality into new classes to incorporate the new Jupyter Lab and Notebook 7 architectures.\n",
     "* Deprecated modules:\n",
@@ -492,7 +494,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.11.10"
   },
   "toc": {
    "base_numbering": 1,

guide/03-the-gis/accessing-and-creating-content.ipynb

@@ -1425,7 +1425,7 @@
    "source": [
     "## Creating new content\n",
     "\n",
-    "To create new items on your GIS, use the [`add()`](/api-reference/arcgis.gis.toc.html#arcgis.gis._impl._content_manager.Folder.add) method on a [`Folder`](/python/api-reference/arcgis.gis.toc.html#folder) instance. You can get an individual _folder_ using the [`Folders.get()`](/python/api-reference/arcgis.gis.toc.html#arcgis.gis._impl._content_manager.Folders.get) method.\n",
+    "To create new items on your GIS, use the [`add()`](https://developers.arcgis.com/python/latest/api-reference/arcgis.gis.toc.html#arcgis.gis._impl._content_manager.Folder.add) method on a [`Folder`](/python/api-reference/arcgis.gis.toc.html#folder) instance. You can get an individual _folder_ using the [`Folders.get()`](/python/api-reference/arcgis.gis.toc.html#arcgis.gis._impl._content_manager.Folders.get) method.\n",
     "\n",
     "The `add()` method accepts a dictionary containing the properties of the item to be created. The optional `file`, `text`, `url`, and `data_url` parameters accept input to add the actual content. \n",
     "\n",

guide/03-the-gis/managing-your-gis-servers.ipynb

@@ -311,10 +311,10 @@
     "- esriFieldTypeOID\n",
     "- esriFieldTypeGeometry\n",
     "    - with this type, you also need to [define geometryType](https://github.com/Esri/knowledge-pbf/blob/master/proto/esriPBuffer/EsriTypes.proto):\n",
-    "        - esriGeometryTypePoint\n",
-    "        - esriGeometryTypePolyline\n",
-    "        - esriGeometryTypePolygon\n",
-    "        - esriGeometryTypeMultipoint\n",
+    "        - esriGeometryPoint\n",
+    "        - esriGeometryPolyline\n",
+    "        - esriGeometryPolygon\n",
+    "        - esriGeometryMultipoint\n",
     "- esriFieldTypeGUID\n",
     "- esriFieldTypeGlobalID\n"
    ]
@@ -337,7 +337,7 @@
     "    },{\n",
     "        \"name\": \"shape\",\n",
     "        \"fieldtype\": \"esriFieldTypeGeometry\",\n",
-    "        \"geometryType\": \"esriGeometryTypePoint\"\n",
+    "        \"geometryType\": \"esriGeometryPoint\"\n",
     "    }]\n",
     ")"
    ]