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

add vscode mentions #3898

Merged
merged 9 commits into from
Jul 8, 2024
Merged

add vscode mentions #3898

merged 9 commits into from
Jul 8, 2024

Conversation

noklam
Copy link
Contributor

@noklam noklam commented May 28, 2024

Description

Partly: kedro-org/vscode-kedro#11
Add mentions of VSCode extension.

Development notes

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@noklam noklam requested a review from merelcht June 10, 2024 06:35
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

Left some comments

docs/source/development/set_up_vscode.md Outdated Show resolved Hide resolved
@@ -80,7 +80,11 @@ To exit `kedro-environment`:
```bash
conda deactivate
```
### Optional: Setup Kedro with IDE
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### Optional: Setup Kedro with IDE
### Optional: Add Kedro support to your IDE

? (Unusure about this one as well, requesting @stichbury's opinion)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Integrate ESLint in VSCode with the official extension

Integrate Kedro in VS Code with the official extension? @astrojuanlu

Copy link
Member

Choose a reason for hiding this comment

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

+1!

docs/source/get_started/install.md Outdated Show resolved Hide resolved
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@astrojuanlu
Copy link
Member

sphinx.errors.SphinxWarning: /home/docs/checkouts/readthedocs.org/user_builds/kedro/checkouts/3898/docs/source/get_started/install.md:86:local id not found in doc 'development/set_up_vscode': 'kedro-vscode-extension' [myst.xref_missing]

Warning, treated as error:
/home/docs/checkouts/readthedocs.org/user_builds/kedro/checkouts/3898/docs/source/get_started/install.md:86:local id not found in doc 'development/set_up_vscode': 'kedro-vscode-extension' [myst.xref_missing]


For VS Code Users: Checkout [Set up Visual Studio Code](../development/set_up_vscode.md) and [Kedro VS Code Extension](../development/set_up_vscode.md#kedro-vscode-extension)
Copy link
Member

Choose a reason for hiding this comment

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

I guess

Suggested change
For VS Code Users: Checkout [Set up Visual Studio Code](../development/set_up_vscode.md) and [Kedro VS Code Extension](../development/set_up_vscode.md#kedro-vscode-extension)
For VS Code Users: Checkout [Set up Visual Studio Code](../development/set_up_vscode.md) and [Kedro VS Code Extension](../development/set_up_vscode.md#kedro-vs-code-extension)

?

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@noklam noklam merged commit ab2e479 into main Jul 8, 2024
10 checks passed
@noklam noklam deleted the noklam/vscode-mention branch July 8, 2024 11:12
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.

4 participants