Tianqi-Dotes commented on a change in pull request #199: URL: https://github.com/apache/incubator-dolphinscheduler-website/pull/199#discussion_r512046611
########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) Review comment: maybe keep consistent with the catalog Submit Guide-Document Notice ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! Review comment: the second join maybe unnecessary ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. Review comment: item->project is better ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +``` +git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website +``` + +### The document environment. + +The Dolphin Scheduler website is supported by [docsite](https://github.com/txd-team/docsite) + +If your docsite version is below "1.3.3," upgrade to "1.3.3". + +Make sure that your node version is 8.x, docsite does not yet support versions higher than 8.x. + +### Document build guide. + +1. Run the "npm install docsite-g" installation development tool. + +2. Run "npm i" in the root folder to install the dependency. + +3. Running "docsite start" under the root folder starts the local server, which will allow you to access http://127.0.0.1:8080. Review comment: folder ->directory is better ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +``` +git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website +``` + +### The document environment. + +The Dolphin Scheduler website is supported by [docsite](https://github.com/txd-team/docsite) + +If your docsite version is below "1.3.3," upgrade to "1.3.3". + +Make sure that your node version is 8.x, docsite does not yet support versions higher than 8.x. + +### Document build guide. + +1. Run the "npm install docsite-g" installation development tool. + +2. Run "npm i" in the root folder to install the dependency. + +3. Running "docsite start" under the root folder starts the local server, which will allow you to access http://127.0.0.1:8080. + +4. Run "docsite build" to generate the source code for the document site. + +5. Verify your changes locally: `python -m SimpleHTTPServer 8000`, when python is version 3, use: `python3 - m http.server 8000`. + +If the latest version of node is installed locally, consider using "nvm" to allow different versions of node to run on your computer. + +1. Refer to the [Instructions](http://nvm.sh) to install nvm. + +2. Run “nvm install v8.16.0” to install node v8. + +3. Run “nvm use v8.16.0” to switch the current working environment to node v8. + +4. Run `npm install docsite-g` + +Now you can run and build a website in your local environment. + +### The document specification. + +1. Between Chinese characters and English numbers ** Spaces are Required ** Between Chinese punctuation mark and English numbers ** Spaces are not required ** to enhance the aesthetics and readability of the Chinese-English mix. + +2. It is recommended that you use "you" in general. Of course, you can use the term "you" when necessary, such as when there is a warning prompt. Review comment: the second "you" maybe change to a more polite word ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +``` +git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website +``` + +### The document environment. + +The Dolphin Scheduler website is supported by [docsite](https://github.com/txd-team/docsite) + +If your docsite version is below "1.3.3," upgrade to "1.3.3". + +Make sure that your node version is 8.x, docsite does not yet support versions higher than 8.x. + +### Document build guide. + +1. Run the "npm install docsite-g" installation development tool. + +2. Run "npm i" in the root folder to install the dependency. + +3. Running "docsite start" under the root folder starts the local server, which will allow you to access http://127.0.0.1:8080. + +4. Run "docsite build" to generate the source code for the document site. + +5. Verify your changes locally: `python -m SimpleHTTPServer 8000`, when python is version 3, use: `python3 - m http.server 8000`. + +If the latest version of node is installed locally, consider using "nvm" to allow different versions of node to run on your computer. + +1. Refer to the [Instructions](http://nvm.sh) to install nvm. + +2. Run “nvm install v8.16.0” to install node v8. + +3. Run “nvm use v8.16.0” to switch the current working environment to node v8. + +4. Run `npm install docsite-g` + +Now you can run and build a website in your local environment. + +### The document specification. + +1. Between Chinese characters and English numbers ** Spaces are Required ** Between Chinese punctuation mark and English numbers ** Spaces are not required ** to enhance the aesthetics and readability of the Chinese-English mix. Review comment: from the original doc, English and numbers are separated. ** Spaces are Required ** between Chinese characters and English or numbers and ** Spaces are not required ** between Chinese punctuation marks and English or numbers, to enhance the aesthetics and readability of the Chinese-English mix. ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) + +### 2. Participate in code contributions. + +Refer to the [Participating in Contributions To Issue](issue.md), [What you need to know to make a Contribution Pull Request.](pull-request.md), [What you need to make a Contributing CommitMessage.](commit_message.md) + +### 3. How to pick up an Issue and submit a Pull Request. + +If you want to implement a Feature or fix a bug. Please refer to the following: + +* All Bugs and the new Features are recommended and managed using the Issues Page. +* If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment. +* It's a good idea to find a mentor (mentor) in the core contributors who gives immediate feedback on design and functional implementation. Review comment: maybe use synonyms of the mentor, eg: instructor ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) + +### 2. Participate in code contributions. + +Refer to the [Participating in Contributions To Issue](issue.md), [What you need to know to make a Contribution Pull Request.](pull-request.md), [What you need to make a Contributing CommitMessage.](commit_message.md) + +### 3. How to pick up an Issue and submit a Pull Request. + +If you want to implement a Feature or fix a bug. Please refer to the following: + +* All Bugs and the new Features are recommended and managed using the Issues Page. +* If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment. +* It's a good idea to find a mentor (mentor) in the core contributors who gives immediate feedback on design and functional implementation. +* You should create a new branch to start your work, to get the name of the branch refer to the [What you need to know to make a Contribution Pull Request](pull-request.md). For example, if you want to complete the feature and submit Issue 111, your branch name should be feature-111. The feature name can be determined after discussion with the instructor. Review comment: maybe keep consistent with the catalog Submit Guide-Pull Request Notice ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) + +### 2. Participate in code contributions. + +Refer to the [Participating in Contributions To Issue](issue.md), [What you need to know to make a Contribution Pull Request.](pull-request.md), [What you need to make a Contributing CommitMessage.](commit_message.md) + +### 3. How to pick up an Issue and submit a Pull Request. + +If you want to implement a Feature or fix a bug. Please refer to the following: + +* All Bugs and the new Features are recommended and managed using the Issues Page. +* If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment. +* It's a good idea to find a mentor (mentor) in the core contributors who gives immediate feedback on design and functional implementation. +* You should create a new branch to start your work, to get the name of the branch refer to the [What you need to know to make a Contribution Pull Request](pull-request.md). For example, if you want to complete the feature and submit Issue 111, your branch name should be feature-111. The feature name can be determined after discussion with the instructor. +* When you're done, send a Pull Request to incubator-dolphinscheduler, please refer to the《[Submit Code Process Below for details](submit-code.md)》 + +If you want to submit a Pull Request to complete a Feature or fix a bug, it is recommended that you start small, complete a small function to submit, do not change too many files at a time, changing too many files will also put a lot of pressure on Reviewers, it is recommended to submit them through multiple Pull Requests, not all at once. Review comment: 2 places: 1.bug->Bug 2. the sentence ' it is recommended that you start small', start small sounds wired and maybe need a fix. ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) + +### 2. Participate in code contributions. + +Refer to the [Participating in Contributions To Issue](issue.md), [What you need to know to make a Contribution Pull Request.](pull-request.md), [What you need to make a Contributing CommitMessage.](commit_message.md) Review comment: maybe keep consistent with the catalog Submit Guide-Issue Notice Submit Guide-Pull Request Notice Submit Guide-Commit Message Notice ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) + +### 2. Participate in code contributions. + +Refer to the [Participating in Contributions To Issue](issue.md), [What you need to know to make a Contribution Pull Request.](pull-request.md), [What you need to make a Contributing CommitMessage.](commit_message.md) + +### 3. How to pick up an Issue and submit a Pull Request. + +If you want to implement a Feature or fix a bug. Please refer to the following: + +* All Bugs and the new Features are recommended and managed using the Issues Page. +* If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment. +* It's a good idea to find a mentor (mentor) in the core contributors who gives immediate feedback on design and functional implementation. +* You should create a new branch to start your work, to get the name of the branch refer to the [What you need to know to make a Contribution Pull Request](pull-request.md). For example, if you want to complete the feature and submit Issue 111, your branch name should be feature-111. The feature name can be determined after discussion with the instructor. +* When you're done, send a Pull Request to incubator-dolphinscheduler, please refer to the《[Submit Code Process Below for details](submit-code.md)》 Review comment: maybe keep consistent with the catalog Submit Guide-Submit Pull Request Process ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) + +### 2. Participate in code contributions. + +Refer to the [Participating in Contributions To Issue](issue.md), [What you need to know to make a Contribution Pull Request.](pull-request.md), [What you need to make a Contributing CommitMessage.](commit_message.md) + +### 3. How to pick up an Issue and submit a Pull Request. + +If you want to implement a Feature or fix a bug. Please refer to the following: Review comment: bug -> Bug ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +``` +git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website +``` + +### The document environment. + +The Dolphin Scheduler website is supported by [docsite](https://github.com/txd-team/docsite) + +If your docsite version is below "1.3.3," upgrade to "1.3.3". + +Make sure that your node version is 8.x, docsite does not yet support versions higher than 8.x. + +### Document build guide. + +1. Run the "npm install docsite-g" installation development tool. + +2. Run "npm i" in the root folder to install the dependency. Review comment: folder ->directory dependency->dependencies is better ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +``` +git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website +``` + +### The document environment. + +The Dolphin Scheduler website is supported by [docsite](https://github.com/txd-team/docsite) + +If your docsite version is below "1.3.3," upgrade to "1.3.3". Review comment: "1.3.3," ->"1.3.3", ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) + +### 2. Participate in code contributions. + +Refer to the [Participating in Contributions To Issue](issue.md), [What you need to know to make a Contribution Pull Request.](pull-request.md), [What you need to make a Contributing CommitMessage.](commit_message.md) + +### 3. How to pick up an Issue and submit a Pull Request. + +If you want to implement a Feature or fix a bug. Please refer to the following: + +* All Bugs and the new Features are recommended and managed using the Issues Page. +* If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment. +* It's a good idea to find a mentor (mentor) in the core contributors who gives immediate feedback on design and functional implementation. Review comment: or explanation words to the word 'mentor' ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +``` +git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website +``` + +### The document environment. + +The Dolphin Scheduler website is supported by [docsite](https://github.com/txd-team/docsite) + +If your docsite version is below "1.3.3," upgrade to "1.3.3". + +Make sure that your node version is 8.x, docsite does not yet support versions higher than 8.x. + +### Document build guide. + +1. Run the "npm install docsite-g" installation development tool. + +2. Run "npm i" in the root folder to install the dependency. + +3. Running "docsite start" under the root folder starts the local server, which will allow you to access http://127.0.0.1:8080. + +4. Run "docsite build" to generate the source code for the document site. + +5. Verify your changes locally: `python -m SimpleHTTPServer 8000`, when python is version 3, use: `python3 - m http.server 8000`. + +If the latest version of node is installed locally, consider using "nvm" to allow different versions of node to run on your computer. + +1. Refer to the [Instructions](http://nvm.sh) to install nvm. + +2. Run “nvm install v8.16.0” to install node v8. + +3. Run “nvm use v8.16.0” to switch the current working environment to node v8. + +4. Run `npm install docsite-g` + +Now you can run and build a website in your local environment. Review comment: build a website ->build the website is better ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +``` +git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website +``` + +### The document environment. + +The Dolphin Scheduler website is supported by [docsite](https://github.com/txd-team/docsite) + +If your docsite version is below "1.3.3," upgrade to "1.3.3". + +Make sure that your node version is 8.x, docsite does not yet support versions higher than 8.x. + +### Document build guide. + +1. Run the "npm install docsite-g" installation development tool. + +2. Run "npm i" in the root folder to install the dependency. + +3. Running "docsite start" under the root folder starts the local server, which will allow you to access http://127.0.0.1:8080. + +4. Run "docsite build" to generate the source code for the document site. + +5. Verify your changes locally: `python -m SimpleHTTPServer 8000`, when python is version 3, use: `python3 - m http.server 8000`. + +If the latest version of node is installed locally, consider using "nvm" to allow different versions of node to run on your computer. + +1. Refer to the [Instructions](http://nvm.sh) to install nvm. + +2. Run “nvm install v8.16.0” to install node v8. + +3. Run “nvm use v8.16.0” to switch the current working environment to node v8. + +4. Run `npm install docsite-g` + +Now you can run and build a website in your local environment. + +### The document specification. + +1. Between Chinese characters and English numbers ** Spaces are Required ** Between Chinese punctuation mark and English numbers ** Spaces are not required ** to enhance the aesthetics and readability of the Chinese-English mix. + +2. It is recommended that you use "you" in general. Of course, you can use the term "you" when necessary, such as when there is a warning prompt. + +### How to submit a document Pull Request. + +1. Do not use "git add" to commit all changes. + +2. Simply push the changed files, for example: + + * `*.md` + * `blog.js or docs.js or site.js` + +3. Submit the Pull Request to the **master** branch. + +### Refer to the documentation. Review comment: ### Refer to the documentation. -> ### Reference maybe better ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +``` +git clone https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website +``` + +### The document environment. + +The Dolphin Scheduler website is supported by [docsite](https://github.com/txd-team/docsite) + +If your docsite version is below "1.3.3," upgrade to "1.3.3". + +Make sure that your node version is 8.x, docsite does not yet support versions higher than 8.x. + +### Document build guide. + +1. Run the "npm install docsite-g" installation development tool. + +2. Run "npm i" in the root folder to install the dependency. + +3. Running "docsite start" under the root folder starts the local server, which will allow you to access http://127.0.0.1:8080. + +4. Run "docsite build" to generate the source code for the document site. + +5. Verify your changes locally: `python -m SimpleHTTPServer 8000`, when python is version 3, use: `python3 - m http.server 8000`. + +If the latest version of node is installed locally, consider using "nvm" to allow different versions of node to run on your computer. + +1. Refer to the [Instructions](http://nvm.sh) to install nvm. + +2. Run “nvm install v8.16.0” to install node v8. + +3. Run “nvm use v8.16.0” to switch the current working environment to node v8. + +4. Run `npm install docsite-g` + +Now you can run and build a website in your local environment. + +### The document specification. + +1. Between Chinese characters and English numbers ** Spaces are Required ** Between Chinese punctuation mark and English numbers ** Spaces are not required ** to enhance the aesthetics and readability of the Chinese-English mix. + +2. It is recommended that you use "you" in general. Of course, you can use the term "you" when necessary, such as when there is a warning prompt. + +### How to submit a document Pull Request. + +1. Do not use "git add" to commit all changes. Review comment: "git add" should be "git add." ########## File path: docs/en-us/development/document.md ########## @@ -1 +1,67 @@ -## TODO \ No newline at end of file +## Contribute documentation. + +Good documentation is critical for any type of software. Any contribution that can improve the Dolphin Scheduler documentation is welcome. + + +### Get the document item. + +Documentation for the Dolphin Scheduler project is maintained in a separate [git Warehouse](https://github.com/apache/incubator-dolphinscheduler-website). Review comment: Warehouse->repository ########## File path: docs/en-us/development/contribute.md ########## @@ -1 +1,40 @@ -# todo \ No newline at end of file +## Contribute + +First of all, thank you very much for choosing and using Dolphin Scheduler, and welcome to join the Dolphin Scheduler family and join the open source world! + +We encourage any form of participation in the community that will eventually become Committer or PPMC Such as: +* Problems will be encountered via github on the [issue](https://github.com/apache/incubator-dolphinscheduler/issues) form feedback out. +* Answer the issue questions that others are asking. +* Help improve the documentation. +* Help your project add test cases. +* Add comments to the code. +* Submit a PR that fixes the bug or Feature. +* Publish application case practice, scheduling process analysis, or technical articles related to scheduling. +* Help promote Dolphin Scheduler, participate in technical conferences or meetup, sharing and more. + +Welcome to the contributing team and join open source starting with submitting your first PR. + - For example, add code comments or find "easy to fix" tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR. + +Note: Contributions are not limited to PR Only, but contribute to the development of the project. + +I'm sure you'll benefit from open source by participating in Dolphin Scheduler! + +### 1. Participate in documentation contributions. + +Refer to the [Participate in Contributions To Documentation](document.md) + +### 2. Participate in code contributions. + +Refer to the [Participating in Contributions To Issue](issue.md), [What you need to know to make a Contribution Pull Request.](pull-request.md), [What you need to make a Contributing CommitMessage.](commit_message.md) Review comment: and please remove dots at the end of ] ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
