Skip to content

Conversation

@mjkkirschner
Copy link
Member

@mjkkirschner mjkkirschner commented Mar 14, 2022

Purpose

Currently performance CI job, and WPF visualization - perf machine test jobs are down - it appears both have to do with the new docs files that have extremely long file names, like:
doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.ByBoxLengths(origin, width, length, height, xSpans, ySpans, zSpans, symmetry, inSmoothMode).md

This PR simply removes the 3 files with the longest file names. There are some others, but I want to remove the minimal set for now.

I will file a followup task to consider solutions to this issue in the docs browser and docs generator tools. I'm thinking something like generating a unique short name using a guid, standard hash, or some short name scheme etc.

There are other solutions as well for the nodes we maintain, like storing them in a binary file/resx which the docs browser parses at runtime.

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

Release Notes

NA

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

@QilongTang
Copy link
Contributor

Thanks, please fill N/A for the release notes

@mjkkirschner mjkkirschner merged commit 9338ca4 into DynamoDS:master Mar 14, 2022
@mjkkirschner mjkkirschner deleted the filenamestoolong branch March 14, 2022 19:03
aparajit-pratap added a commit to aparajit-pratap/Dynamo that referenced this pull request Jun 8, 2022
mjkkirschner added a commit that referenced this pull request Jun 16, 2022
QilongTang pushed a commit that referenced this pull request Jun 16, 2022
sm6srw added a commit to sm6srw/Dynamo that referenced this pull request Dec 1, 2022
sm6srw added a commit that referenced this pull request Dec 6, 2022
…es that are too long. (#13588)

* Initial implementation

* Remove files added by mistake.

* Revert .gitignore change

* Update help text

* Add the original base name as a comment in the renamed MD file

* Revert "temp fix for builds, remove tsplines nodes docs (#12693)"

This reverts commit 9338ca4.

* Rename offending files

* Add hash test

* Add tests for markdown generator tool

* Update Readme

* Add comments

* Revert "Rename offending files"

This reverts commit b09be40.

* Use SHA256/Base32 instead of SHA1

* Address review comments
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.

3 participants