Merge pull request #1 from sparrow-cloud/stag

Update 2407.1
sparrow-cloud · Jul 24, 2024 · 71a00af · 71a00af
2 parents b065523 + 510318e
commit 71a00af
Show file tree

Hide file tree

Showing 27 changed files with 184 additions and 66 deletions.
diff --git a/Writerside/hi.tree b/Writerside/hi.tree
@@ -21,9 +21,11 @@
         </toc-element>
         <toc-element topic="Analysis-Report.md"/>
         <toc-element topic="Export-SBOM.md"/>
+        <toc-element topic="Subscription-List.md"/>
     </toc-element>
     <toc-element topic="FAQ.md">
         <toc-element topic="Subscription.md"/>
+        <toc-element topic="Change-Password.md"/>
         <toc-element topic="GitHub.md"/>
     </toc-element>
 </instance-profile>
diff --git a/Writerside/images/myaccount_info.png b/Writerside/images/myaccount_info.png
diff --git a/Writerside/images/myaccount_sub00.png b/Writerside/images/myaccount_sub00.png
diff --git a/Writerside/images/myaccount_sub01.png b/Writerside/images/myaccount_sub01.png
diff --git a/Writerside/images/payment01.png b/Writerside/images/payment01.png
diff --git a/Writerside/images/payment02.png b/Writerside/images/payment02.png
diff --git a/Writerside/images/report.png b/Writerside/images/report.png
diff --git a/Writerside/images/signup_email01.png b/Writerside/images/signup_email01.png
diff --git a/Writerside/images/subscr01.png b/Writerside/images/subscr01.png
diff --git a/Writerside/images/subscr02.png b/Writerside/images/subscr02.png
diff --git a/Writerside/images/subscr03.png b/Writerside/images/subscr03.png
diff --git a/Writerside/images/회원가입.png b/Writerside/images/회원가입.png
diff --git a/Writerside/images/회원가입_추가정보.png b/Writerside/images/회원가입_추가정보.png
diff --git a/Writerside/topics/Analysis-Option.md b/Writerside/topics/Analysis-Option.md
@@ -6,10 +6,10 @@ switcher-label: Language
 
 ## 분석 옵션 {switcher-key="한국어"}
 
-Sparrow Cloud는 특히 웹 취약점 분석에 대한 다양한 옵션을 준비했습니다. 분석을 수행하기 전에 다음과 같이 옵션을 설정할 수 있습니다.
+Sparrow Cloud는 특히 웹취약점 분석에 대한 다양한 옵션을 준비했습니다. 분석을 수행하기 전에 다음과 같이 옵션을 설정할 수 있습니다.
 
 
-### 웹 취약점 분석 옵션 
+### 웹취약점 분석 옵션 
 
 
 **상세 수행 로그**
@@ -34,7 +34,7 @@ Sparrow Cloud는 특히 웹 취약점 분석에 대한 다양한 옵션을 준
 
 **일반 본문 분석**
 
-일반 본문 분석은 **URL 수집중에 받은 응답 메시지의 본문이 HTML이 아닌 일반 본문에서 URL을 수집**하는지를 의미하며 `예`, `아니요`로 구분합니다.(기본값: `예`)
+일반 본문 분석은 **URL 수집 중에 받은 응답 메시지의 본문이 HTML이 아닌 일반 본문에서 URL을 수집**하는지를 의미하며 `예`, `아니요`로 구분합니다.(기본값: `예`)
 
 이 옵션을 `예`로 설정하면 **일반 본문에서 URL 패턴을 사용하여 URL을 수집**합니다. 이로 인해 더 많은 URL을 수집하게 되지만 HTML뿐만 아니라 모든 본문을 분석하기 때문에 분석 속도가 느려지고 의미없는 URL을 수집할 가능성이 높습니다.
 
@@ -201,10 +201,10 @@ HTTP 클라이언트 대기 시간은 **HTTP 클라이언트가 분석을 수행
 
 ## Analysis Option {switcher-key="English"}
 
-Sparrow Cloud has prepared various options especially for web vulnerability analysis. You can set the options as follows before performing the analysis.
+Sparrow Cloud has prepared various options especially for web app analysis. You can set the options as follows before performing the analysis.
 
 
-### Web Vulnerability Analysis Options 
+### Web App Analysis Options 
 
 
 

diff --git a/Writerside/topics/Analysis-Report.md b/Writerside/topics/Analysis-Report.md
@@ -18,6 +18,16 @@ Sparrow Cloud에서는 PDF 형식의 분석 보고서를 제공합니다. 다음
 
 > **Tip**: 분석 보고서 파일이 너무 큰 경우 여러 개의 파일로 나뉘어서 출력됩니다.
 
+보고서에는 다음과 같은 내용이 포함됩니다.
+
+- 요약 정보         : 프로젝트 및 분석에 대한 간단한 정보.
+- 위험도별 이슈 수   : 각 위험도에 해당하는 이슈 수.
+- 레퍼런스별 이슈 수 : 검출된 이슈와 매핑된 레퍼런스 및 각 레퍼런스에 해당하는 이슈 수. 
+- 이슈 상세 결과     : 이슈에 대한 설명, 해당하는 레퍼런스를 비롯한 이슈 유형에 따른 자세한 정보.
+- 제외된 이슈 정보   : 제외된 이슈에 대한 정보.
+- 이슈 검출 규칙 정보 : 이슈를 검출한 규칙의 목록.
+
+<img src="report.png" alt="Alt text" width="450"/>
 
 ## Export Report {switcher-key="English"}
 
@@ -33,4 +43,16 @@ Sparrow Cloud provides reports on the analysis in PDF format. Export the report
 6. Click the **Export** button.
 
 > **Tip**: If the analysis report file is too large, it will be split into multiple files.
- 
+
+
+The report contains the following content:
+
+- Summary information: brief information about the project and the analysis.
+- Issue count by risk: the number of issues corresponding to each risk.
+- Issue count by reference: the references mapped to the detected issues and the number of issues corresponding to each reference.
+- Issue detail results: detailed information for the issues, including a description and references.
+- Excluded issue information: information about excluded issues.
+- Issue detection rule information: list of detection rules.
+
+
+<img src="report.png" alt="Alt text" width="450"/>
diff --git a/Writerside/topics/Analysis-Results.md b/Writerside/topics/Analysis-Results.md
@@ -16,14 +16,14 @@ switcher-label: Language
 
 ### 이슈 
 
-**이슈**는 분석 대상을 분석한 결과로써 발견한 보안 취약점 및 품질 관련 문제를 가리킵니다. **이슈** 탭에 표시되는 **이슈 목록**에는 Sparrow Cloud에서 검출한 이슈가 포함되어 있습니다. 이슈는 검출한 도구에 따라서 **소스코드 이슈**, **컴포넌트 이슈**, **웹 취약점 이슈**로 분류됩니다.
+**이슈**는 분석 대상을 분석한 결과로써 발견한 보안 취약점 및 품질 관련 문제를 가리킵니다. **이슈** 탭에 표시되는 **이슈 목록**에는 Sparrow Cloud에서 검출한 이슈가 포함되어 있습니다. 이슈는 검출한 도구에 따라서 **소스코드 이슈**, **오픈소스 이슈**, **웹취약점 이슈**로 분류됩니다.
 
 이슈에 대한 더 자세한 내용은 [이슈](Issue.md)를 참고하세요.
 
 
 ### 자산 
 
-Sparrow Cloud는 **자산**이라는 분석 결과를 표시합니다. 자산은 분석에 사용한 분석 대상에서 생성됩니다: 분석 대상에 포함된 파일이나 하위 URL을 식별하고 이 정보로 **자산 목록**을 보여줍니다. 분석 대상에 따라서 소스코드 분석과 컴포넌트 분석에 사용된 리포지토리에서 식별한 자산은 **파일**로 표시되고, 웹 취약점 분석에 사용된 웹 페이지에서 시결한 자산은 **URL**로 표시됩니다.
+Sparrow Cloud는 **자산**이라는 분석 결과를 표시합니다. 자산은 분석에 사용한 분석 대상에서 생성됩니다: 분석 대상에 포함된 파일이나 하위 URL을 식별하고 이 정보로 **자산 목록**을 보여줍니다. 분석 대상에 따라서 소스코드 분석과 오픈소스 분석에 사용된 리포지토리에서 식별한 자산은 **파일**로 표시되고, 웹 취약점 분석에 사용된 웹 페이지에서 시결한 자산은 **URL**로 표시됩니다.
 
 자산에 대한 더 자세한 내용은 [자산](Asset.md)을 참고하세요.
 
@@ -41,27 +41,27 @@ The results you can see in your project include the findings from your **recent
 
 > **Tip**: Note that you can't see the results of analyses performed before **Recent Analyses**.
 
-To see detailed results, click the four tabs on the right side of the project: **Summary**, **Issues**, **Assets**, and **Components**.
+To see detailed results, click the four tabs on the right side of the project: **Summary**, **Issue**, **Asset**, and **Component**.
 
 <img src="projdetails01.png" alt="Alt text" width="450"/>
 
 
 ### Issues 
 
-**Issues** are security vulnerabilities and quality issues found as a result of analysing your analysis targets. The **Issues list** displayed in the **Issues** tab contains the issues detected by Sparrow Cloud. Issues are categorised as source code issues, supply chain issues, or web vulnerability issues, depending on the tool that detected them.
+**Issues** are security vulnerabilities and quality problems found as a result of analysing your analysis targets. The **Issues list** displayed in the **Issue** tab contains the issues detected by Sparrow Cloud. Issues are categorised as source code issues, open source issues, or web vulnerability issues, depending on the tool that detected them.
 
 For more information about the issues, see [Issue](Issue.md).
 
 
 ### Assets 
 
-Sparrow Cloud displays analysis results called **Assets**. Assets are generated from the analysis target you used for analysis: It identifies the files or sub URLs contained in the analyse target and uses this information to show a list of **assets**. Depending on the analysis target, assets identified from repositories used for source code analysis and supply chain analysis are shown as **Files**, while assets sourced from web pages used for web vulnerability analysis are shown as **URLs**.
+Sparrow Cloud displays analysis results called **Assets**. Assets are generated from the analysis target you used for analysis: It identifies the files or sub URLs contained in the analyse target and uses this information to show a list of **assets**. Depending on the analysis target, assets identified from repositories used for source code analysis and open source analysis are shown as **Files**, while assets sourced from web pages used for web app analysis are shown as **URLs**.
 
 For more information about assets, see [Asset](Asset.md).
 
 
 ### Components 
 
-**Components** are the smallest units that can identify a specific program and refers to software that requires a licence, proprietary software, open source software, etc. Sparrow Cloud breaks down files into components to identify what software is included in the file being analysed, and organises the open source licences that the components are using into individual components on the Components tab. Components that are under a specific licence are also detected as issues in the issue list.
+**Components** are the smallest units that can identify a specific program and refers to software that requires a licence, proprietary software, open source software, etc. Sparrow Cloud breaks down files into components to identify what software is included in the file being analysed, and organises the open source licences that the components are using into individual components on the **Component** tab. Components that are under a specific licence are also detected as issues in the issue list.
 
 For more information about components, see [Component](Component.md).
diff --git a/Writerside/topics/Change-Password.md b/Writerside/topics/Change-Password.md
@@ -0,0 +1,29 @@
+---
+switcher-label: Language
+---
+# Password 
+
+
+## 비밀번호 변경 {switcher-key="한국어"}
+
+1. 오른쪽 위에 있는 **사용자 이름**을 클릭하세요.
+2. **내 계정**을 선택하세요.
+3. **선택 입력 항목 보기**를 클릭하세요
+
+<img src="myaccount_info.png" alt="Alt text" width="450"/>
+
+4. **비밀번호**와 **비밀번호 확인**을 입력하세요.
+5. 슬라이드 아래에서 **변경하기** 버튼을 클릭하세요.
+
+## Change Password {switcher-key="English"}
+
+1. Click on your **username** in the top right corner 
+2. Select **My Account**. 
+3. Click on **Show Options*.
+
+<img src="myaccount_info.png" alt="Alt text" width="450"/>
+
+4. Enter your new **Password** and **Confirm Password**. 
+5. Click **Change** button at the bottom of the slide.
+
+
diff --git a/Writerside/topics/Export-SBOM.md b/Writerside/topics/Export-SBOM.md
@@ -24,6 +24,8 @@ switcher-label: Language
 * Software Identification (SWID)
 
 5. **내보내기** 버튼을 클릭하세요.
+6. 스텝페이의 지시에 따라 결재를 완료하세요.
+7. 이제 Sparrow Cloud의 상품을 구입했습니다.
 
 
 ## Export SBOM {switcher-key="English"}

diff --git a/Writerside/topics/FAQ.md b/Writerside/topics/FAQ.md
@@ -6,10 +6,10 @@ switcher-label: Language
 
 ## 자주 묻는 질문 {switcher-key="한국어"}
 
-이 페이지에서는 시작하기 위한 팁과 요령을 제공합니다. 구독 및 가격, GitHub 리포지토리의 분석 범위, 웹 취약점 분석 옵션 등에 대해 자세히 알아보세요.
+이 페이지에서는 시작하기 위한 팁과 요령을 제공합니다. 구독 및 가격, GitHub 리포지토리의 분석 범위, 웹취약점 분석 옵션 등에 대해 자세히 알아보세요.
 
 
 ## Frequently Asked Questions {switcher-key="English"}
 
-This page provides tips and tricks to get you started. Learn more about subscriptions and pricing, analysis coverage of GitHub repositories, web vulnerability analysis options, and more.
+This page provides tips and tricks to get you started. Learn more about subscriptions and pricing, analysis coverage of GitHub repositories, web app analysis options, and more.
 
diff --git a/Writerside/topics/GitHub.md b/Writerside/topics/GitHub.md
@@ -6,7 +6,7 @@ switcher-label: Language
 
 ## GitHub 저장소 연결 {switcher-key="한국어"}
 
-Sparrow Cloud는 GitHub 저장소에 연동하고, 업로드된 파일을 가져와서 소스코드 및 컴포넌트 분석에 사용합니다. 앞서 가이드에서 설명한 것처럼 이 분석을 수행하기 위해서는 필수적으로 GitHub 계정을 만들고 인증해야 합니다.
+Sparrow Cloud는 GitHub 저장소에 연동하고, 업로드된 파일을 가져와서 소스코드 및 오픈소스 분석에 사용합니다. 앞서 가이드에서 설명한 것처럼 이 분석을 수행하기 위해서는 필수적으로 GitHub 계정을 만들고 인증해야 합니다.
 사용자가 어떤 요금제를 사용하는지에 따라 GitHub 저장소 중에서 Sparrow Cloud에 연결할 수 있는 저장소가 다르다는 점에 유의해주세요. 또한 다음과 같이 GitHub App을 설치한 위치에 따라 사용할 수 있는 저장소가 다릅니다.
 
 
@@ -39,7 +39,7 @@ GitHub 계정으로 Sparrow Cloud에 등록하거나 분석할 GitHub 리포지
 
 ## Connecting GitHub repository {switcher-key="English"}
 
-Sparrow Cloud connects to your GitHub repository, pulls in uploaded files, and uses them for source code and supply chain analysis. As mentioned in the previous guide, it is mandatory to create and authenticate a GitHub account to perform this analysis.
+Sparrow Cloud connects to your GitHub repository, pulls in uploaded files, and uses them for source code and open source analysis. As mentioned in the previous guide, it is mandatory to create and authenticate a GitHub account to perform this analysis.
 Please note that not all GitHub repositories are available to connect to Sparrow Cloud, depending on which plan you are on, and also depending on where you have installed the GitHub app, as follows
 
 

diff --git a/Writerside/topics/Issue.md b/Writerside/topics/Issue.md
@@ -9,15 +9,15 @@ switcher-label: Language
 
 ### 이슈 유형 
 
-이슈는 해당 이슈를 검출한 분석 엔진에 따라서 **소스코드 이슈**, **컴포넌트 이슈**, **웹 취약점 이슈**로 나눌 수 있습니다.
+이슈는 해당 이슈를 검출한 분석 엔진에 따라서 **소스코드 이슈**, **오픈소스 이슈**, **웹취약점 이슈**로 나눌 수 있습니다.
 
 - 소스코드 이슈: 소스코드 분석을 통해 검출된 이슈입니다.
   - 보안 취약점: 소스코드에 잠재된 취약점 중 소프트웨어 보안과 관련된 문제입니다.
   - 품질 문제: 소스코드에 보안 문제를 발생시키지 않지만 품질 측면에서 검토해야 하는 문제입니다.
-- 컴포넌트 이슈: 컴포넌트 분석을 통해 검출된 이슈입니다.
-  - 취약한 컴포넌트: 컴포넌트 자체에서 취약점이 발견되었기 때문에 취약하다고 판단되는 문제입니다.
-  - 라이선스: 컴포넌트에서 사용하는 오픈소스 라이선스 중에서 카피레프트 라이선스 혹은 허용적 라이선스가 포함된 문제입니다.
-- 웹 취약점 이슈: 웹 취약점 분석을 통해 검출된 이슈입니다.
+- 오픈소스 이슈: 오픈소스 분석을 통해 검출된 이슈입니다.
+  - 취약한 컴포넌트: 오픈소스 컴포넌트 자체에서 취약점이 발견되었기 때문에 취약하다고 판단되는 문제입니다.
+  - 라이선스: 컴포넌트에서 사용하는 오픈소스 라이선스가 포함된 문제입니다.
+- 웹취약점 이슈: 웹취약점 분석을 통해 검출된 이슈입니다.
 
 
 ### 이슈 위험도 
@@ -48,15 +48,15 @@ Sparrow Cloud는 프로젝트에서 검출된 최근 이슈를 위험한 정도
 
 ### Issue type
 
-Issues can be categorised as Source Issues, Supply Chain Issues, or Web Vulnerability Issues, depending on the analysis engine that detected the issue.
+Issues can be categorised as Source Issues, Open Source Issues, or Web Vulnerability Issues, depending on the analysis engine that detected the issue.
 
 - Source issues: Issues detected through source code analysis.
   - Security vulnerability: A potential vulnerability in the source code that is related to software security.
   - Quality issues: Issues that do not cause security issues in the source code, but should be reviewed from a quality perspective.
-- Supply Chain issues: Issues detected through supply chain analysis.
-  - Vulnerable component: An issue that is considered vulnerable because a vulnerability has been found in the component itself.
-  - Licence: Issues where the open source licence used by the component contains a copyleft or permissive licence.
-- Web vulnerability issues: Issues detected through web vulnerability analysis.
+- Open Source issues: Issues detected through open source analysis.
+  - Vulnerable component: An issue that is considered vulnerable because a vulnerability has been found in the open source component itself.
+  - Licence: Issues from the open source licence used by the component.
+- Web vulnerability issues: Issues detected through web app analysis.
 
 
 ### Issue risk 

diff --git a/Writerside/topics/Register.md b/Writerside/topics/Register.md
@@ -15,7 +15,7 @@ Sparrow Cloud 서비스를 사용하려면 사용자 계정을 등록해야 합
 <img src="로그인.png" alt="Alt text" width="450"/>
 
 2. 이메일로 계정을 생성하려면 **가입하기** 버튼을 클릭하세요. GitHub 계정을 사용하려면 **GitHub 계정으로 로그인** 버튼을 클릭하세요.
-> **Tip**: Sparrow Cloud에서는 소스코드 또는 컴포넌트 분석을 수행하기 위해서 GitHub 저장소를 사용하실 사용자는 계정을 생성하실 때 GitHub 계정을 인증하시는 것을 권장합니다. 
+> **Tip**: Sparrow Cloud에서는 소스코드 또는 오픈소스 분석을 수행하기 위해서 GitHub 저장소를 사용하실 사용자는 계정을 생성하실 때 GitHub 계정을 인증하시는 것을 권장합니다. 
 
 
 ### 이메일로 등록하기
@@ -70,7 +70,7 @@ To use the Sparrow Cloud service, you need to register a user account. Users can
 <img src="로그인.png" alt="Alt text" width="450"/>.
 
 2. Click the **Sign-up** button to create an account with your email. To use your GitHub account, click the **Sign in with GitHub account** button.
-> **Tip**: Sparrow Cloud recommends that users who will be using GitHub repositories to perform source code or supply chain analysis verify their GitHub account when creating an account.
+> **Tip**: Sparrow Cloud recommends that users who will be using GitHub repositories to perform source code or open source analysis verify their GitHub account when creating an account.
 
 
 ### Register with email