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

Convert our documentation to new versioned documentation #227

Open
bwnedrud opened this issue Feb 16, 2023 · 0 comments
Open

Convert our documentation to new versioned documentation #227

bwnedrud opened this issue Feb 16, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@bwnedrud
Copy link
Collaborator

Description of the modifications

At the PyAnsys core team we are trying to "get rid" of the dev.* documentation sites that the different projects have in favor of implementing a multi-version scheme in their docs (being one of the versions the "dev" status of the repo). We have communicated this effort a couple of times in the Thursday meetings, and we are approaching the teams individually to check their status.
This multi-version mechanism will allow us:
• To have a single location for all the docs related to the PyAnsys project
• Ease maintenance tasks
• And most importantly - solve some IT security issues that were risen to us.
We have given all PyAnsys teams till end of March as deadline for changing to the multi-versioning system. We (as in the PyAnsys core team) can provide support on the change, but it eventually has to happen.
PyEDB has two docs sites (as most projects used to have):
• dev.edb.docs.pyansys.com
• edb.docs.pyansys.com
My questions are:
• Do you need any support doing so? (guidelines, actual coding help etc.)
An example of multi-versioning docs site can be found here: https://mapdl.docs.pyansys.com/

Useful links and references

No response

@bwnedrud bwnedrud added the documentation Improvements or additions to documentation label Feb 16, 2023
@bwnedrud bwnedrud self-assigned this Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant