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

Fix readme links to Doxygen and MOOSE resources #189

Merged
merged 5 commits into from
Mar 1, 2022

Conversation

smpark7
Copy link
Collaborator

@smpark7 smpark7 commented Mar 1, 2022

This PR addresses two issues highlighted in #187.

  1. The old MOOSE wiki, tutorials, and example links are broken. I've replaced them with two new links to the MOOSE workshop slides and video.
  2. I changed the Doxygen link to land directly in the Class Index page of the Doxygen documentation site. This is the same approach as the Doxygen link on the MOOSE website. The primary source of documentation is to be the MooseDocs website as described in Set up a website with documentation based on the MooseDocs system #179.

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.

Overall, this looks good. I won't approve until all of the links are working, there is one that gives me a Not Found error when I try to go there.

README.md Show resolved Hide resolved
README.md Outdated
[examples](http://mooseframework.org/wiki/MooseExamples/) to help understand the
users who have never used MOOSE before are encouraged to check-out the MOOSE
workshop [slides](https://mooseframework.inl.gov/workshop/index.html#/) and
[video](https://www.youtube.com/watch?v=2tJwBsYaLaI) to help understand the
Copy link
Contributor

Choose a reason for hiding this comment

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

The link works, but is an 11 hour video the best link to put?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hmm. It's a tough call because MOOSE requires some time investment to gain basic proficiency. Should I just leave a link to the MOOSE website?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah. I think that plus the slides would be helpful. I am assuming that the website will have the video linked if a user wants to invest the time.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yea I got the video link from their website. I'll link their website and workshop slides.

README.md Outdated Show resolved Hide resolved
abachma2
abachma2 previously approved these changes Mar 1, 2022
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.

This looks good! Thanks for the work. I'll merge this.

@smpark7
Copy link
Collaborator Author

smpark7 commented Mar 1, 2022

Thanks! Lets merge your PR first just in case there are merge conflicts.

@abachma2
Copy link
Contributor

abachma2 commented Mar 1, 2022

PR #188 is merged, so I am merging this one.

@abachma2 abachma2 merged commit 7761c8c into arfc:devel Mar 1, 2022
github-actions bot pushed a commit that referenced this pull request Mar 1, 2022
Fix readme links to Doxygen and MOOSE resources 7761c8c
@smpark7 smpark7 mentioned this pull request Mar 1, 2022
github-actions bot pushed a commit to gwenchee/moltres that referenced this pull request Mar 2, 2022
Fix readme links to Doxygen and MOOSE resources 7761c8c
@smpark7 smpark7 deleted the fix-readme-links-2 branch April 26, 2022 03: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.

2 participants