codeigniter-kr / ci4userguidekr

CodeIgniter4 한국어 사용자 가이드

CodeIgniter 한국어 사용자 가이드

설치지침

CodeIgniter 사용자 가이드는 Sphinx를 사용하여 문서를 관리하고 다양한 형식으로 출력합니다. 소스 파일은 ReStructured Text 포맷으로 작성되었습니다.

설치전 확인

Python

Sphinx는 Python 3.5 이상이 필요하며 OS X 또는 Linux를 사용 중이라면 이미 설치되어 있을 수 있습니다. 터미널 창에서 "python" 또는 "python3"를 실행하여 확인할 수 있습니다.

python --version
Python 2.7.17

python3 --version
Python 3.6.9

# For Windows using the Python Launcher
py -3 --version
Python 3.8.1

3.5 이상이 아니라면 Python.org 에서 최신 3.x 버전을 설치하십시오. Linux 사용자는 운영체제에 내장된 패키지 관리자를 사용하여 업데이트해야 합니다.

pip

이제 Python 3.x가 설치되어 실행 중이므로 pip (Python Package Installer) 를 설치합니다.

pip 또는 pip3 으로 pip가 설치되어 있는지 확인할 수 있습니다. pip는 Python과 동일한 명명 규칙을 따릅니다. 맨 끝에 python 3.x 라고 표시되어 있습니다.

pip --version
pip 9.0.1 from /usr/lib/python2.7/dist-packages (python 2.7)

pip3 --version
pip 9.0.1 from /usr/lib/python3/dist-packages (python 3.6)

# For Windows using the Python Launcher
py -3 -m pip --version
pip 20.0.2 from C:\Users\<username>\AppData\Local\Programs\Python\Python38\lib\site-packages\pip (python 3.8)

Linux

Linux 패키지 관리자를 사용하여 pip/setuptools/wheel 설치

Others

Python.org 에서 다운로드한 Python 3.5 이상을 사용중인 경우 pip가 이미 설치되어 있습니다.

설치방법

이제 우리는 Sphinx와 라이브러리를 설치해야 합니다. 운영 체제에 따라 pip 또는 pip3 를 선택하십시오. 이 단계 후에는 Python이 방금 설치한 다른 애플리케이션을 모두 찾을 수 없으므로 터미널 창을 다시 시작해야 합니다.

pip install -r user_guide_src/requirements.txt

pip3 install -r user_guide_src/requirements.txt

# For Windows using the Python Launcher
py -3 -m pip install -r user_guide_src/requirements.txt

이제 모든것을 정리하고 문서를 생성합니다.

cd user_guide_src
make html

문서 편집 및 작성

사용자 가이드의 모든 소스 파일은 source/ 아래에 있으며 새 문서를 추가하거나 기존 문서를 수정할 수 있습니다.

So where's the HTML?

HTML 문서는 사용자가 사용하는 문서이기 때문에 중요합니다. 빌드 된 파일은 관리할 필요가 없으므로 소스와 함께 관리 하지 않습니다. 작업된 결과를 미리보기 위해 필요에 따라 재생성 할 수 있습니다. HTML 생성은 매우 간단합니다. 사용자 가이드 레파지토리를 복사한 디렉터리로 이동하여 다음 명령을 입력하십오.

make html

렌더링된 사용자 가이드와 이미지는 build/html/ 에서 확인할 수 있습니다. HTML이 빌드 된 후, 각 후속 빌드는 변경된 파일만 다시 빌드하므로 상당한 시간이 절약됩니다. 빌드 파일을 다시 만들고 싶다면 build 폴더의 내용을 삭제하고 다시 빌드하십시오.

Style Guideline

CodeIgniter를 문서화하기 위해 Sphinx를 사용하기 위한 일반적인 지침은 /contributing/documentation.rst를 참조하십시오.

Thanks to 👍

Daeseung Han 📖

Terrorboy 📖

Jongwon Byun 📖

Leejungyoung 📖

ci4userguidekr's Issues

