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

PROOF Documentation Update #1078

Closed
wants to merge 32 commits into from
Closed

PROOF Documentation Update #1078

wants to merge 32 commits into from

Conversation

tefirman
Copy link
Contributor

@tefirman tefirman commented Oct 23, 2024

Description

  • With the new GUI coming in v1.2, DaSL/SciComp needs to update the "How To" and "Troubleshooting" SciWiki documentation for PROOF to account for the interface changes.
  • Mostly screenshot updates, but also verifying that instructions are still relevant.
  • Also adding v1.2 release notes to PROOF product page.

Testing

  • Built website locally, articles look good.

Updating the structure of this How-To-Doc based on discussions at Lakeside Chat
Copy link
Collaborator

@vortexing vortexing left a comment

Choose a reason for hiding this comment

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

Address style issue re: author list prior to approval.

@tefirman tefirman requested a review from vortexing December 6, 2024 06:37
@tefirman tefirman marked this pull request as ready for review December 6, 2024 06:37
@tefirman tefirman requested a review from a team as a code owner December 6, 2024 06:37
@tefirman
Copy link
Contributor Author

tefirman commented Dec 6, 2024

Alright PROOF team, I think these documentation updates are ready. Thank you all so much for your efforts throughout this! Can someone take a final look and approve so we can merge to main?

One note: @sitapriyamoorthi, the tables you added explaining the columns for each tab look super helpful and I want to incorporate them somewhere, but they were making the article a bit lengthy/dense, especially for an intro/how-to article. I commented them out for now, but I'm wondering if we can split them off into a "PROOF Glossary" type SciWiki article. Does that sound okay to you?

Copy link
Contributor

@sitapriyamoorthi sitapriyamoorthi left a comment

Choose a reason for hiding this comment

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

Minor fixes recommeneded

_dasldemos/proof-how-to.md Outdated Show resolved Hide resolved
_dasldemos/proof-how-to.md Show resolved Hide resolved
_dasldemos/proof-how-to.md Outdated Show resolved Hide resolved
@sitapriyamoorthi
Copy link
Contributor

Alright PROOF team, I think these documentation updates are ready. Thank you all so much for your efforts throughout this! Can someone take a final look and approve so we can merge to main?

One note: @sitapriyamoorthi, the tables you added explaining the columns for each tab look super helpful and I want to incorporate them somewhere, but they were making the article a bit lengthy/dense, especially for an intro/how-to article. I commented them out for now, but I'm wondering if we can split them off into a "PROOF Glossary" type SciWiki article. Does that sound okay to you?

@tefirman yes thats fine! I just put it in there because there are a lot of terms that folks may not be familiar with. It could potentially be helpful or a quick reminder of what those different fields mean

@tefirman
Copy link
Contributor Author

tefirman commented Dec 6, 2024

@sitapriyamoorthi @vortexing -- thanks for the reviews! Addressed all comments, mind taking another look?

@tefirman
Copy link
Contributor Author

tefirman commented Dec 9, 2024

Holding off on these updates for now while we address issues with the v1.2 release. May reopen later, but closing for now to avoid confusion.

@tefirman tefirman closed this Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants