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

Remove symlinks from docs #899

Open
jonatan-ivanov opened this issue Dec 6, 2024 · 2 comments
Open

Remove symlinks from docs #899

jonatan-ivanov opened this issue Dec 6, 2024 · 2 comments
Milestone

Comments

@jonatan-ivanov
Copy link
Member

Other than they don't work on windows, Gradle FS watching does not support them either: https://docs.gradle.org/current/userguide/file_system_watching.html#supported_file_systems

@jonatan-ivanov jonatan-ivanov added this to the 1.x milestone Dec 6, 2024
@shakuzen
Copy link
Member

shakuzen commented Dec 9, 2024

symlinked files do not benefit from file system-watching optimizations.

The above quote is from the linked docs. Is it just an optimization we're missing out on for those files or the docs module then? That doesn't sound too bad. If we were to get rid of the symlinks, would we just have duplicate copies of the files used via symlink in the docs module?

@jonatan-ivanov jonatan-ivanov changed the title Remove sylinks from docs Remove symlinks from docs Dec 10, 2024
@jonatan-ivanov
Copy link
Member Author

I'm not sure what are the consequences for Gradle, also, I only saw the issue on CircleCI and not locally (caching?):

Gradle was unable to watch the file system for changes. Unable to watch same file twice via different paths: Already watching path: /home/circleci/micrometer-tracing/docs/modules/ROOT/examples/bridges-src/micrometer-tracing-bridge-brave/src/main.

But I guess this means that build is now not possible on vanilla Windows setups.

I haven't looked into this but we might not need to symlink files but might be able to declare a dependency on them. We can get away of having example code snippets in Micrometer without symlinks somehow, maybe we can do the same here too?

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

No branches or pull requests

2 participants