Use custom iree.dev domain in links to documentation site. (#15036)

Follow-up to #15008 and some GitHub configuration changes that switched us to using a custom domain for our GitHub pages hosting. Background: * We acquired this domain for hosting https://perf.iree.dev/ years ago, with some aspirations to use the domain for other pages eventually. * We tried to use the domain with our GitHub Pages content at one point, but ran into some issues that resulted in buggy redirects and certificate errors. A few weeks ago we tried that again and succeeded. Note that we had also considered using the `docs` subdomain, i.e. `https://docs.iree.dev/`. That still seems tempting, but would require more domain configuration work. Until we use a subdomain like that or explore the workarounds in https://github.com/orgs/community/discussions/23184, the `www` part of URLs is required.
iree-org · Oct 24, 2023 · 8c34b97 · 8c34b97
1 parent 094d9ba
commit 8c34b97
Show file tree

Hide file tree

Showing 46 changed files with 67 additions and 67 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -16,7 +16,7 @@ contact:
     email: laurenzo@google.com
     affiliation: Google
 license: "Apache-2.0 WITH LLVM-exception"
-url: "https://openxla.github.io/iree/"
+url: "https://iree.dev/"
 repository-code: "https://github.com/openxla/iree"
 keywords:
   - compiler

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ compiler and runtime that lowers Machine Learning (ML) models to a unified IR
 that scales up to meet the needs of the datacenter and down to satisfy the
 constraints and special considerations of mobile and edge deployments.
 
-See [our website](https://openxla.github.io/iree/) for project details, user
+See [our website](https://iree.dev/) for project details, user
 guides, and instructions on building from source.
 
 [![CI Status](https://github.com/openxla/iree/actions/workflows/ci.yml/badge.svg?query=branch%3Amain+event%3Apush)](https://github.com/openxla/iree/actions/workflows/ci.yml?query=branch%3Amain+event%3Apush)
@@ -41,7 +41,7 @@ of feedback on any [communication channels](#communication-channels)!
 ![IREE Architecture](docs/website/docs/assets/images/iree_architecture_dark.svg#gh-dark-mode-only)
 ![IREE Architecture](docs/website/docs/assets/images/iree_architecture.svg#gh-light-mode-only)
 
-See [our website](https://openxla.github.io/iree/) for more information.
+See [our website](https://iree.dev/) for more information.
 
 ## Presentations and Talks
 

diff --git a/build_tools/benchmarks/comparisons/README.md b/build_tools/benchmarks/comparisons/README.md
@@ -30,7 +30,7 @@ When running benchmarks on an Android device, some initial setup is involved.
 ### Install Android NDK and ADB
 
 Detailed steps
-[here](https://openxla.github.io/iree/building-from-source/android/#install-android-ndk-and-adb).
+[here](https://iree.dev/building-from-source/android/#install-android-ndk-and-adb).
 
 ### Install the Termux App and the Python Interpreter
 

diff --git a/build_tools/benchmarks/comparisons/setup_mobile.sh b/build_tools/benchmarks/comparisons/setup_mobile.sh
@@ -6,7 +6,7 @@
 
 # Run commands below on the workstation that the phone is attached to.
 # Prerequisites:
-#   Manual installations of the Android NDK and ADB are needed. See https://openxla.github.io/iree/building-from-source/android/#install-android-ndk-and-adb for instructions.
+#   Manual installations of the Android NDK and ADB are needed. See https://iree.dev/building-from-source/android/#install-android-ndk-and-adb for instructions.
 #   Manual installations of the Termux App and python are needed on the Android device. See README.md for instructions.
 
 #!/bin/bash

diff --git a/build_tools/cmake/iree_benchmark_suite.cmake b/build_tools/cmake/iree_benchmark_suite.cmake
@@ -33,7 +33,7 @@ function(iree_import_tflite_model)
                       " that iree-import-tflite be available "
                       " (either on PATH or via IREE_IMPORT_TFLITE_PATH). "
                       " Install from a release with "
-                      " `python -m pip install iree-tools-tflite -f https://openxla.github.io/iree/pip-release-links.html`")
+                      " `python -m pip install iree-tools-tflite -f https://iree.dev/pip-release-links.html`")
   endif()
 
   if(NOT TARGET "${_RULE_TARGET_NAME}")
@@ -88,7 +88,7 @@ function(iree_import_tf_model)
                       " that iree-import-tf be available "
                       " (either on PATH or via IREE_IMPORT_TF_PATH). "
                       " Install from a release with "
-                      " `python -m pip install iree-tools-tf -f https://openxla.github.io/iree/pip-release-links.html`")
+                      " `python -m pip install iree-tools-tf -f https://iree.dev/pip-release-links.html`")
   endif()
 
   if(NOT TARGET "${_RULE_TARGET_NAME}")

diff --git a/compiler/src/iree/compiler/API/Internal/CompilerDriver.cpp b/compiler/src/iree/compiler/API/Internal/CompilerDriver.cpp
@@ -1016,7 +1016,7 @@ GlobalInit *globalInit = nullptr;
 bool isShutdown = false;
 
 void llvmVersionPrinter(llvm::raw_ostream &os) {
-  os << "IREE (https://openxla.github.io/iree):\n  ";
+  os << "IREE (https://iree.dev):\n  ";
   std::string version = mlir::iree_compiler::getIreeRevision();
   if (version.empty()) {
     version = "(unknown)";

diff --git a/docs/api_docs/python/requirements.txt b/docs/api_docs/python/requirements.txt
@@ -6,6 +6,6 @@ enum_tools==0.6.4
 sphinx_toolbox==2.15.0
 
 # IREE Python API
--f https://openxla.github.io/iree/pip-release-links.html
+-f https://iree.dev/pip-release-links.html
 iree-compiler
 iree-runtime
diff --git a/docs/developers/debugging/releases.md b/docs/developers/debugging/releases.md
@@ -17,7 +17,7 @@ Starting in a python venv, you can find the IREE commit from both the shell:
 
 ```shell
 "$(find . -name 'iree-compile' -executable)" --version
-IREE (https://openxla.github.io/iree):
+IREE (https://iree.dev):
   IREE compiler version 20231016.553 @ f1cb2692a086738d7f16274b9b3af6d2c15ef133
   LLVM version 18.0.0git
   Optimized build

diff --git a/docs/developers/debugging/tf_integrations_test_repro.md b/docs/developers/debugging/tf_integrations_test_repro.md
@@ -25,7 +25,7 @@ All steps here assume starting from the IREE root directory.
     # This should work for most cases, as the importers change infrequently
     python -m pip install \
       iree-compiler iree-runtime iree-tools-tf iree-tools-tflite \
-      --find-links https://openxla.github.io/iree/pip-release-links.html
+      --find-links https://iree.dev/pip-release-links.html
     ```
 
     _OR_ build from source

diff --git a/docs/developers/developing_iree/benchmark_suites.md b/docs/developers/developing_iree/benchmark_suites.md
@@ -18,9 +18,9 @@ Information about the definitions of the benchmark suites can be found in the
 
 Install `iree-import-tf` and `iree-import-tflite` in your Python environment
 (see
-[Tensorflow Integration](https://openxla.github.io/iree/guides/ml-frameworks/tensorflow/)
+[Tensorflow Integration](https://iree.dev/guides/ml-frameworks/tensorflow/)
 and
-[TFLite Integration](https://openxla.github.io/iree/guides/ml-frameworks/tflite/)).
+[TFLite Integration](https://iree.dev/guides/ml-frameworks/tflite/)).
 
 ### Choose Benchmark Presets
 

diff --git a/docs/developers/developing_iree/e2e_benchmarking.md b/docs/developers/developing_iree/e2e_benchmarking.md
@@ -9,7 +9,7 @@ This allows us to validate that our benchmarks are behaving as we expect them
 to, and to run them using valid inputs for each model.
 
 This guide assumes that you can run the tensorflow integration tests. See
-[this doc](https://openxla.github.io/iree/building-from-source/getting-started/#python-bindings)
+[this doc](https://iree.dev/building-from-source/getting-started/#python-bindings)
 for more information. That doc also covers writing new tests, which you'll need
 to do if you'd like to benchmark a new TensorFlow model.
 
@@ -180,7 +180,7 @@ $ ./bazel-bin/tensorflow/lite/tools/benchmark/benchmark_model \
 
 IREE only supports compiling to Android with CMake. Documentation on setting up
 your environment to cross-compile to Android can be found
-[here](https://openxla.github.io/iree/building-from-source/android/).
+[here](https://iree.dev/building-from-source/android/).
 
 ```shell
 # After following the instructions above up to 'Build all targets', the

diff --git a/docs/developers/get_started/README.md b/docs/developers/get_started/README.md
@@ -3,7 +3,7 @@
 ---
 
 The primary guides are located at
-<https://openxla.github.io/iree/building-from-source/> (source in
+<https://iree.dev/building-from-source/> (source in
 [the website/ folder](../../website/docs/building-from-source/) )
 
 ---

diff --git a/docs/website/docs/guides/deployment-configurations/cpu.md b/docs/website/docs/guides/deployment-configurations/cpu.md
@@ -62,7 +62,7 @@ The core `iree-compiler` package includes the LLVM-based CPU compiler:
 
     ``` shell
     python -m pip install \
-      --find-links https://openxla.github.io/iree/pip-release-links.html \
+      --find-links https://iree.dev/pip-release-links.html \
       --upgrade iree-compiler
     ```
 

diff --git a/docs/website/docs/guides/deployment-configurations/gpu-cuda.md b/docs/website/docs/guides/deployment-configurations/gpu-cuda.md
@@ -49,7 +49,7 @@ The core `iree-compiler` package includes the CUDA compiler:
 
     ``` shell
     python -m pip install \
-      --find-links https://openxla.github.io/iree/pip-release-links.html \
+      --find-links https://iree.dev/pip-release-links.html \
       --upgrade iree-compiler
     ```
 

diff --git a/docs/website/docs/guides/deployment-configurations/gpu-vulkan.md b/docs/website/docs/guides/deployment-configurations/gpu-vulkan.md
@@ -99,7 +99,7 @@ The core `iree-compiler` package includes the SPIR-V compiler:
 
     ``` shell
     python -m pip install \
-      --find-links https://openxla.github.io/iree/pip-release-links.html \
+      --find-links https://iree.dev/pip-release-links.html \
       --upgrade iree-compiler
     ```
 

diff --git a/docs/website/docs/guides/ml-frameworks/tensorflow.md b/docs/website/docs/guides/ml-frameworks/tensorflow.md
@@ -78,7 +78,7 @@ graph LR
 
         ``` shell
         python -m pip install \
-          --find-links https://openxla.github.io/iree/pip-release-links.html \
+          --find-links https://iree.dev/pip-release-links.html \
           --upgrade \
           iree-compiler \
           iree-runtime \

diff --git a/docs/website/docs/guides/ml-frameworks/tflite.md b/docs/website/docs/guides/ml-frameworks/tflite.md
@@ -73,7 +73,7 @@ graph LR
 
         ``` shell
         python -m pip install \
-          --find-links https://openxla.github.io/iree/pip-release-links.html \
+          --find-links https://iree.dev/pip-release-links.html \
           --upgrade \
           iree-compiler \
           iree-runtime \

diff --git a/docs/website/docs/reference/bindings/python.md b/docs/website/docs/reference/bindings/python.md
@@ -81,7 +81,7 @@ To use IREE's Python bindings, you will first need to install
 
     ``` shell
     python -m pip install \
-      --find-links https://openxla.github.io/iree/pip-release-links.html \
+      --find-links https://iree.dev/pip-release-links.html \
       --upgrade \
       iree-compiler \
       iree-runtime

diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml
@@ -1,5 +1,5 @@
 site_name: IREE
-site_url: https://openxla.github.io/iree/
+site_url: https://iree.dev/
 repo_url: https://github.com/openxla/iree
 repo_name: openxla/iree
 
@@ -52,7 +52,7 @@ extra:
   community_homepage: https://github.com/openxla/community
   community_site_name: OpenXLA
 
-  homepage: https://openxla.github.io/iree/
+  homepage: https://iree.dev/
 
   # TODO(scotttodd): join mkdocs-material insiders and remove notice?
   #   (we *can* remove the notice without joining)

diff --git a/experimental/web/generate_web_metrics.sh b/experimental/web/generate_web_metrics.sh
@@ -66,7 +66,7 @@ trap "deactivate 2> /dev/null" EXIT
 # specific version when iterating on metrics is useful, and fetching is slow.
 
 python -m pip install --upgrade \
-  --find-links https://openxla.github.io/iree/pip-release-links.html \
+  --find-links https://iree.dev/pip-release-links.html \
   iree-compiler iree-tools-tflite
 
 ###############################################################################

diff --git a/integrations/pjrt/requirements.txt b/integrations/pjrt/requirements.txt
@@ -1,4 +1,4 @@
--f https://openxla.github.io/iree/pip-release-links.html
+-f https://iree.dev/pip-release-links.html
 -f https://storage.googleapis.com/jax-releases/jaxlib_nightly_releases.html
 iree-compiler==20230922.653
 jaxlib==0.4.17.dev20230922
diff --git a/samples/colab/low_level_invoke_function.ipynb b/samples/colab/low_level_invoke_function.ipynb
@@ -66,7 +66,7 @@
         "outputId": "0339165a-a35f-4b46-9cf8-f22adc69a7fe"
       },
       "source": [
-        "!python -m pip install iree-compiler iree-runtime -f https://openxla.github.io/iree/pip-release-links.html"
+        "!python -m pip install iree-compiler iree-runtime -f https://iree.dev/pip-release-links.html"
       ],
       "execution_count": 2,
       "outputs": [
@@ -75,7 +75,7 @@
           "name": "stdout",
           "text": [
             "Looking in indexes: https://pypi.org/simple, https://us-python.pkg.dev/colab-wheels/public/simple/\n",
-            "Looking in links: https://openxla.github.io/iree/pip-release-links.html\n",
+            "Looking in links: https://iree.dev/pip-release-links.html\n",
             "Collecting iree-compiler\n",
             "  Downloading https://github.com/openxla/iree/releases/download/candidate-20220929.281/iree_compiler-20220929.281-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (49.7 MB)\n",
             "\u001b[K     |████████████████████████████████| 49.7 MB 99 kB/s \n",

diff --git a/samples/colab/pytorch_aot_simple.ipynb b/samples/colab/pytorch_aot_simple.ipynb
@@ -226,7 +226,7 @@
             "Installed SHARK-Turbine, Version: 0.9.1.dev3\n",
             "\n",
             "Installed IREE, compiler version information:\n",
-            "IREE (https://openxla.github.io/iree):\n",
+            "IREE (https://iree.dev):\n",
             "  IREE compiler version 20231004.665 @ bb51f6f1a1b4ee619fb09a7396f449dadb211447\n",
             "  LLVM version 18.0.0git\n",
             "  Optimized build\n",

diff --git a/samples/colab/pytorch_jit.ipynb b/samples/colab/pytorch_jit.ipynb
@@ -222,7 +222,7 @@
             "Installed SHARK-Turbine, Version: 0.9.1.dev3\n",
             "\n",
             "Installed IREE, compiler version information:\n",
-            "IREE (https://openxla.github.io/iree):\n",
+            "IREE (https://iree.dev):\n",
             "  IREE compiler version 20231004.665 @ bb51f6f1a1b4ee619fb09a7396f449dadb211447\n",
             "  LLVM version 18.0.0git\n",
             "  Optimized build\n",

diff --git a/samples/colab/tensorflow_edge_detection.ipynb b/samples/colab/tensorflow_edge_detection.ipynb
@@ -78,15 +78,15 @@
         "outputId": "53aee7ec-e390-4293-f51f-2638b75148d3"
       },
       "source": [
-        "!python -m pip install iree-compiler iree-runtime iree-tools-tf -f https://openxla.github.io/iree/pip-release-links.html"
+        "!python -m pip install iree-compiler iree-runtime iree-tools-tf -f https://iree.dev/pip-release-links.html"
       ],
       "execution_count": 3,
       "outputs": [
         {
           "output_type": "stream",
           "name": "stdout",
           "text": [
-            "Looking in links: https://openxla.github.io/iree/pip-release-links.html\n",
+            "Looking in links: https://iree.dev/pip-release-links.html\n",
             "Requirement already satisfied: iree-compiler in /usr/local/lib/python3.10/dist-packages (20230831.630)\n",
             "Requirement already satisfied: iree-runtime in /usr/local/lib/python3.10/dist-packages (20230831.630)\n",
             "Requirement already satisfied: iree-tools-tf in /usr/local/lib/python3.10/dist-packages (20230831.630)\n",

diff --git a/samples/colab/tensorflow_hub_import.ipynb b/samples/colab/tensorflow_hub_import.ipynb
@@ -58,7 +58,7 @@
         "\n",
         "At the end of the notebook, the compilation artifacts are compressed into a .zip file for you to download and use in an application.\n",
         "\n",
-        "See also https://openxla.github.io/iree/ml-frameworks/tensorflow/."
+        "See also https://iree.dev/guides/ml-frameworks/tensorflow/."
       ]
     },
     {
@@ -77,7 +77,7 @@
       },
       "source": [
         "%%capture\n",
-        "!python -m pip install iree-compiler iree-runtime iree-tools-tf -f https://openxla.github.io/iree/pip-release-links.html"
+        "!python -m pip install iree-compiler iree-runtime iree-tools-tf -f https://iree.dev/pip-release-links.html"
       ],
       "execution_count": 11,
       "outputs": []

diff --git a/samples/colab/tensorflow_mnist_training.ipynb b/samples/colab/tensorflow_mnist_training.ipynb
@@ -109,7 +109,7 @@
       },
       "source": [
         "%%capture\n",
-        "!python -m pip install iree-compiler iree-runtime iree-tools-tf -f https://openxla.github.io/iree/pip-release-links.html"
+        "!python -m pip install iree-compiler iree-runtime iree-tools-tf -f https://iree.dev/pip-release-links.html"
       ],
       "execution_count": 4,
       "outputs": []
@@ -137,7 +137,7 @@
           "output_type": "stream",
           "name": "stdout",
           "text": [
-            "IREE (https://openxla.github.io/iree):\n",
+            "IREE (https://iree.dev):\n",
             "  IREE compiler version 20230831.630 @ 9ed3dab7ac4fcda959f5b8ebbcd7732aeb4b0c8d\n",
             "  LLVM version 18.0.0git\n",
             "  Optimized build\n"
@@ -676,4 +676,4 @@
       ]
     }
   ]
-}
+}
diff --git a/samples/colab/tensorflow_resnet.ipynb b/samples/colab/tensorflow_resnet.ipynb
@@ -77,15 +77,15 @@
         "outputId": "c0e8ddd9-a24c-4054-9fb7-95ea3c0d4a40"
       },
       "source": [
-        "!python -m pip install iree-compiler iree-runtime iree-tools-tf -f https://openxla.github.io/iree/pip-release-links.html"
+        "!python -m pip install iree-compiler iree-runtime iree-tools-tf -f https://iree.dev/pip-release-links.html"
       ],
       "execution_count": 3,
       "outputs": [
         {
           "output_type": "stream",
           "name": "stdout",
           "text": [
-            "Looking in links: https://openxla.github.io/iree/pip-release-links.html\n",
+            "Looking in links: https://iree.dev/pip-release-links.html\n",
             "Collecting iree-compiler\n",
             "  Downloading https://github.com/openxla/iree/releases/download/candidate-20230831.630/iree_compiler-20230831.630-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (69.0 MB)\n",
             "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m69.0/69.0 MB\u001b[0m \u001b[31m6.9 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",

diff --git a/samples/colab/tflite_text_classification.ipynb b/samples/colab/tflite_text_classification.ipynb
@@ -53,7 +53,7 @@
       "source": [
         "%%capture\n",
         "!python -m pip install --upgrade tf-nightly  # Needed for experimental_tflite_to_tosa_bytecode in TF>=2.14\n",
-        "!python -m pip install iree-compiler iree-runtime iree-tools-tflite -f https://openxla.github.io/iree/pip-release-links.html\n",
+        "!python -m pip install iree-compiler iree-runtime iree-tools-tflite -f https://iree.dev/pip-release-links.html\n",
         "!python -m pip install tflite-runtime-nightly"
       ]
     },
@@ -83,7 +83,7 @@
           "output_type": "stream",
           "name": "stdout",
           "text": [
-            "IREE (https://openxla.github.io/iree):\n",
+            "IREE (https://iree.dev):\n",
             "  IREE compiler version 20230831.630 @ 9ed3dab7ac4fcda959f5b8ebbcd7732aeb4b0c8d\n",
             "  LLVM version 18.0.0git\n",
             "  Optimized build\n"

diff --git a/samples/custom_dispatch/cpu/embedded/README.md b/samples/custom_dispatch/cpu/embedded/README.md
@@ -101,7 +101,7 @@ func.call @simple_mul_workgroup(%memref0, %memref1, %memref2, %dim, %tid) : (mem
 ## Instructions
 
 This presumes that `iree-compile` and `iree-run-module` have been installed or
-built. [See here](https://openxla.github.io/iree/building-from-source/getting-started/)
+built. [See here](https://iree.dev/building-from-source/getting-started/)
 for instructions for CMake setup and building from source.
 
 0. Ensure that `clang` is on your PATH:

diff --git a/samples/custom_dispatch/cpu/plugin/README.md b/samples/custom_dispatch/cpu/plugin/README.md
@@ -161,7 +161,7 @@ and the required one will be loaded at runtime.
 ## Instructions
 
 This presumes that `iree-compile` and `iree-run-module` have been installed or
-built. [See here](https://openxla.github.io/iree/building-from-source/getting-started/)
+built. [See here](https://iree.dev/building-from-source/getting-started/)
 for instructions for CMake setup and building from source.
 
 1. Build the `iree-sample-deps` CMake target to compile

diff --git a/samples/custom_dispatch/cuda/kernels/README.md b/samples/custom_dispatch/cuda/kernels/README.md
@@ -101,7 +101,7 @@ nvcc ... (TODO, see CMakeLists.txt) -o kernels_sm_80.ptx
 ## Instructions
 
 This presumes that `iree-compile` and `iree-run-module` have been installed or
-built. [See here](https://openxla.github.io/iree/building-from-source/getting-started/)
+built. [See here](https://iree.dev/building-from-source/getting-started/)
 for instructions for CMake setup and building from source.
 
 0. Ensure that the [CUDA SDK](https://developer.nvidia.com/cuda-downloads) and `nvcc` is on your PATH:

diff --git a/samples/custom_dispatch/vulkan/shaders/README.md b/samples/custom_dispatch/vulkan/shaders/README.md
@@ -105,7 +105,7 @@ glslc -fshader-stage=compute simple_mul.glsl -o simple_mul.spv
 ## Instructions
 
 This presumes that `iree-compile` and `iree-run-module` have been installed or
-built. [See here](https://openxla.github.io/iree/building-from-source/getting-started/)
+built. [See here](https://iree.dev/building-from-source/getting-started/)
 for instructions for CMake setup and building from source.
 
 0. Ensure that `glslc` is on your PATH (comes with the [Vulkan SDK](https://vulkan.lunarg.com/sdk/home)):

diff --git a/samples/custom_module/async/README.md b/samples/custom_module/async/README.md
@@ -34,7 +34,7 @@ work.
     ```
     (here we force runtime execution tracing for demonstration purposes)
 
-    [See here](https://openxla.github.io/iree/building-from-source/getting-started/)
+    [See here](https://iree.dev/building-from-source/getting-started/)
     for general instructions on building using CMake.
 
 3. Run the example program to call the main function: