Skip to content

Commit 14da273

Browse files
DOC: add migration guidelines (#191)
Co-authored-by: Revathy Venugopal <[email protected]>
1 parent 46206b2 commit 14da273

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

doc-deploy-dev/action.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
name: >
22
Doc deploy dev action
33
4-
description: >
4+
description: |
55
This action deploys the desired HTML documentation artifact containing the
66
development version of a library to the specified branch of a repository. By
77
default, the ``gh-pages`` branch of the current repository is assumed.
88
9+
.. note::
10+
11+
If your project is using ``pyansys/actions@v3`` or lower and you would
12+
like to update to this version of the actions, see the `guidelines for
13+
migrating to the latest multi-version documentation layout
14+
<https://dev.docs.pyansys.com/how-to/documenting/multi-version-migration-from-pyansys-actions-v3-to-pyansys-actions-v4>`_ .
15+
916
inputs:
1017

1118
# Required inputs

doc-deploy-stable/action.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
name: >
22
Doc deploy stable action
33
4-
description: >
4+
description: |
55
This action deploys the desired HTML documentation artifact containing the
66
stable version of a library to the specified branch of a repository. By
77
default, the ``gh-pages`` branch of the current repository is assumed.
88
9+
.. note::
10+
11+
If your project is using ``pyansys/actions@v3`` or lower and you would
12+
like to update to this version of the actions, see the `guidelines for
13+
migrating to the latest multi-version documentation layout
14+
<https://dev.docs.pyansys.com/how-to/documenting/multi-version-migration-from-pyansys-actions-v3-to-pyansys-actions-v4>`_ .
15+
916
inputs:
1017

1118
# Required inputs

0 commit comments

Comments
 (0)