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

ARFC Moltres website migration #231

Merged
merged 16 commits into from
Aug 28, 2023
Merged

Conversation

smpark7
Copy link
Collaborator

@smpark7 smpark7 commented Mar 13, 2023

Fixes #179

Description

This PR migrates existing content on the ARFC Moltres website (https://arfc.github.io/software/moltres/) to the newer MooseDocs-based website (https://arfc.github.io/moltres/). A preview with the changes in this PR is available on my personal github website (https://smpark7.github.io/moltres/index.html).

Changes

  • Migrated existing website content
    • Input syntax guide
    • Corresponding terms in the PDEs for each Kernel/BC object
    • Recommended executioner and preconditioner settings guide
  • Added more content
    • Additional kernel/BC documentation: The weak form for second-order differential terms which were integrated by parts
    • Gwen's dissertation entry under "Publications"
  • Tutorials
    • Moved and edited group constant generation tutorial README instructions into tutorial guides on the new Moltres website
    • Added input files for eigenvalue and transient tutorial problems
    • Added syntax check tests for these new tutorial input files
  • Fixes
    • Typo in Publications webpage
    • Improve visibility of dropdown menu in dark mode
    • Removed redundant entry in godiva_serpent.inp

Impact

  • More extensive Moltres documentation support with the MooseDocs-based website
  • Powerful MooseDocs-based tools which help with website maintenance

@smpark7 smpark7 changed the title [WIP] ARFC Moltres website migration ARFC Moltres website migration May 5, 2023
abachma2
abachma2 previously approved these changes Aug 23, 2023
Copy link
Contributor

@abachma2 abachma2 left a comment

Choose a reason for hiding this comment

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

Hi @smpark7. Great work on this, it looks really good overall. I had a few very small suggestions that are optional. I saw that one of the CI tests fails and I didn't really dig into why. I know you have a few PRs right now, so I'm guessing one of those PRs fixes it all. Let me know when this is ready to merge.

doc/content/getting_started/transient.md Outdated Show resolved Hide resolved
doc/content/getting_started/tutorials.md Outdated Show resolved Hide resolved
@smpark7
Copy link
Collaborator Author

smpark7 commented Aug 23, 2023

Thanks for your review @abachma2. The CI is failing at the "initialize test environment" phase and I don't know why. This PR sets up new tests but it doesn't touch any source code. I'll ping you when it's been sorted.

abachma2
abachma2 previously approved these changes Aug 23, 2023
@smpark7
Copy link
Collaborator Author

smpark7 commented Aug 23, 2023

The tests are running properly now. I just added an input mesh for the tutorial which I initially missed because of gitignore. This PR is ready for review and merge (unless you have new comments). @abachma2

@smpark7
Copy link
Collaborator Author

smpark7 commented Aug 28, 2023

@abachma2 pinging you for a review and merge

@abachma2
Copy link
Contributor

Thanks for the reminder! Merging now.

@abachma2 abachma2 merged commit 2cb1480 into arfc:devel Aug 28, 2023
@smpark7
Copy link
Collaborator Author

smpark7 commented Aug 28, 2023

Thanks Amanda!

@smpark7 smpark7 deleted the website-migration branch August 28, 2023 15:31
github-actions bot pushed a commit that referenced this pull request Aug 28, 2023
github-actions bot pushed a commit to khurrumsaleem/moltres that referenced this pull request Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Set up a website with documentation based on the MooseDocs system
2 participants