2502.1 pC updates

sparrow-cloud · Feb 17, 2025 · 9180d11 · 9180d11
1 parent 7c42b64
commit 9180d11
Show file tree

Hide file tree

Showing 27 changed files with 92 additions and 18 deletions.
diff --git a/Writerside/hi.tree b/Writerside/hi.tree
@@ -27,6 +27,7 @@
     </toc-element>
     <toc-element topic="FAQ.md">
         <toc-element topic="Subscription.md"/>
+        <toc-element topic="Help.md"/>
         <toc-element topic="Change-Password.md"/>
         <toc-element topic="GitHubFAQ.md"/>
     </toc-element>

diff --git a/Writerside/images/addProj.png b/Writerside/images/addProj.png
diff --git a/Writerside/images/analysisDetails.png b/Writerside/images/analysisDetails.png
diff --git a/Writerside/images/demoProj.png b/Writerside/images/demoProj.png
diff --git a/Writerside/images/help.png b/Writerside/images/help.png
diff --git a/Writerside/images/myAccount.png b/Writerside/images/myAccount.png
diff --git a/Writerside/images/projList00.png b/Writerside/images/projList00.png
diff --git a/Writerside/images/projdetails00.png b/Writerside/images/projdetails00.png
diff --git a/Writerside/images/projdetails01.png b/Writerside/images/projdetails01.png
diff --git a/Writerside/images/reference.png b/Writerside/images/reference.png
diff --git a/Writerside/images/report.png b/Writerside/images/report.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/images/레퍼런스.png b/Writerside/images/레퍼런스.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/images/프로젝트목록00.png b/Writerside/images/프로젝트목록00.png
diff --git a/Writerside/images/프로젝트상세.png b/Writerside/images/프로젝트상세.png
diff --git a/Writerside/images/프로젝트상세01.png b/Writerside/images/프로젝트상세01.png
diff --git a/Writerside/images/프로젝트추가.png b/Writerside/images/프로젝트추가.png
diff --git a/Writerside/topics/Analysis-Report.md b/Writerside/topics/Analysis-Report.md
@@ -17,7 +17,7 @@ Sparrow Cloud에서는 PDF 형식의 분석 보고서를 제공합니다. 프로
 5. 출력할 보고서의 **파일 이름**을 입력하세요.
 6. **내보내기** 버튼을 클릭하세요.
 
-> **Tip**: 완료된 분석의 보고서만 출력할 수 있습니다. 분석 보고서 파일이 너무 큰 경우 여러 개의 파일로 나뉘어서 출력됩니다.
+> **Tip**: 완료된 분석의 보고서만 출력할 수 있습니다. 분석 보고서 파일이 너무 큰 경우 여러 개의 파일로 나뉘어서 출력됩니다. 보고서 파일 샘플을 확인하시려면 <a href="https://raw.githubusercontent.com/sparrow-cloud/cloud/925d2e7e4e64b7a43b74ccfd9147a04666348492/report-examples/file-report.pdf">파일 분석 보고서</a> 또는 <a href="https://raw.githubusercontent.com/sparrow-cloud/cloud/925d2e7e4e64b7a43b74ccfd9147a04666348492/report-examples/web-report.pdf">URL 분석 보고서</a>를 참고하세요.
 
 보고서에는 다음과 같은 내용이 포함됩니다.
 
@@ -30,6 +30,8 @@ Sparrow Cloud에서는 PDF 형식의 분석 보고서를 제공합니다. 프로
 
 <img src="보고서.png" />
 
+
+
 ## Export Report {switcher-key="English"}
 
 Sparrow Cloud provides reports on the analysis in PDF format. Export the report of recent analysis from **Export** dropdown button in the Project or export the report of a certain analysis in the following way:
@@ -44,7 +46,8 @@ Sparrow Cloud provides reports on the analysis in PDF format. Export the report
 5. Enter a filename for the report you want to print out.
 6. Click the **Export** button.
 
-> **Tip**: You can print out the report from completed analyses only. If the analysis report file is too large, it will be split into multiple files.
+> **Tip**: You can print out the report from completed analyses only. If the analysis report file is too large, it will be split into multiple files. For the report sample, click <a href="https://raw.githubusercontent.com/sparrow-cloud/cloud/925d2e7e4e64b7a43b74ccfd9147a04666348492/report-examples/file-report-en.pdf">Analyzed file report</a> or <a href="https://raw.githubusercontent.com/sparrow-cloud/cloud/925d2e7e4e64b7a43b74ccfd9147a04666348492/report-examples/web-report-en.pdf">Analyzed URL Report</a>.
+
 
 
 The report contains the following content:

