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 document for connector #615

Merged
merged 3 commits into from
Aug 19, 2024
Merged

Conversation

huyleminh01
Copy link
Contributor

@huyleminh01 huyleminh01 commented Aug 19, 2024

Summary

Refactor js module document:

  • Add connector and core pages
  • Add plugin npm2yarn
  • Config to show more level on TOC

localhost_3000_js-module_connector

Issue

(issue link here)

Lasting Changes (Technical)

(please list down: code changes/things that have wide-effect; new libraries/functions added that can be used by others; examples below)

  • (Added class EmailValidator to validate email address' validity)
  • (Added Tenant#is_trial? check)

Checklist

Please check directly on the box once each of these are done

  • Documentation (if necessary)
  • Tests (integration test/unit test)
  • Integration Tests Passed
  • Code Review

- Add connector and core pages
- Add plugin npm2yarn
- Config to show more level on TOC
@huyleminh01 huyleminh01 added PR: Docs 📝 A type of pull request used for changelog categories PR: Refactor 🧹 labels Aug 19, 2024

## Prerequisites

Before you begin, ensure you have met the following requirements:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think:
We already have Prerequisites header. So I think you could shorten this one to:

Please ensure you have met the following requirements:
...


Before you begin, ensure you have met the following requirements:

- **Node.js**: You need to have Node.js version 18.0.0 or higher installed.
Copy link
Collaborator

Choose a reason for hiding this comment

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

There is only one requirement her. I suggest:

## Prerequisites

- Require Nodejs version 18.0.0 or higher.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in commit 790438d

Copy link
Contributor

@nguyenalter nguyenalter left a comment

Choose a reason for hiding this comment

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

Please help check if you can disable reviewdog check for hardcoded connection string in markdown files.

dbml-homepage/configs/sidebars.ts Outdated Show resolved Hide resolved
dbml-homepage/docs/js-module/connector.md Outdated Show resolved Hide resolved
dbml-homepage/docusaurus.config.ts Show resolved Hide resolved
dbml-homepage/docs/js-module/connector.md Outdated Show resolved Hide resolved
@huyleminh01 huyleminh01 force-pushed the docs/add-connector-module branch from 79d857e to e2f83b9 Compare August 19, 2024 09:41
@huyleminh01 huyleminh01 merged commit 0ddc472 into master Aug 19, 2024
4 checks passed
@huyleminh01 huyleminh01 deleted the docs/add-connector-module branch August 19, 2024 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Docs 📝 A type of pull request used for changelog categories PR: Refactor 🧹
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants