DOC: add migration guidelines (#191)

Co-authored-by: Revathy Venugopal <[email protected]>
ansys · Feb 27, 2023 · 14da273 · 14da273
1 parent 46206b2
commit 14da273
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/doc-deploy-dev/action.yml b/doc-deploy-dev/action.yml
@@ -1,11 +1,18 @@
 name: >
   Doc deploy dev action
 
-description: >
+description: |
   This action deploys the desired HTML documentation artifact containing the
   development version of a library to the specified branch of a repository. By
   default, the ``gh-pages`` branch of the current repository is assumed.
 
+  .. note::
+
+      If your project is using ``pyansys/actions@v3`` or lower and you would
+      like to update to this version of the actions, see the `guidelines for
+      migrating to the latest multi-version documentation layout
+      <https://dev.docs.pyansys.com/how-to/documenting/multi-version-migration-from-pyansys-actions-v3-to-pyansys-actions-v4>`_ .
+
 inputs:
 
   # Required inputs

diff --git a/doc-deploy-stable/action.yml b/doc-deploy-stable/action.yml
@@ -1,11 +1,18 @@
 name: >
   Doc deploy stable action
 
-description: >
+description: |
   This action deploys the desired HTML documentation artifact containing the
   stable version of a library to the specified branch of a repository. By
   default, the ``gh-pages`` branch of the current repository is assumed.
 
+  .. note::
+
+      If your project is using ``pyansys/actions@v3`` or lower and you would
+      like to update to this version of the actions, see the `guidelines for
+      migrating to the latest multi-version documentation layout
+      <https://dev.docs.pyansys.com/how-to/documenting/multi-version-migration-from-pyansys-actions-v3-to-pyansys-actions-v4>`_ .
+
 inputs:
 
   # Required inputs