diff --git a/Writerside/topics/Analysis-Results.md b/Writerside/topics/Analysis-Results.md
@@ -5,14 +5,34 @@ switcher-label: Language
 
 ## 결과 확인하기 {switcher-key="한국어"}
 
+### 최근 분석
+
 프로젝트에서 확인할 수 있는 결과는 **최근 분석**에서 발견한 내용이 포함됩니다. 여기서 **최근 분석**이란 다음 두 가지를 포함합니다: 1) 리포지토리 및 압축 파일을 비롯한 **파일** 자산을 대상으로 수행한 마지막 분석, 2) 웹 페이지를 가리키는 **URL** 자산을 대상으로 수행한 마지막 분석. 즉, 최근 분석에는 최대 2개의 분석 결과가 함께 표시될 수 있습니다.
 
-> **Tip**: **최근 분석** 이전에 수행한 분석 결과의 내용을 확인할 수 없다는 점에 주의하세요.
+> **Tip**: **최근 분석** 이전에 수행한 분석 결과의 내용을 확인하려면 최근 분석을 삭제하세요. 분석을 삭제하려면 [분석 상세 정보](#분석-상세-정보)를 참고하세요.
 
 프로젝트의 오른쪽에 있는 **요약**, **레퍼런스**, **이슈**, **자산**, **컴포넌트**라는 다섯 개의 탭을 클릭해서 상세한 결과를 확인하세요.
 
 <img src="프로젝트상세01.png" />
 
+### 분석 상세 정보 
+
+**분석 목록**에서 프로젝트에서 수행한 분석에 대한 전반적인 데이터를 확인할 수 있습니다. 여기에는 분석의 **진행 상황**, **분석 시간**, **분석 시작 일시**, **분석 대상**, **위험도별 이슈 수** 등이 포함됩니다.
+
+<img src="분석상세.png" />
+
+
+#### 분석 데이터가 표시되지 않는 경우
+
+분석이 실패하는 경우 프로젝트 요약에는 분석 결과가 표시되지 않게 됩니다. 이 때 **분석 상세 정보**를 보면 분석이 실패했으며 실패의 원인이 무엇인지를 확인하실 수 있습니다.
+
+> **Tip**: 분석이 완료된 경우임에도 프로젝트 요약에 분석 결과가 표시되지 않았다면 **분석 상세 정보**에서 **위험도별 이슈 수**가 0이 아닌지를 확인하세요.
+
+#### 과거 분석 데이터를 확인하려는 경우
+
+앞서 설명한 것처럼 프로젝트 요약에는 [**최근 분석**](#최근-분석)만 표시됩니다. 만약 사용자가 프로젝트에서 수행한 다른 분석 결과를 확인하려는 경우 해당 분석 이후에 수행된 모든 분석을 삭제하는 방식으로 과거의 분석 결과를 확인하실 수 있습니다.
+
+> **Warning**: 일단 삭제된 데이터는 다시 복구할 수 없다는 점에 유의하세요.
 
 
 ### 레퍼런스
@@ -44,15 +64,37 @@ Sparrow Cloud는 **자산**이라는 분석 결과를 표시합니다. 자산은
 
 ## Analysis results {switcher-key="English"}
 
+### Recent Analyses
+
 The results you can see in your project include the findings from your **recent analyses**. In this context, "recent analyses" includes two things 1) the last analysis performed on **file** assets, including repositories and compressed files, and 2) the last analysis performed on **URL** assets, which point to web pages. This means that up to two analyses can be shown together in Recent Analyses.
 
