Skip to content

Windows installation notes - #241

Merged
holzensp merged 1 commit into
apple:mainfrom
mitchcapper:windows_cli_install_notes
Apr 24, 2024
Merged

Windows installation notes#241
holzensp merged 1 commit into
apple:mainfrom
mitchcapper:windows_cli_install_notes

Conversation

@mitchcapper

Copy link
Copy Markdown
Contributor

Per #237 notes about Windows platform support for the install docs. Assuming this is what was desired will add additional docs to --allowed-modules and update apple/pkl-jvm-examples#9 . apple/pkl-jvm-examples#9 is mostly not related to Windows, just likely Windows users may run into issues around its usage.

I am not sure what items other than allowed-modules may specifically have path related issues or if there is a better place to discuss Windows paths in more detail.

I have not found a way to sparse-checkout (cone or no-cone) or ignore the two invalid window path areas:

  • pkl-doc/src/test/files/DocGeneratorTest/output/*
  • pkl-core/src/test/files/LanguageSnippetTests/input-helper/globtest/*

@mitchcapper
mitchcapper force-pushed the windows_cli_install_notes branch from 5d71902 to 05b3336 Compare February 24, 2024 07:47
@mitchcapper mitchcapper mentioned this pull request Mar 14, 2024

@holzensp holzensp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I like it, but wanted to suggest some more compact wording. I think we should avoid spreading timeline promises through the technical documentation; that's bound to be overlooked in future.

Comment thread docs/modules/pkl-cli/pages/index.adoc Outdated
Comment thread docs/modules/pkl-cli/pages/index.adoc Outdated

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

https://github.com/apple/pkl/issues/20[GitHub Issue #20] is used to track progress on support for the Windows platform.

@holzensp

Copy link
Copy Markdown
Collaborator

@mitchcapper had you had a chance to take a look at the comments?

@mitchcapper
mitchcapper force-pushed the windows_cli_install_notes branch from 9fba2f4 to f58ebf0 Compare April 23, 2024 20:03
@mitchcapper

Copy link
Copy Markdown
Contributor Author

Sorry for the delay was trying to figure out where I had the checkout. Should be good to go.

@holzensp holzensp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM. Thanks for the submission and the polish!

@holzensp
holzensp merged commit 583dfc6 into apple:main Apr 24, 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.

2 participants