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

Set up new website built on MooseDocs system #199

Merged
merged 37 commits into from
May 30, 2022
Merged

Conversation

smpark7
Copy link
Collaborator

@smpark7 smpark7 commented May 2, 2022

This PR addresses some tasks in issues #179 and #193 involving documentation and website setup. The changes include:

  • more dropdown menus on the MooseDocs-based website for Getting Started and Documentation with links to Moltres and MOOSE documentation webpages;
  • new home page for the Moltres website;
  • updated installation instructions hosted on Getting Started/Install Moltres;
  • automatically generated documentation webpage stubs (in markdown format) of all objects in Moltres (e.g. kernels, BCs, postprocessors, etc.) which are to be filled in another PR;
  • modify the existing GitHub Action which previously deployed Doxygen documentation only. The new GH Action now builds MooseDocs html files for the new website and hosts the Doxygen documentation in /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;
  • update readme to link to the new website and remove duplicated information.

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:

@smpark7
Copy link
Collaborator Author

smpark7 commented May 4, 2022

@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.

@smpark7 smpark7 requested a review from yardasol May 4, 2022 23:45
@smpark7
Copy link
Collaborator Author

smpark7 commented May 20, 2022

@munkm This is ready for your review. I incorporated your suggestions for reordering the list of publications by date and recommending git merge instead of git rebase. I hope to merge soon-ish because yet another person has had trouble with the outdated installation instructions #202. Thank you!

@munkm
Copy link
Member

munkm commented May 20, 2022

Thanks for the reminder @smpark7 ! I'm on it.

munkm
munkm previously approved these changes May 20, 2022
Copy link
Member

@munkm munkm left a 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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
doc/content/development/contributing.md Outdated Show resolved Hide resolved
doc/content/development/contributing.md Outdated Show resolved Hide resolved
doc/content/development/contributing.md Outdated Show resolved Hide resolved
doc/content/getting_started/installation.md Show resolved Hide resolved
doc/content/getting_started/installation.md Show resolved Hide resolved
doc/content/getting_started/installation.md Show resolved Hide resolved
doc/content/getting_started/installation.md Outdated Show resolved Hide resolved
doc/content/publications.md Show resolved Hide resolved
Any altered functionality needs to include documentation

Co-authored-by: Madicken Munk <madicken.munk@gmail.com>
smpark7 and others added 6 commits May 20, 2022 17:29
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>
munkm
munkm previously approved these changes May 28, 2022
@munkm munkm merged commit c0a0324 into arfc:devel May 30, 2022
github-actions bot pushed a commit that referenced this pull request May 31, 2022
Set up new website built on MooseDocs system c0a0324
@smpark7
Copy link
Collaborator Author

smpark7 commented May 31, 2022

Thank you!

@smpark7 smpark7 deleted the moosedocs-setup branch April 21, 2023 20:29
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.

3 participants