-> **Tip**: Note that you can't see the results of analyses performed before **Recent Analyses**.
+> **Tip**: Note that if you check analyse results before **Recent Analyses**, delete **Recent Analyses**. See [Analysis details](#analysis-details) for more information.
 
 To see detailed results, click the five tabs on the right side of the project: **Summary**, **Reference**, **Issue**, **Asset**, and **Component**.
 
 <img src="projdetails01.png" />
 
 
+### Analysis details
+
+**Analysis List** shows more data from the analysis conducted in the project: including **Status**, **Analyzing time**, **Started time**, **Analyzing target**, **Risk level and issues** and etc.
+
+<img src="analysisDetails.png" />
+
+
+#### Cannot check results in Project summary.
+
+When the analysis fails, no results have shown in the Project summary. Then, go to the **Analysis details** to check that the analysis fails and what makes it fails as well.
+
+> **Tip**: For a completed analysis, and it does not show any results, check that **Risk level and issues** shows zero in the **Analysis details**.
+
+#### Want to view results from the previous analysis.
+
+As mentioned earlier, Project summary only shows data about [**Recent analyses**](#Recent-Analyses). If you want to check previous analysis results from the project, you can see the results by deleting all subsequent analyses performed after that analysis.
+
+> **Warning**: Note that the deleted data cannot be restored.
+
+
 ### References
 
 **References** show references and reference chapters, and presents the related number of issues detected on the recent analysis.

diff --git a/Writerside/topics/Change-Password.md b/Writerside/topics/Change-Password.md
@@ -10,7 +10,7 @@ switcher-label: Language
 2. **내 계정**을 선택하세요.
 3. **선택 입력 항목 보기**를 클릭하세요
 
-<img src="내계정_정보.png" alt="Alt text"/>
+   <img src="내계정_정보.png" />
 
 4. **현재 비밀번호**, 새로운 **비밀번호**와 **비밀번호 확인**을 입력하세요.
 5. 슬라이드 아래에서 **변경하기** 버튼을 클릭하세요.
@@ -21,7 +21,7 @@ switcher-label: Language
 2. Select **My Account**. 
 3. Click on **Show Options**.
 
-<img src="myaccount_info.png" alt="Alt text"/>
+   <img src="myaccount_info.png" />
 
 4. Enter your current **Password**, new **Password** and **Confirm Password**. 
 5. Click **Modify** button at the bottom of the slide.

diff --git a/Writerside/topics/Create-Project.md b/Writerside/topics/Create-Project.md
@@ -20,7 +20,9 @@ switcher-label: Language
 3. **프로젝트 이름**을 입력하세요. 
 4. **추가하기** 버튼을 클릭하면 프로젝트가 생성됩니다.
 
-분석을 시작하려면 생성한 프로젝트로 이동하세요. 자세한 내용은 [분석하기](Run-Analysis.md)에서 확인하실 수 있습니다.
+ > **Tip**: **데포 프로젝트로 추가합니다.**를 선택하면 추가되는 프로젝트에서 분석 결과 샘플을 확인하실 수 있습니다.
+
+분석을 시작하려면 생성한 프로젝트로 이동하세요. 자세한 내용은 [분석하기](Run-Analysis.md)를 참고하세요.
 
 ## Create Project {switcher-key="English"}
 
@@ -37,4 +39,6 @@ Create a project before performing any analysis. You can create a project by ent
 3. Enter a name for your project.
 4. Click the **Add** button to create the project.
 
+ > **Tip**: Select a checkbox for **Add as a sample project.**, and sample data will be added to the project.
+
 To start analysing, go to the project you created. For more information, see [Run Analysis](Run-Analysis.md).
diff --git a/Writerside/topics/Help.md b/Writerside/topics/Help.md
@@ -0,0 +1,22 @@
+---
+switcher-label: Language
+---
+# Guide & Help
+
+
+## 가이드 및 도움말 {switcher-key="한국어"}
+
+오른쪽 위에 있는 **사용 가이드** 아이콘을 클릭해서 사용 방법을 확인하실 수 있습니다.
+
+추가로 도움이 필요한 경우 오른쪽 위에 있는 **도움말** 아이콘을 클릭하세요. 여기에서 **공지사항**, **자주 묻는 질문**, **문의하기**를 통해 **스패로우 고객센터**에 연락할 수 있습니다.
+
+   <img src="도움말.png" />
+
+
+## Guide & Help {switcher-key="English"}
+
+Click **User Guide** icon to check how to use Sparrow Cloud.
+
+If you need more help, click **Help** icon. Here you can check **Notice** or **FAQ**, and **contact** to **Sparrow CS**.
+
+   <img src="help.png" />
diff --git a/Writerside/topics/Run-Analysis.md b/Writerside/topics/Run-Analysis.md
@@ -36,6 +36,7 @@ Sparrow Cloud에 등록한 이메일과 동일한 이메일의 GitHub 저장소
 
 웹 사이트 URL을 분석하는 방법은 [분석 대상 웹 페이지 설정하기](#analysissetting.md#분석-대상-웹-페이지-설정하기)를 참고하세요. 서비스를 구독하지 않은 사용자는 일부 웹취약점 분석 옵션을 사용할 수 없습니다.
 
+> **Warning**: 패스워드를 입력하는 로그인 이외의 추가적인 인증이 필요한 웹 사이트의 경우 분석을 수행할 수 없습니다.
 
 #### 이벤트 클립보드 
 
@@ -109,6 +110,9 @@ You can compress an SBOM file that has already been generated, and then run the
 
 See [Setting up web page](analysisSetting.md#setting-up-web-page) for specifying a web page URL to run analysis. Users who do not subscribe the Sparrow Cloud service cannot modify some items of web app analysis options.
 
+> **Warning**: For web-sites that require additional authentication beyond password log-in, analysis cannot be properly completed.
+
+
 #### Event Clipboard 
 
 The **Event Clipboard** is basically a tool that allows you to record and save events performed on a web page. You can use this feature to expand the scope of your analysis by saving the events performed by the user to a file and entering it into the [Analysis option](Analysis-Option.md). If the URL you are analysing requires you to log in with a specific ID and password, you can save the event from the **Event Clipboard** to a file and upload it to the **Login History File** in **Analysis Options**, and the information stored in the file will be used for analysis.
@@ -139,10 +143,10 @@ Now that you've installed the Event Clipboard, let's run it.
 Let's use the **Login History File** we recorded above to perform an analysis.
 
 1. Click **Modify project** button and click the **Set web page** button.
-2. Click **Search File** button in **Sign-in Log File** option.
+2. Click **Search File** button in **Login History File** option.
 3. Select the saved event clipboard file.
 4. Click **Set** button in the Web page settings.
 5. Click **Modify** button under **Modify Project**.
 
-> **Tip**: When recording login behaviour from the event clipboard, make sure to start recording from the redirected page. Also, to prevent clicking the logout button after login, add the logout button to the **Element to Unload** in the web page options.
+> **Tip**: When recording login id and password on the event clipboard, make sure to start recording from the redirected page. Also, to prevent clicking the logout button after login, add the logout button to the **Element to Unload** in the web page options.
  
diff --git a/Writerside/topics/Subscription-List.md b/Writerside/topics/Subscription-List.md
@@ -8,12 +8,11 @@ switcher-label: Language
 
 Sparrow Cloud에 등록한 사용자는 매월 최대 1000개의 **소스코드 분석**, 1000개의 **오픈소스 분석**, 100개의 **웹취약점 분석**을 수행할 수 있습니다. 분석 횟수는 기본적으로 매월 1일마다 다시 초기화됩니다. 사용자는 구독 목록에서 몇 개의 분석을 수행할 수 있는지를 확인할 수 있습니다.
 
-1. 오른쪽 위에 있는 **사용자 이름**을 클릭하세요.
-2. **구독 관리**를 선택하세요.
+1. 오른쪽 위에 있는 **구독 관리** 아이콘을 클릭하세요.
 
-<img src="내계정_구독00.png" />
+   <img src="내계정_구독00.png" />
 
-3. 구독 목록의 위쪽에서 분석을 수행할 수 있는 횟수를 확인하세요.
+2. 구독 목록의 위쪽에서 분석을 수행할 수 있는 횟수를 확인하세요.
 
 > **Tip**: 파일 형식 분석의 경우 소스코드 분석과 오픈소스 분석을 동시에 수행하기 때문에 두 가지 분석의 분석 가능 횟수가 줄어들게 됩니다.
 
@@ -36,12 +35,11 @@ Sparrow Cloud에 등록한 사용자는 매월 최대 1000개의 **소스코드
 
 Users registered with Sparrow Cloud can run up to 1000 **Code Analyses**, 1000 **Open Source Analyses**, and 100 **Web App Analyses** per month. The number of analyses resets by default on the 1st of every month. Users can see how many analyses they can perform in their subscription list.
 
-1. click on their **username** in the top right corner.
-2. Select **Manage Subscriptions**.
+1. Click **Manage Subscription** icon in the top right.
 
-<img src="myaccount_sub00.png" />
-
-3. Check the top of the subscription list to see how many times you can run the analyses.
+   <img src="myaccount_sub00.png" />
+ 
+2. Check the top of the subscription list to see how many times you can run the analyses.
 
 > **Tip**: For file type analysis, the number of analyses available for both code and open source analysis will be reduced because the Sparrow Cloud performs both analyses at the same time.