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

docs: Add multi-lang IDE integration page #7378

Merged
merged 6 commits into from
May 24, 2024

Conversation

vikram-dagger
Copy link
Contributor

No description provided.

@helderco
Copy link
Contributor

Some thoughts:

  • I think we can make a common explanation for this doc, before the tabs.
  • The user needs to learn about this much sooner, right after creating the first function as it's important for DX to get that LSP experience.
  • If there's info on multiple tools (like in Python), put them in a nested tabbed group.

@vikram-dagger
Copy link
Contributor Author

@helderco please see if my edits address your feedback. Thanks!

@helderco
Copy link
Contributor

This goes without saying that the IDE integrations page needs to go after the user creates their first function, but I assume it's placed the way it is because the nav is in flux due to the pending PRs. The problem with the multiple PRs here is that it puts the docs in an unpublished state in main. Would have made sense to merge PRs against a larger PR for the broader effort, while still keeping the individual reviewable changesets.

There's a few things to correct in Python as only pip needs to manually create and activate the venv for example, but I'll need a bit more time to suggest specific changes.

Few more notes:

  • I think it's useful to have a common paragraph on dagger develop, before the tabs.
  • Just installing the dependencies locally isn't enough. The focus should be on the IDEs. If you're using VSCode for example, it may not matter if you've installed and activated the venv in your shell if the editor handles those in it's own way. I think it's still usefull to show those instructions, but as an addition to making sure the editor knows about the venv.
  • I suppose this page could be simplified if you think about a person using the default template. In that case, the user won't be using Poetry for example, but it might be using Hatch though. These tool specific details could go into the language-specific details page though, and keep this one as simple as possible for those that are starting out.

@vikram-dagger
Copy link
Contributor Author

There's a few things to correct in Python as only pip needs to manually create and activate the venv for example, but I'll need a bit more time to suggest specific changes.

I've made this change, will wait to have more notes from you on this.

  • I think it's useful to have a common paragraph on dagger develop, before the tabs.

Added

  • Just installing the dependencies locally isn't enough. The focus should be on the IDEs. If you're using VSCode for example, it may not matter if you've installed and activated the venv in your shell if the editor handles those in it's own way. I think it's still usefull to show those instructions, but as an addition to making sure the editor knows about the venv.

I'm not sure what change is needed here, can you suggest inline?

  • I suppose this page could be simplified if you think about a person using the default template. In that case, the user won't be using Poetry for example, but it might be using Hatch though. These tool specific details could go into the language-specific details page though, and keep this one as simple as possible for those that are starting out.

I think it's fine here, I'd like to keep the language-specific category as thin as possible.

Signed-off-by: Vikram Vaswani <vikram@dagger.io>
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
@vikram-dagger vikram-dagger merged commit f1485c1 into dagger:main May 24, 2024
59 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.

None yet

3 participants