[Suggesetion] jekyll Building Failure at Local

[bnbong]

Azure SDK Korean repository에서 제공해주는 CONTRIBUTING.md 문서의 Full Local Setup 탭에서 제시해주는 방식 대로 Jekyll을 설치한 후 의존성 라이브러리들을 설치하고 난 후 bundle exec jekyll serve 명령어를 바로 수행한다면 다음과 같은 오류가 발생합니다.

Local 환경

• Local Machine: M1 MacOS Ventura version 13.4.1
• Visual Studio Code: version 1.80.1
• Electron: 22.3.14
• Node.js: 16.17.1
• rbenv: rbenv 1.2.0
• ruby: ruby 3.2.2 (2023-03-30 revision e51014f9c0) [arm64-darwin22]

상단의 이슈는 의존성 라이브러리 중에서 webrick이라는 라이브러리를 발견하지 못했기 때문에 발생하는 오류임을 확인했습니다.
따라서 위의 이슈를 해결하기 위해서 다음과 같은 작업을 추가로 수행했습니다.

1. Webrick 설치

먼저, 로컬 머신에 webrick 라이브러리를 설치했습니다.

gem install webrick

2. 프로젝트 의존성 파일에 webrick 추가.
   다음 명령어를 통해 프로젝트 의존성 파일(Gemfile, Gemfile.lock)에 webrick 라이브러리를 추가했습니다.

bundle add webrick

3. 설치 완료 후 로컬에서 jekyll 빌드 실행.
   다음 명렁어를 통해 jekyll 프로젝트를 빌드해보면 로컬에서 정상적으로 빌드가 되는 것을 확인했습니다.

bundle exec jekyll serve

의존성 추가 전

의존성 추가 후

Suggestion

CONTRIBUTING.md의 Full Local Setup 가이드라인에서는 Ruby 2.6 버전을 설치하라고 명시되어 있습니다.

그러나, Ruby 공식 홈페이지에서는 Ruby 2.7.8이전 버전 부터는 더 이상 유지보수 없음(EOL)로 2.6 버전을 포함한 버전에 대한 유지보수를 진행하지 않는다고 명시되어 있는 상태입니다.

따라서, Azure SDK Korean Contribution 가이드 또한 최신 버전에 맞춰 가이드라인을 업데이트해야할 것 같습니다.

[jeesang7]

EOL 이슈는 있지만 큰 문제는 아니라고 생각해요.
지금도 유지 중인 Azure SDK 에서 버전 올릴때, 그때 진행해도 늦지 않을 것 같습니다

참고로, 저도 별도 루비 설치없이, 맥에 기본 설치된 버전으로 실행해서 사용 중 입니다 😄

➜  azure-sdk-korean git:(main) ✗ ruby -v
ruby 2.6.8p205 (2021-07-07 revision 67951) [universal.x86_64-darwin21]