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

DYN-7236 New debug option to dump node help data #15447

Merged
merged 4 commits into from
Sep 5, 2024

Conversation

zeusongit
Copy link
Contributor

@zeusongit zeusongit commented Aug 27, 2024

Purpose

This PR adds a new Debug Menu option to Dump Node Help Docs Data
The Node Help Data includes:

  • Missing MD files for existing core nodes
  • Missing Image files
  • Missing DYN (example) files
  • MD files with missing In-Depth section
  • MD files with missing image files attached

The logs are written to - C:\Users<User>\AppData\Roaming\Dynamo\Dynamo Core<Dynamo-Version>\Logs

Current stats:

Total 946
Missing MD Files 17
Missing DYN Files 25
Missing IMG Files 22
Missing IMG attached in MD File 10
Missing In Depth section in MD File 74

Screenshot 2024-08-27 at 3 17 29 PM.

  • White background behind example file image.
Screenshot 2024-08-27 at 2 07 40 PM

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated
  • This PR contains no files larger than 50 MB

Release Notes

(FILL ME IN) Brief description of the fix / enhancement. Use N/A to indicate that the changes in this pull request do not apply to Release Notes. Mandatory section

Reviewers

(FILL ME IN) Reviewer 1 (If possible, assign the Reviewer for the PR)

(FILL ME IN, optional) Any additional notes to reviewers or testers.

FYIs

(FILL ME IN, Optional) Names of anyone else you wish to be notified of

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

See the ticket for this pull request: https://jira.autodesk.com/browse/DYN-7236

Copy link

github-actions bot commented Aug 27, 2024

UI Smoke Tests

Test: success. 11 passed, 0 failed.
TestComplete Test Result
Workflow Run: UI Smoke Tests
Check: UI Smoke Tests

@QilongTang QilongTang added this to the 3.3 milestone Aug 27, 2024
@zeusongit
Copy link
Contributor Author

Something is up with Harmony scans, some builds are timing out, re-ran this one and it passed here: https://master-5.jenkins.autodesk.com/job/Dynamo/job/DynamoSelfServe/job/pullRequestValidation/16379/

@@ -3498,6 +3498,90 @@ private static void LoadLibraryEvents_LoadLibraryFailure(string failureMessage,
Wpf.Utilities.MessageBoxService.Show(failureMessage, messageBoxTitle, MessageBoxButton.OK, MessageBoxImage.Exclamation);
}

internal string GetMinimumQualifiedName(NodeModel nodeModel)
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe some comments to the functions? Understand that some of them are simply moved from the other class

}
private DirectoryInfo GetNodeHelpDocPath()
{
const string SHARED_DOCS_DIRECTORY_NAME = "NodeHelpSharedDocs";
Copy link
Contributor

Choose a reason for hiding this comment

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

There should be the same const somewhere else, maybe worth moving to a const under DynamoConfiguration class?

@zeusongit zeusongit merged commit dcd11a9 into DynamoDS:master Sep 5, 2024
23 of 24 checks passed
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.

2 participants