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

Document using installType and installDirectory #34

Open
jpogran opened this issue May 26, 2020 · 0 comments
Open

Document using installType and installDirectory #34

jpogran opened this issue May 26, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jpogran
Copy link
Contributor

jpogran commented May 26, 2020

The extension works when there is both pdk and agent present, and when only one is present. The problem here is that the settings for the extension are not helping the user choose successful configurations and allowing mixing of settings that then produce incorrect paths to the parts of puppet we need.

The intention for auto was to not use installDirectory or installType, so that the extension would choose whether to use pdk or agent and which paths to use itself. This was intended to make the default 'happy path' the situation where a user has pdk installed to the default path and not require the user to set any settings.

Items to document:

  • If you installed either pdk or agent to the default install paths, and you want the extension to figure out whether to use pdk or agent, then do not set any settings.
  • If you installed either pdk or agent to the default install paths, but want to choose whether to use pdk or agent, set installType and omit installDirectory.
  • If you installed either pdk or agent to custom install paths, you must specify installType as either agent or pdk, and set installDirectory to the correct path.

Originally posted by @jpogran in puppetlabs/puppet-vscode#668 (comment)

@jpogran jpogran added this to the 0.2.0 milestone Jan 30, 2021
@jpogran jpogran added the documentation Improvements or additions to documentation label Jan 30, 2021
@jpogran jpogran self-assigned this Jan 30, 2021
@jpogran jpogran removed their assignment Aug 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant