Modify README.md & CONTRIBUTING.md

- Incorporated from https://github.com/azure/azure-sdk - Customization for this repository with Korean explanation
2021-07-24 05:33:02 +09:00 · 2021-07-24 05:33:02 +09:00 · c6f73d332f
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,75 @@
+# Azure SDK Contribution Guide
+
+The Azure SDK project welcomes contributions and suggestions.  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
+
+## Azure SDK Korean GitHub Pages Site Contributions
+
+Here's the general contribution process:
+
+1. Fork this repo
+1. Create a new branch
+1. Commit your changes to that branch
+1. Do a PR from your fork/branch to azure-sdk-korean/main.
+
+## Codespaces
+
+Codespaces is new technology that allows you to use a container as your development environment. This repo provides a Codespaces container which is supported by both GitHub Codespaces and VS Code Codespaces.
+
+### GitHub Codespaces
+
+1. From the Azure SDK GitHub repo, click on the "Code -> Open with Codespaces" button.
+1. Open a Terminal
+1. Execute the following command and `Ctrl+Click` the link generated.  A new window will open with the Azure SDK website.
+
+    ```bash
+    bundle exec jekyll serve
+    ```
+
+### VS Code Codespaces
+
+1. Install the [VS Code Remote Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)
+1. When you open the Azure SDK repo in VS Code, it will prompt you to open the project in the Dev Container. If it does not prompt you, then hit CTRL+P, and select "Remote-Containers: Open Folder in Container..."
+1. Open a Terminal
+1. Press `Ctrl+Shift+T` or execute the following command and `Ctrl+Click` the link generated.  A new window will open with the Azure SDK website.
+
+    ```bash
+    bundle exec jekyll serve
+    ```
+
+## Full Local Setup
+
+This site uses Jekyll and GitHub pages. Installation instructions can be found here: https://jekyllrb.com/docs/installation
+
+Here's how to setup the site locally:
+
+1. [Install Ruby+DevKit 2.6](https://rubyinstaller.org/downloads/) - Don't install 2.7, it doesn't work with this site.
+
+    You can find complete installation instructions here: https://jekyllrb.com/docs/installation
+
+1. Restart your machine
+
+    You may need to restart your machine after installing Ruby.
+
+1. Install Jekyll
+
+    ```bash
+    gem install jekyll bundler
+    ```
+
+1. Install Dependencies
+
+    Run the following command from the root of the azure-sdk project.
+
+    ```bash
+    bundle install
+    ```
+
+1. Open a terminal and execute the following command to start the site:
+
+    ```bash
+    bundle exec jekyll serve
+    ```
+
+1. Open a browser to https://127.0.0.1:4000 to run the site.
--- a/README.md
+++ b/README.md
@ -1,33 +1,80 @@
-# Project
+# Azure SDK Documentation for Korean

-> This repo has been populated by an initial template to help get you started. Please
-> make sure to update the content to build a great experience for community-building.
+(For English, please visit https://github.com/Azure/azure-sdk repository)

-As the maintainer of this project, please make a few updates:
+Azure SDK는 개발자가 다양한 Azure 서비스를 원하는 프로그래밍 언어로 활용할 수 있는 플랫폼을 제공하고 있습니다. 각 언어에 대한 소스 저장소에 해당 클라이언트 라이브러리에 대한 소스 코드가 있습니다. 이 저장소는 해당 프로그래밍 언어 별 저장소를 가리키며, 한글로 보다 자세한 설명을 공유하고자 합니다. 구체적인 이슈는 각 SDK 저장소를 통해 확인하실 수 있습니다.

- Improving this README.MD file to provide a great experience
- Updating SUPPORT.MD with content about this project's support experience
- Understanding the security reporting process in SECURITY.MD
- Remove this section from the README

-## Contributing
+
+| 언어         | 디자인 가이드라인 (영문)                          | 패키지                 | 저장소                            | 문서 (영문)                        |
+|:------------|:-------------------------------------------:|:--------------------:|:--------------------------------:|:--------------------------------:|
+| General     |[General Design Guidelines]                  |                      |[azure-sdk Repository]            | [Official Azure Documentation]   |
+| Android     |[Design Guidelines for Android] (Draft)      |[Android Packages]    |[azure-sdk-for-android Repository]| Coming Soon                      |
+| C# /.NET    |[Design Guidelines for .NET]                 |[.NET Packages]       |[azure-sdk-for-net Repository]    | [.NET Documentation]             |
+| Go          |[Design Guidelines for Go] (Draft)           |[Go Packages]         |[azure-sdk-for-go Repository]     | [Go Documentation]               |
+| C           |[Design Guidelines for C99] (Draft)          |[C Packages]          |[azure-sdk-for-c Repository]      | [C Documentation]                |
+| C++         |[Design Guidelines for C++] (Draft)          |[C++ Packages]        |[azure-sdk-for-cpp Repository]    | [C++ Documentation]              |
+| iOS         |[Design Guidelines for iOS] (Draft)          |[iOS Packages]        |[azure-sdk-for-ios Repository]    | Coming Soon                      |
+| Java        |[Design Guidelines for Java]                 |[Java Packages]       |[azure-sdk-for-java Repository]   | [Java Documentation]             |
+| JavaScript  |[Design Guidelines for TypeScript]           |[JavaScript Packages] |[azure-sdk-for-js Repository]     | [JavaScript Documentation]       |
+| Python      |[Design Guidelines for Python]               |[Python Packages]     |[azure-sdk-for-python Repository] | [Python Documentation]           |
+
+# 기여하기 (Contributing)
+
+본 저장소는 Microsoft 오픈 소스에 기여하기 위한 가이드라인을 따르고 있습니다.

 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
 Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+the rights to use your contribution. For details, visit https://cla.microsoft.com.

-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
 provided by the bot. You will only need to do this once across all repos using our CLA.

+Please see our [contributing guide](CONTRIBUTING.md) for complete instructions on how you can contribute to the Azure SDK. For instructions on how to contribute to each individual SDK, please check the CONTRIBUTING.md in each language repo.
+
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
 contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

-## Trademarks
+[General Design Guidelines]: https://azure.github.io/azure-sdk/general_introduction.html
+[Design Guidelines for Android]: https://azure.github.io/azure-sdk/android_design.html
+[Design Guidelines for .NET]: https://azure.github.io/azure-sdk/dotnet_introduction.html
+[Design Guidelines for Go]: https://azure.github.io/azure-sdk/golang_introduction.html
+[Design Guidelines for C99]: https://azure.github.io/azure-sdk/clang_design.html
+[Design Guidelines for C++]: https://azure.github.io/azure-sdk/cpp_introduction.html
+[Design Guidelines for iOS]: https://azure.github.io/azure-sdk/ios_introduction.html
+[Design Guidelines for Java]: https://azure.github.io/azure-sdk/java_introduction.html
+[Design Guidelines for TypeScript]: https://azure.github.io/azure-sdk/typescript_introduction.html
+[Design Guidelines for Python]: https://azure.github.io/azure-sdk/python_design.html
+[revproc]: https://azure.github.io/azure-sdk/policies_reviewprocess.html

-This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
-trademarks or logos is subject to and must follow 
-[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
-Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
-Any use of third-party trademarks or logos are subject to those third-party's policies.
+[azure-sdk Repository]: https://github.com/Azure/azure-sdk
+[azure-sdk-for-android Repository]: https://github.com/Azure/azure-sdk-for-android
+[azure-sdk-for-net Repository]: https://github.com/Azure/azure-sdk-for-net
+[azure-sdk-for-go Repository]: https://github.com/Azure/azure-sdk-for-go
+[azure-sdk-for-c Repository]: https://github.com/Azure/azure-sdk-for-c
+[azure-sdk-for-cpp Repository]: https://github.com/Azure/azure-sdk-for-cpp
+[azure-sdk-for-ios Repository]: https://github.com/Azure/azure-sdk-for-ios
+[azure-sdk-for-java Repository]: https://github.com/Azure/azure-sdk-for-java
+[azure-sdk-for-js Repository]: https://github.com/Azure/azure-sdk-for-js
+[azure-sdk-for-python Repository]: https://github.com/Azure/azure-sdk-for-python
+
+[Official Azure Documentation]: http://aka.ms/azure-sdk-docs
+[.NET Documentation]: http://aka.ms/net-docs
+[Go Documentation]: http://aka.ms/go-docs
+[Java Documentation]: http://aka.ms/java-docs
+[JavaScript Documentation]: http://aka.ms/js-docs
+[Python Documentation]: https://aka.ms/python-docs
+[C Documentation]: https://aka.ms/c-docs
+[C++ Documentation]: https://aka.ms/cpp-docs
+
+[.NET Packages]: https://azure.github.io/azure-sdk/releases/latest/dotnet.html
+[Java Packages]: https://azure.github.io/azure-sdk/releases/latest/java.html
+[Javascript Packages]: https://azure.github.io/azure-sdk/releases/latest/js.html
+[Python Packages]: https://azure.github.io/azure-sdk/releases/latest/python.html
+[C Packages]: https://azure.github.io/azure-sdk/releases/latest/c.html
+[C++ Packages]: https://azure.github.io/azure-sdk/releases/latest/cpp.html
+[Android Packages]: https://azure.github.io/azure-sdk/releases/latest/android.html
+[iOS Packages]: https://azure.github.io/azure-sdk/releases/latest/ios.html
+[Go Packages]: https://azure.github.io/azure-sdk/releases/latest/go.html