Skip to content

Commit 5efc94a

Browse files
MaxJPReyPipKat
andauthored
Add a section to define the URL for the documentation page. (#52)
* Add Documentation page DNS. * Small improvement. * Correct hyperlink. * Correct hyperlink for settings page. * Update doc/source/guidelines/doc_practices.rst Co-authored-by: Kathy Pippert <[email protected]> Co-authored-by: Kathy Pippert <[email protected]>
1 parent 4360d52 commit 5efc94a

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

doc/source/guidelines/doc_practices.rst

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Guide <https://developers.google.com/style/articles>`_. It provides editorial gu
88
for writing clear and consistent developer documentation, allowing this guide to supply
99
guidance specific to PyAnsys library documentation.
1010

11-
When writing developer documentation, the relationship between code and documenation is
12-
key. To keep documentation up to date with rapdily evolving code:
11+
When writing developer documentation, the relationship between code and documentation is
12+
key. To keep documentation up to date with rapidly evolving code:
1313

1414
- Minimize the content footprint
1515
- Write `timeless documentation <https://developers.google.com/style/timeless-documentation>`_
@@ -122,6 +122,29 @@ extension, you must follow its `coding guidelines <https://sphinx-gallery.github
122122

123123
PyMAPDL provides a self-demonstrating example of how to `add an example reference key <https://mapdldocs.pyansys.com/examples/03-tips-n-tricks/00-example-template.html#ref-how-to-add-an-example-reference-key>`_.
124124

125+
126+
URL of the documentation page
127+
-----------------------------
128+
To host the documentation related to a PyAnsys project, an easy way to go is to use GitHub Page.
129+
This GitHub feature do not require any database to be setup nor to configure any server.
130+
GitHub will serve the documentation related to the project from a URL tied to PyAnsys organization.
131+
132+
The standard name for this URL can be such as:
133+
``<product_name>.docs.pyansys.com``
134+
135+
For instance: `grantami <https://grantami.docs.pyansys.com>`_
136+
137+
Regarding the documentation dedicated to a specific feature of the product or an example, the URL is formatted like this:
138+
``<extra>.<product_name>.docs.pyansys.com``
139+
140+
For instance: `cartpole <https://cartpole.mapdl.docs.pyansys.com>`_
141+
142+
Once the URL name has been decided, it must be specified in the "Settings" of the repository under the "Custom domain" section.
143+
For example, `see <https://github.com/pyansys/grantami-bomanalytics-docs/settings/pages>`_
144+
145+
Then, the URL has to be registered using Microsoft Azure to set the DNS properly and link it to the ANSYS organization.
146+
This action will be performed by one of the Ansys administrator of Microsoft Azure account.
147+
125148
Accessing a Library's Documentation
126149
-----------------------------------
127150
Documentation for the latest stable release of a PyAnsys library is accessible
@@ -166,7 +189,7 @@ To use Windows PowerShell to clone a GitHub repository:
166189

167190
Because the list of repositories is quite long, you can use the ``Find
168191
a repository`` option to search for the repository that you want to clone. For
169-
example, you can seach for "theme" to find the ``pyansys-sphinx-theme`` repository.
192+
example, you can search for "theme" to find the ``pyansys-sphinx-theme`` repository.
170193

171194
#. In the upper right corner of the repository, click the green ``Code`` button to
172195
drop down a list of options.
@@ -206,7 +229,7 @@ Pushing Changes to the GitHub Repository
206229
----------------------------------------
207230
As you make changes in your ``doc/`` branch, you want to periodically test then in
208231
local documentation builds as described in :ref:`doc_building`. After you resolve
209-
any issues and are satisfied with what apears in a local build, you are ready
232+
any issues and are satisfied with what appears in a local build, you are ready
210233
to push your changes to the library's GitHub repository. To accomplish this,
211234
you can use either Git commands or Git Extensions.
212235

@@ -290,7 +313,7 @@ To use Git Extensions to push your changes to the GitHub repository:
290313
are no conflicts with what is in your branch. If there are conflicts, resolve
291314
them.
292315

293-
#. Do a push of your branch to the GitHub repsitory.
316+
#. Do a push of your branch to the GitHub repository.
294317

295318
#. Create the PR as described in :ref:`create_pr`.
296319

@@ -302,7 +325,7 @@ Creating the GitHub PR
302325
Regardless of what method you used to push your changes, do the following to create
303326
the GitHub PR:
304327

305-
#. Go to the GitHub reposity, where you will see an entry for your pushed branch.
328+
#. Go to the GitHub repository, where you will see an entry for your pushed branch.
306329

307330
#. If the pushed branch resolves an issue, in its description, type ``Resolves #``
308331
and select from the list of issues that appears.
@@ -313,7 +336,7 @@ the GitHub PR:
313336

314337
If your PR is ready for review, select ``Create pull request``. Otherwise,
315338
select ``Create draft pull request`` and mark it as ready for review once
316-
you it includes all of your changes and you are satisified with it.
339+
you it includes all of your changes and you are satisfied with it.
317340

318341
If you need to change a PR title, to its right, click the ``Edit`` button,
319342
which becomes a ``Save`` button while you are in editing mode.

0 commit comments

Comments
 (0)