이 페이지는 Cloud Translation API를 통해 번역되었습니다.

AboutCode 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:: AboutCode
기술 문서 작성자:: ayansinha
프로젝트 이름:: Scancode- Toolkit의 명령줄 옵션에 관한 참조 및 aboutcode.readthedocs.io에서 AboutCode 문서 구조 재구성
프로젝트 길이:: 표준 기간 (3개월)

Project description

[ 1. Scancode-Toolkit 명령줄 옵션 ]

Scancode-Toolkit에는 스캔 실행 방식, 출력 형식, 스캔 후 플러그인과 같은 기타 여러 옵션을 맞춤설정하는 명령줄 옵션이 많이 있습니다. 현재 이러한 옵션을 설명하는 적절한 문서가 없으며 '--help' 또는 '-h' 플래그를 통해서만 사용할 수 있습니다. 이 프로젝트의 목표는 다음을 설명하는 완벽한 문서를 만드는 것입니다.

[ 1. 명령줄을 통해 사용할 수 있는 모든 옵션 ]

목표: 명령줄을 통해 가능한 모든 옵션의 전체 목록
기본 개요: 먼저 출력 예시와 함께 기본 스캔 옵션이 설명됩니다. 검사 수행 방식에 대한 간단한 그래픽/설명
이후 이 기본 동작은 다른 옵션이 검사 및 출력을 변경하는 방식을 참조하는 역할을 합니다.
이러한 내용은 다음 섹션에서 자세히 설명하며 다음과 같은 정보를 포함합니다.

[ 2. 버전 관리 구조 시작 ]

목표: 교차 출시 옵션/API 및 문서 변경사항을 적절하게 유지하기 위한 버전 관리 시스템을 시작합니다.
문제: 현재 위키 문서와 ReadTheDocs 페이지는 이전 출시 버전에 관한 것이며 대대적인 재구성이 필요합니다.
기본 개요: 스캔 코드 툴킷에서 업데이트되었거나 업데이트될 수 있는 부분은
명령줄 옵션
API
문서 (시작 예정) 버전 및 출시에서 명령줄 옵션과 API가 변경되므로 문서도 따라야 합니다. 그러지 않으면 사용자에게 큰 혼란을 야기할 수 있습니다. 명령줄 유틸리티[ --help ] 는 옵션의 변경사항에 맞게 이미 업데이트되었으며 문서에서 버전 관리를 복제하는 데 사용할 수 있습니다.

[ 3. 다양한 경우에 이러한 옵션을 사용하는 방법 ]

목표: 이 섹션에서는 scancode-toolkit의 스캔 결과를 다양한 원인에 사용할 수 있는 방법과 이러한 기능을 제공하는 Scancode-Toolkit 옵션에 관한 기본 요약을 제공합니다.
기본 개요: 이 섹션에서는 다양한 사용 사례 시나리오 예시와 이러한 시나리오에 권장되는 옵션을 제공합니다.
참고: 이 부분에서는 Scancode-Toolkit의 다양한 사용 사례에 관한 입력과 포인터에 관해 멘토의 많은 도움이 필요합니다.

[ 4. 스캔 및 출력에서 이러한 옵션이 변경되는 사항 ]

목표: 이 섹션에서는 scancode-toolkit의 스캔 결과를 다양한 원인에 사용할 수 있는 방법과 이러한 기능을 제공하는 Aboutcode 도구에 관한 기본 요약을 제공합니다.
기본 개요: 옵션에 따라 스캔이 실행되는 방식의 동작이 변경됩니다. 기본 기본 케이스는 [ 1. 모든 옵션 ] 을 보고 이 섹션에서는 기본 시나리오에 모든 옵션이 가져오는 변경사항을 비교합니다.

[ 5. 화면출력 형식 및 예시 ]

목표: 이 섹션에서는 다양한 원인에서 스캔 코드 툴킷의 검사 결과를 사용할 수 있는 방법과 이러한 기능을 제공하는 코드 정보 도구에 대한 기본 요약을 제공합니다.
기본 개요: Scancode-Tool에는 스캔 결과가 생성될 다양한 출력 형식을 지정하는 플래그가 있습니다. 다음과 같습니다.
이 부분은
출력 형식에 대해 자세히 설명
출력 형식에 대한 예시 제공
출력 형식과 그 용도에 해당하는 다른 링크를 제공합니다.
스캔 결과가 출력 파일에 저장되는 방식 이는 다양한 형식이 생성되는 방식과도 연결되어 있으며, 이에 대해서는 [ 2. 코드 스캔을 설명하는 토론 ].

[ 6. 스캔코드 출력 형식의 비즈니스 사용 ]

목표: 스캔코드 출력 형식의 비즈니스 사용 사례 설명. GSoD 아이디어 목록에서 스캔코드 출력 형식이 참조 아이디어로 언급됩니다. 이 섹션에서는 동일한 작업을 구현합니다.
참고: 이 부분에서는 Scancode-Toolkit의 다양한 비즈니스 사용 사례에 대한 입력과 포인터에 관해 멘토의 상당한 도움이 필요합니다.

[ 7. 이러한 출력이 다른 AboutCode 프로젝트에서 추가 분석을 위해 사용되는 방식 ]

목표: 이 섹션에서는 scancode-toolkit의 스캔 결과를 다양한 원인에 사용할 수 있는 방법과 이러한 기능을 제공하는 Aboutcode 도구에 관한 기본 요약을 제공합니다.
기본 개요:
Scancode-Workbench 이 부분에서는 데스크톱 앱으로 결과를 시각화하는 방법을 설명하고, 추가 지원을 위해 스캔 코드 Workbench 문서를 가리키는 포인터를 설명합니다. 필요한 경우 스캔 코드 워크벤치에 필요한 문서를 추가합니다.
델타코드 델타코드에서 스캔 코드 결과를 사용하여 두 코드베이스 간의 파일 수준 차이를 결정하는 방법입니다.

[ 2. AboutCode 문서의 구조를 재구성합니다. ]

이 부분에는 Aboutcode 문서에 대한 여러 변경사항이 포함되어 있습니다.

[ 1. 버전 관리 시스템 ]

In [ 1. Scancode-Toolkit 명령줄 옵션 -> 2. 시작 버전 관리 구조] 명령줄 옵션의 버전 관리 문제를 언급했습니다. 혼란을 야기할 수 있는 버전별 명령어/정보가 포함된 문서의 다른 부분에도 동일하게 적용됩니다.

[ 2. 설정 문서 표준 및 테스트 ]

문서에는 이미 Travis-CI를 통한 지속적 통합으로 spinx-build (모든 페이지를 빌드하고 전체적으로 Sphinx 문법 오류를 확인) 및 링크 검사 (문서의 다른 웹페이지로 연결되는 모든 링크를 확인) 테스트가 있습니다. (이 pull 요청 #17에서 내가 추가함) 이제 재구성된 텍스트 및 기타 표준의 특정 린트에 관해 더 많은 검사가 필요합니다. 이는 restructuredtext-lint로 실행할 수 있지만 더 많은 연구가 필요하며 GSoD 프로젝트의 일환으로 진행될 예정입니다.

[ 3. '시작하기' 섹션 추가 ]

이 섹션은 초보자를 위한 시작 섹션 역할을 하며 Aboutcode 프로젝트를 시작하는 데 필요한 가장 기본적이고 중요한 문서로 구성되어 있습니다. 모든 Aboutcode 프로젝트에는 Scancode-Toolkit, Scancode-Workbench, Deltacode 등을 포함한 이 섹션이 있습니다.

[ 4. 4가지 문서 기능에 따라 재구성 ]

기존 문서는 4가지 문서 기능(튜토리얼, 방법, 참조, 설명)으로 명시적으로 구성되어 있지 않습니다. 필요한 경우 추가 정보/설명/포인터를 추가하여 적절하게 구성하는 것이 좋습니다. 이는 모든 AboutCode 프로젝트와 문서에 적용됩니다. 다음은 제가 제안하고 이 프로젝트에서 계속 진행하고자 하는 Scancode-Toolkit 문서 재구성의 두 가지 예입니다. 나머지 문서에도 유사한 변경사항이 적용됩니다.

[ 5. 개발 페이지 재구성 (Scancode-Toolkit) ]

개발자 친화성을 높이기 위해 Code/API에 관한 자세한 정보를 추가할 수 있습니다. [ 2. 위의 코드 검사 섹션을 설명하는 토론 이렇게 하면 스캔이 작동하는 방식에 대한 설명이 스캔을 실행하는 데 사용되는 코드에 연결됩니다. 이러한 폴더에는 scancode-toolkit의 여러 부분이 포함되어 있으므로 scancode의 작동 방식에 관한 토론과 함께 API를 사용하여 개별 사용을 자세히 설명할 수 있습니다.

[commoncode : 도우미 클래스 및 함수]
[ extractcode : 다양한 보관 파일 형식 추출 ]
[ formattedcode : 다양한 출력 파일 형식의 출력 형식 지정 ]
[ licensedcode : licence detection code ]
[ packagedcode : 다양한 패키지 형식 파싱 ]
[ plugincode : 플러그인 아키텍처 클래스 ]
[ 요약 코드 : 감지된 라이선스에 대한 스캔 요약 ]
[ textcode : 텍스트 파싱 처리 ]
[ typecode : 파일 형식 결정을 처리합니다. ]
[ scancode : 핵심 부분인 scancode에 관한 CLI 및 API ]

이 하위 섹션에는 하위 섹션에 scancode-toolkit의 이러한 부분에 관한 세부정보/API가 포함됩니다. 개발 가이드라인은 다른 페이지 또는 하위 섹션이 더 작은 다른 섹션에 있습니다.

[ 6. FAQ 페이지 재구성 (Scancode-Toolkit) ]

현재 FAQ 페이지에는 더 나은 답변을 제공할 수 있고 별도의 방법, 튜토리얼, 참조 문서로 구성해야 하는 질문이 있습니다.

ScanCode는 어떻게 작동하나요? 이 문제는 [ 2. 코드 스캔에 대해 설명하는 토론 ] 에 대해 알아보고 더 자세히 알아보도록 하겠습니다.
향상된 감지를 위한 새 라이선스 규칙을 추가하는 방법 이 문제는 기존 방법 개선에서 이미 논의되었으며 문서는 해당 섹션으로 이동됩니다.
새 라이선스 감지 규칙을 추가하는 방법 이 내용은 별도의 '방법' 게시물로 작성하고 자세히 설명할 수 있습니다.
개발을 시작하려면 어떻게 해야 하나요? 이미 별도의 개발 페이지가 있으며 정보가 상당히 겹칩니다. 개발 페이지의 재구성은 이미 위에 설명되었습니다.
새 버전을 자르는 단계 이 내용은 별도의 '새 버전을 자르는 방법'으로 변환할 수 있습니다.
프로젝트에 관한 일반적인 질문에 답변하고 '방법'/'튜토리얼' 카테고리에 속하지 않는 FAQ 질문을 더 찾아보세요.