오타

http://ci4doc.cikorea.net/installation/installing_composer.html#codeigniter4 에서

composer require codeigniter4/framework --prefer-sourc

to

composer require codeigniter4/framework --prefer-source

로고

원본

변경

추천하실 아이콘이 있다면 코멘트로 등록 부탁 드립니다.

기여자 보정

const validContributionTypes = [
    'a11y',
    'audio',
    'blog',
    'bug',
    'business',
    'code',
    'content',
    'data',
    'design',
    'doc',
    'eventorganizing',
    'example',
    'financial',
    'fundingfinding',
    'ideas',
    'infra',
    'maintenance',
    'platform',
    'plugin',
    'projectManagement',
    'question',
    'review',
    'security',
    'talk',
    'test',
    'tool',
    'translation',
    'tutorial',
    'usertesting',
    'video',
]

---

id: emoji-key
title: Emoji Key ✨ (and Contribution Types)
sidebar_label: Emoji Key ✨

Table

To have a contribution added when using the Bot or CLI use the keyword in the Type column. The bot will also use basic Natural Language Parsing to determine your contribution intent.

Emoji/Type	Represents	Comments
🔊 audio	Audio	Podcasts, background music or sound effects
♿️ a11y	Accessibility	Reporting or working on accessibility issues
🐛 bug	Bug reports	Links to issues reported by the user on this project
📝 blog	Blogposts	Links to the blogpost
💼 business	Business Development	People who execute on the business end
💻 code	Code	Links to commits by the user on this project
🖋 content	Content	e.g. website copy, blog posts are separate
🔣 data	Data	Links to contributed data for the project (both tests and datasets)
📖 doc	Documentation	Links to commits by the user on this project, Wiki, or other source of documentation
🎨 design	Design	Links to the logo/iconography/visual design/etc.
💡 example	Examples	Links to the examples
📋 eventOrganizing	Event Organizers	Links to event page
💵 financial	Financial Support	People or orgs who provide financial support, links to relevant page
🔍 fundingFinding	Funding/Grant Finders	People who help find financial support
🤔 ideas	Ideas & Planning
🚇 infra	Infrastructure	Hosting, Build-Tools, etc. Links to source file (like travis.yml) in repo, if applicable
🚧 maintenance	Maintenance	People who help in maintaining the repo, links to commits by the user on this project
🧑‍🏫 mentoring	Mentoring	People who mentor new contributors, links to the repo home
📦 platform	Packaging	Porting to support a new platform
🔌 plugin	Plugin/utility libraries	Links to the repo home
📆 projectManagement	Project Management
💬 question	Answering Questions	Answering Questions in Issues, Stack Overflow, Gitter, Slack, etc.
👀 review	Reviewed Pull Requests
🛡️ security	Security	Identify and/or reduce security threats, GDPR, Privacy, etc
🔧 tool	Tools	Links to the repo home
🌍 translation	Translation	Links to the translated content
⚠️ test	Tests	Links to commits by the user on this project
✅ tutorial	Tutorials	Links to the tutorial
📢 talk	Talks	Links to the slides/recording/repo/etc
📓 userTesting	User Testing	Links to user test notes
📹 video	Videos	Links to the video

What's next

• Notes for repository maintainers
• Automating the process using tools

readme.md 수정 요청

저장소가 ci4userguidekr 이긴 하지만 타이틀에 명시를 해주면 좋을 것 같습니다.

CodeIgniter 한국어 사용자 가이드 -> CodeIgniter4 한국어 사용자 가이드

systemDirectory 변경

http://ci4doc.cikorea.net/installation/installing_composer.html#codeigniter4

app/Config/Paths.php 를 아래와 같이 수정하라고 되어 있으나 ROOTPATRH는 선언 전이라 작동되지 않음.

$systemDirectory = ROOTPATH . '/vendor/codeigniter4/framework/system';

아래와 같이 수정해야 정상작동함
public $systemDirectory = '../vendor/codeigniter4/framework/system';