doc: update documentation

Author: moe-ad

doc/source/how-to/vulnerabilities.rst

@@ -54,7 +54,7 @@ have been integrated into the ``ansys/actions/check-vulnerabilities`` action.
 For third-party packages, the PyAnsys Core team has listed a set of excluded advisories so that
 the action does not fail. This is done to avoid false positives and to ensure that the action does
 not block the CI/CD pipeline unnecessarily. You can find the list of excluded advisories in
-`the check-vulnerabilities-action documentation`_.
+`the check-vulnerabilities action documentation`_.
 
 For potential vulnerabilities in the codebase, repositories can configure Bandit to ignore
 specific advisories. This can be due to the code not being ready yet to be fixed or that the
@@ -72,7 +72,7 @@ and ensure that they are regularly reviewed to determine if they can be addresse
 .. warning::
 
   Testing the action locally before enabling it in the CI/CD workflow is recommended. Information
-  on how to do this can be found in `the check-vulnerabilities-action documentation`_.
+  on how to do this can be found in `the check-vulnerabilities action documentation`_.
 
 Vulnerability remediation and reporting
 ----------------------------------------
@@ -348,7 +348,7 @@ Auditing CI/CD setups in the PyAnsys ecosystem
 For PyAnsys ecosystem projects, the recommended way to audit workflows is to use the
 ``ansys/actions/check-actions-security`` action. The action wraps ``zizmor`` and provides
 additional functionality and configuration tailored to PyAnsys projects. For setup instructions,
-see `the check-actions-security-action documentation`_.
+see `the check-actions-security action documentation`_.
 
 Fixing common issues detected by ``zizmor``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -803,6 +803,7 @@ For example, to ignore the ``artipacked`` rule:
 To ignore multiple rules in the same span, separate them with commas:
 
 .. code:: yaml
+
   # zizmor: ignore[github-env,template-injection]
 
 For more information, see `ignoring zizmor results`_.

doc/source/links.rst

@@ -224,8 +224,8 @@
 .. _CVE: https://www.cve.org/
 .. _Safety: https://pyup.io/safety/
 .. _Bandit: https://bandit.readthedocs.io/en/latest/
-.. _the check-vulnerability-action documentation: https://actions.docs.ansys.com/version/stable/vulnerability-actions/index.html#check-vulnerabilities-action
-.. _the check-actions-security-action documentation: https://actions.docs.ansys.com/version/stable/vulnerability-actions/index.html#check-actions-security-action
+.. _the check-vulnerabilities action documentation: https://actions.docs.ansys.com/version/stable/vulnerability-actions/index.html#check-vulnerabilities-action
+.. _the check-actions-security action documentation: https://actions.docs.ansys.com/version/stable/vulnerability-actions/index.html#check-actions-security-action
 .. _PyACP security considerations: https://acp.docs.pyansys.com/version/dev/user_guide/security_considerations.html
 .. _Github's documentation: https://docs.github.com/en/code-security/security-advisories/working-with-repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability
 .. _PyAnsys Geometry subprocess advisory: https://github.com/ansys/pyansys-geometry/security/advisories/GHSA-38jr-29fh-w9vm