-
Notifications
You must be signed in to change notification settings - Fork 41
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
Set up new website built on MooseDocs system #199
Conversation
@yardasol I added a "Contributing" page which includes instructions on how to contribute to Moltres and how to manually build the docpages. I also added a "Publications page that provides a list of publications which used Moltres. I replaced the "Source documentation" page with a "Syntax" page which contains the same documentation links and also adds new links for each general class type (e.g. Kernels, BCs, etc.). The class type links lead directly to MOOSE-provided documentation which uses many of the large media files you found. I think this implementation is fair because MOOSE already provides good documentation for these kinds of MOOSE-wide features. This PR is ready for another review. The preview website at https://smpark7.github.io/moltres/ will be ready once the gh-pages action finishes running on my fork https://github.com/smpark7/moltres/runs/6298699903?check_suite_focus=true. |
Thanks for the reminder @smpark7 ! I'm on it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great @smpark7 !!!! I have some minor comments and suggestions.
Thank you so much for redoing the website. I think the content is clear, readable, and accessible for users and developers alike.
Any altered functionality needs to include documentation Co-authored-by: Madicken Munk <madicken.munk@gmail.com>
Clarify the criteria for creating a pull request Co-authored-by: Madicken Munk <madicken.munk@gmail.com>
Ask users to add their Moltres publications to the list Co-authored-by: Madicken Munk <madicken.munk@gmail.com>
…lation issues online
Set up new website built on MooseDocs system c0a0324
Thank you! |
This PR addresses some tasks in issues #179 and #193 involving documentation and website setup. The changes include:
Getting Started
andDocumentation
with links to Moltres and MOOSE documentation webpages;Getting Started/Install Moltres
;/doxygen
with a link to it from the navigation bar. The website will be hosted on https://arfc.github.io/moltres/ where our Doxygen documentation was previously hosted;The task of building MooseDocs html files requires us to compile Moltres in the GitHub Action. This takes 30 minutes to run but I think it's better to exploit computational resources for reliability than having someone (aka me) build it locally and push to
gh-pages
every time there's a change to the docs.Refer to https://smpark7.github.io/moltres/ to see how the website will actually look like.
For clarity, future tasks (already tracked in meta-issue #179) include: