content

ReadMe Guide : Github Webhooks로 생태계를 업데이트합니다

이 안내서는 GitHub WebHooks를 사용하여 전체 텍스트 검색 색인에서 컨텐츠 업데이트를 자동화하고 JavaScript의 렌더링 마크 다운 파일을 사용하여 컨텐츠 허브, 컨텐츠 허브 내에서 업데이트를 관리하는 프로세스를 간략하게 설명합니다.

개요

/LEAR 생태계 내의 각 폴더는 페이지 또는 섹션을 나타냅니다. 이 폴더에는 페이지의 내용을 구성하는 마크 다운 파일 (.md)이 포함되어 있습니다. 이 Markdown 파일을 변경하면 GitHub 트리거가 활성화되어 업데이트 된 파일을 사전 정의 된 Webhook로 전송합니다. 이 webhook은 전체 텍스트 검색 인덱스에서 컨텐츠를 업데이트합니다. 마지막으로 업데이트 된 Markdown 컨텐츠는 웹 사이트의 JavaScript로 렌더링됩니다.

전제 조건

• 폴더에 마크 다운 컨텐츠가있는 Github 저장소.
• 웹 서버 또는 호스팅 서비스에 액세스하여 WebHook 리스너를 설정합니다.
• 컨텐츠를 인덱싱하기 위해 전체 텍스트 검색 서비스 (Elasticsearch)가 설정되었습니다.
• 웹에서 마크 다운 파일을 렌더링하기위한 JavaScript의 기본 지식.

1 단계 : 콘텐츠 구성

1. GitHub 저장소 내 폴더에 컨텐츠를 구조화합니다. 여기서 각 폴더는 /학습 생태계의 페이지 또는 섹션을 나타냅니다.
2. 모든 컨텐츠가 Markdown 파일 (.md)로 작성되었으며 목적이나 내용을 반영하도록 올바르게 이름을 지정하십시오.

2 단계 : Github Webhook 설정

1. GitHub 저장소에서 Settings > Webhooks > Add webhook 로 이동하십시오.
2. 페이로드 URL을 입력하십시오. 이 URL은 업데이트가 수신되는 서버의 WebHook 리스너를 가리 려야합니다.
3. application/json 으로 컨텐츠 유형을 선택하십시오.
4. 이 이벤트 가이 웹 후크를 트리거 할 Just the push event 선택하십시오.
5. Active 확인란을 선택하고 Webhook을 만듭니다.

3 단계 : WebHook 리스너 생성

1. 서버에서 GitHub WebHook 설정에 지정된 URL에서 게시물 요청에 대한 스크립트를 작성하십시오.
2. 게시물 요청이 접수되면 JSON 페이로드를 구문 분석하여 업데이트 된 마크 다운 파일을 식별하십시오.
3. 업데이트 된 각 파일에 대해 전체 텍스트 검색 인덱스에서 해당 콘텐츠를 업데이트하십시오.

예제 (의사 코드) :

 app . post ( '/webhook-url' , ( req , res ) => {
  const updatedFiles = req . body . commits . map ( commit => commit . modified ) ;
  updatedFiles . forEach ( file => {
    updateSearchIndex ( file ) ;
  } ) ;
  res . status ( 200 ) . send ( 'Update received' ) ;
} ) ; 

4 단계 : 전체 텍스트 검색 색인 업데이트

1. 업데이트 된 Markdown 파일에서 컨텐츠를 추출하십시오.
2. 전체 텍스트 검색 인덱스에서 컨텐츠를 업데이트하여 검색 가능하고 올바르게 인덱싱되도록하십시오.

5 단계 : JavaScript의 Markdown 렌더링

1. Markdown 컨텐츠를 HTML로 변환하려면 marked.js 와 같은 JavaScript 라이브러리를 사용하십시오.
2. 전체 텍스트 검색 색인에서 또는 필요한 경우 GitHub 저장소에서 직접 업데이트 된 마크 다운 컨텐츠를 가져 오십시오.
3. /학습 생태계 내의 적절한 페이지에서 HTML 컨텐츠를 렌더링하십시오.

예제 (JavaScript) :

 fetch ( 'path/to/markdown.md' )
  . then ( response => response . text ( ) )
  . then ( markdown => {
    const htmlContent = marked ( markdown ) ;
    document . getElementById ( 'content' ) . innerHTML = htmlContent ;
  } ) ; 

결론

이 안내서는 Github Webhooks, 전체 텍스트 검색 색인 및 JavaScript를 사용하여 /LEAR 생태계 내에서 컨텐츠 업데이트를 자동화하는 간소화 된 접근 방식을 제공합니다. 이 단계를 수행하면 콘텐츠가 항상 최신 상태이며 잠재 고객이 쉽게 검색 할 수 있는지 확인할 수 있습니다.