Skip to content
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.

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

docs: review of documenting using pymapdl on clusters (#3466) #3506

Merged
merged 4 commits into from
Oct 23, 2024

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented Oct 23, 2024

This PR is just bringing the changes made in #3466 into main.

Branching

I was waiting for a doc review for #3466. This PR aimed to merge feat/passing-tight-integration-env-vars-to-MAPDL into main.

Because I was needing these changes in main but I didn't want to merge those without @PipKat approval, I did a copy of both branches....

  • feat/copy-passing-tight-integration-env-vars-to-MAPDL for feat/passing-tight-integration-env-vars-to-MAPDL
  • maint/main_copy for main.

Then I changed the target of #3466 to be maint/main_copy.

Then I opened another PR (#3500) which aimed to merge the copy feat/copy-passing-tight-integration-env-vars-to-MAPDL into main. And I merged.

Then I kept #3466 untouched (well, I did change the PR name to reflect the new content basically doc review). This way, the changes done (File tab in the PR) were considered still with respect to the main without #3500 which contained everything but @PipKat corrections.

Commit history

  • feat: adding env vars needed for multinode

  • feat: adding env vars needed for multinode

  • feat: renaming hpc detection argument

  • docs: adding documentation

  • chore: adding changelog file 3466.documentation.md

  • feat: adding env vars needed for multinode

  • feat: renaming hpc detection argument

  • docs: adding documentation

  • chore: adding changelog file 3466.documentation.md

  • fix: vale issues

  • chore: To fix sphinx build

Squashed commit of the following:

commit c1d1a3e
Author: German [email protected]
Date: Mon Oct 7 15:33:19 2024 +0200

ci: retrigger CICD

commit b7b5c30
Author: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Mon Oct 7 13:31:55 2024 +0000

ci: auto fixes from pre-commit.com hooks.

for more information, see https://pre-commit.ci

commit 32a1c02
Author: Revathy Venugopal [email protected]
Date: Mon Oct 7 15:31:24 2024 +0200

fix: add suggestions

Co-authored-by: German <[email protected]>

commit 575a219
Merge: f2afe13 be1be2e
Author: Revathyvenugopal162 [email protected]
Date: Mon Oct 7 15:09:01 2024 +0200

Merge branch 'fix/add-build-cheatsheet-as-env-varaible' of https://github.com/ansys/pymapdl into fix/add-build-cheatsheet-as-env-varaible

commit f2afe13
Author: Revathyvenugopal162 [email protected]
Date: Mon Oct 7 15:08:58 2024 +0200

fix: precommit

commit be1be2e
Author: pyansys-ci-bot [email protected]
Date: Mon Oct 7 13:07:35 2024 +0000

chore: adding changelog file 3468.fixed.md

commit f052a4d
Author: Revathyvenugopal162 [email protected]
Date: Mon Oct 7 15:05:56 2024 +0200

fix: add build cheatsheet as env variable within doc-build
  • docs: expanding a bit troubleshooting advices and small format fix

  • docs: fix vale

  • fix: nproc tests

  • feat: adding env vars needed for multinode

  • feat: renaming hpc detection argument

  • docs: adding documentation

  • chore: adding changelog file 3466.documentation.md

  • fix: vale issues

  • docs: fix vale

  • docs: expanding a bit troubleshooting advices and small format fix

  • fix: nproc tests

  • revert: "chore: To fix sphinx build"

This reverts commit e45d2e5.

  • docs: clarifying where everything is running.

  • docs: expanding bash example

  • tests: fix

  • docs: adding PYMAPDL_NPROC to env var section

  • docs: fix vale issue

  • docs: fix vale issue

  • fix: replacing env var name

  • fix: unit tests

  • chore: adding changelog file 3466.documentation.md [dependabot-skip]

  • Apply suggestions from code review

Co-authored-by: Camille [email protected]

  • docs: apply suggestions from code review made by Kathy

Co-authored-by: Kathy Pippert [email protected]

  • docs: adding Kathy suggestion.

Co-authored-by: pyansys-ci-bot [email protected]
Co-authored-by: Camille [email protected]
Co-authored-by: Kathy Pippert [email protected]

Description

Please provide a brief description of the changes made in this pull request.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.

Checklist

germa89 and others added 2 commits October 23, 2024 18:11
* feat: adding env vars needed for multinode

* feat: adding env vars needed for multinode

* feat: renaming hpc detection argument

* docs: adding documentation

* chore: adding changelog file 3466.documentation.md

* feat: adding env vars needed for multinode

* feat: renaming hpc detection argument

* docs: adding documentation

* chore: adding changelog file 3466.documentation.md

* fix: vale issues

* chore: To fix sphinx build

Squashed commit of the following:

commit c1d1a3e
Author: German <[email protected]>
Date:   Mon Oct 7 15:33:19 2024 +0200

    ci: retrigger CICD

commit b7b5c30
Author: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date:   Mon Oct 7 13:31:55 2024 +0000

    ci: auto fixes from pre-commit.com hooks.

    for more information, see https://pre-commit.ci

commit 32a1c02
Author: Revathy Venugopal <[email protected]>
Date:   Mon Oct 7 15:31:24 2024 +0200

    fix: add suggestions

    Co-authored-by: German <[email protected]>

commit 575a219
Merge: f2afe13 be1be2e
Author: Revathyvenugopal162 <[email protected]>
Date:   Mon Oct 7 15:09:01 2024 +0200

    Merge branch 'fix/add-build-cheatsheet-as-env-varaible' of https://github.com/ansys/pymapdl into fix/add-build-cheatsheet-as-env-varaible

commit f2afe13
Author: Revathyvenugopal162 <[email protected]>
Date:   Mon Oct 7 15:08:58 2024 +0200

    fix: precommit

commit be1be2e
Author: pyansys-ci-bot <[email protected]>
Date:   Mon Oct 7 13:07:35 2024 +0000

    chore: adding changelog file 3468.fixed.md

commit f052a4d
Author: Revathyvenugopal162 <[email protected]>
Date:   Mon Oct 7 15:05:56 2024 +0200

    fix: add build cheatsheet as env variable within doc-build

* docs: expanding a bit troubleshooting advices and small format fix

* docs: fix vale

* fix: nproc tests

* feat: adding env vars needed for multinode

* feat: renaming hpc detection argument

* docs: adding documentation

* chore: adding changelog file 3466.documentation.md

* fix: vale issues

* docs: fix vale

* docs: expanding a bit troubleshooting advices and small format fix

* fix: nproc tests

* revert: "chore: To fix sphinx build"

This reverts commit e45d2e5.

* docs: clarifying where everything is running.

* docs: expanding bash example

* tests: fix

* docs: adding `PYMAPDL_NPROC` to env var section

* docs: fix vale issue

* docs: fix vale issue

* fix: replacing env var name

* fix: unit tests

* chore: adding changelog file 3466.documentation.md [dependabot-skip]

* Apply suggestions from code review

Co-authored-by: Camille <[email protected]>

* docs: apply suggestions from code review made by Kathy

Co-authored-by: Kathy Pippert <[email protected]>

* docs: adding Kathy suggestion.

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Camille <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
@germa89 germa89 requested a review from a team as a code owner October 23, 2024 16:53
@germa89 germa89 requested review from clatapie and pyansys-ci-bot and removed request for a team October 23, 2024 16:53
@germa89 germa89 self-assigned this Oct 23, 2024
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@germa89 germa89 changed the title docs: documenting using pymapdl on clusters (#3466) docs: review of documenting using pymapdl on clusters (#3466) Oct 23, 2024
@germa89
Copy link
Collaborator Author

germa89 commented Oct 23, 2024

Surprisingly I got so many issues........

@github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label Oct 23, 2024
@germa89
Copy link
Collaborator Author

germa89 commented Oct 23, 2024

Since this is just the doc review from @PipKat made in #3466 . I does not need approval. Hence:

@pyansys-ci-bot LGTM

@germa89 germa89 enabled auto-merge (squash) October 23, 2024 16:56
Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Approving this PR because germa89 said so in here 😬

LGTM

Copy link

codecov bot commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.31%. Comparing base (e8248a3) to head (baa0069).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3506      +/-   ##
==========================================
- Coverage   82.33%   82.31%   -0.02%     
==========================================
  Files          57       57              
  Lines       10007    10004       -3     
==========================================
- Hits         8239     8235       -4     
- Misses       1768     1769       +1     

@germa89 germa89 merged commit c0fa797 into main Oct 23, 2024
60 checks passed
@germa89 germa89 deleted the maint/copy2_main branch October 23, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related (improving, adding, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants