Skip to content

Fix broken links documentation practices #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 21, 2022
Merged

Fix broken links documentation practices #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b4cd2c
Fix broken links doc practices
jorgepiloto Mar 21, 2022
ea64453
Update doc/source/guidelines/doc_practices.rst
akaszynski Mar 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions doc/source/guidelines/doc_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,9 @@ For instance: `grantami <https://grantami.docs.pyansys.com>`_
Regarding the documentation dedicated to a specific feature of the product or an example, the URL is formatted like this:
``<extra>.<product_name>.docs.pyansys.com``

For instance: `cartpole <https://cartpole.mapdl.docs.pyansys.com>`_
For instance: `cartpole <https://pyansys.github.io/ml-rl-cartpole/>`_

Once the URL name has been decided, it must be specified in the "Settings" of the repository under the "Custom domain" section.
For example, `see <https://github.com/pyansys/grantami-bomanalytics-docs/settings/pages>`_
Once the URL name has been decided, it must be specified in the "Settings -> Pages -> Custom domain" section of the repository.

Then, the URL has to be registered using Microsoft Azure to set the DNS properly and link it to the ANSYS organization.
This action will be performed by one of the Ansys administrator of Microsoft Azure account.
Expand Down