문서
문서
Foundation의 문서는 설명서가 곁들여진 안내 책자가 아닙니다. 소프트웨어를 운영하기 위한 지식 그 자체이고, 설명하는 코드와 같은 저장소에 공개되어 있습니다. 그래서 설명과 구현이 떨어져 있을 수 없고, 앞으로 어떻게 되든 여러분 손에 남습니다.
여기 공개된 것은 모두 공개입니다
Foundation이 자기 프로젝트에 맞는지 정하기 전에 전부 읽어 볼 수 있습니다. 계정도, 누군가와의 대화도 필요 없이 자신의 속도로 절차를 따라갈 수 있습니다. 잠긴 부분이 없고, 고객만 볼 수 있는 판도 없습니다.
이것은 프로젝트를 만드는 방식의 일부로 의도된 것입니다. 플랫폼이 실제로 재사용될 수 있는 것은 도입하고, 설정하고, 배포하고, 최신 상태로 유지하는 데 필요한 지식이 그것을 쓴 사람의 손이 아니라 소프트웨어와 함께 옮겨 다닐 때입니다.
운영 매뉴얼
여덟 개의 매뉴얼이 있고, 각각 자기 주제에 대한 기준이 됩니다. 모두 Foundation을 처음 보는 사람을 대상으로 쓰였습니다.
- Adoption — 새 Foundation 프로젝트 만들기
고정된 Foundation 릴리스에서 새 프로젝트를 시작하는 방법. 플랫폼과 운영 지식을 처음부터 함께 가진 상태로 시작할 수 있습니다.
- Deployment — 검증된 사이트 배포하기
사이트를 공개하기까지의 흐름과 그 전에 해야 하는 중요한 확인. 도메인과 DNS처럼 계정 주인만 할 수 있는 작업도 포함합니다.
- Foundation Upgrade — 새 릴리스 받아들이기
새 Foundation 릴리스를 적용하는 방법과, 플랫폼 쪽 파일과 사용자 쪽 파일을 나누는 구조가 설정과 콘텐츠와 자산과 브랜드를 어떻게 지키는지.
- Site customization — 사이트 맞춤 설정
사용자 쪽을 위한 안내입니다. 무엇을 바꾸는지, 언어를 어떻게 추가하는지, 사이트의 정체성이 실제로 어디에 있는지.
- Branding and assets — 브랜드와 자산
사이트가 자기 결과물로 바꿔 끼우는 자산의 역할과 각각의 교체 방법.
- Content management — 콘텐츠 관리
페이지와 내비게이션과 사이트 문구가 파일로 어떻게 저장되고, 어떻게 추가하고 바꾸는지.
- Validation — 검증 관문
변경을 받아들이기 전에 무엇이 검사되는지, 그리고 그것을 직접 실행하는 방법.
- Troubleshooting — 문제 원인 좁히기
무언가 동작하지 않을 때의 첫 절차. 배포할 때 나오는 출력에서 보이지 않는 페이지까지.
읽는 데 계정도 허락도 필요하지 않습니다
매뉴얼은 누구나 읽고 실행할 수 있게 쓰였습니다. 가입도 구독도 없고, Provelopment와 이야기한 사람만 열 수 있는 부분도 없습니다. 다만 문서가 할 수 없는 일이 하나 있습니다. 계정 접근이 필요한 작업(DNS 설정 등)을 대신 해 주는 것입니다. 그것은 계정의 주인이 해야 합니다.
어디에서 시작할까
시간을 가장 적게 낭비하는 순서입니다. 각 단계마다 그 단계를 다루는 문서를 함께 적었습니다.
Foundation이 무엇인지 읽기
저장소의 README. 플랫폼이 제공하는 것, 의도적으로 넣지 않은 것, 그 위에 만든 사이트가 어떻게 보이는지.
더 읽기 전에 직접 돌려 보기
로컬에서 실행하고 기본 사이트를 만져 보십시오. 만져 본 한 시간이 사양을 하루 읽는 것보다 더 많은 의문을 풀어 줍니다.
어떻게 가질지 정하기
사이트 하나인지 여러 개인지. 자기 계정인지 운영을 맡기는 형태인지. 이 결정이 다른 어떤 기술적 선택보다 많은 것을 정합니다.
자기 프로젝트 만들기
Adoption 매뉴얼. Foundation 릴리스에서 프로젝트를 만들고 플랫폼과 운영 지식을 처음부터 함께 가집니다.
자기 것으로 만들기
Site customization과 Branding and assets. 정체성, 콘텐츠, 언어, 자산. 플랫폼을 고쳐 쓰는 대신 설정과 파일로 합니다.
자기 도메인으로 배포하기
Deployment 매뉴얼과 배포 절차서. 도메인 주인만 할 수 있는 DNS 작업도 포함합니다.
최신 상태로 유지하기
새 릴리스를 받아들일 때는 Foundation Upgrade, 검증 관문이 무엇을 증명하는지는 Validation에서 확인합니다.
매뉴얼이 전제하는 것과 전제하지 않는 것
매뉴얼은 Foundation을 처음 보는, 힘 있는 개발자를 대상으로 쓰였습니다. 터미널을 쓰고, 패키지 관리자를 실행하고, 파일을 편집하고, 웹 애플리케이션을 어느 사업자에든 배포할 수 있다는 것을 전제합니다. 프레임워크를 직접 써 본 경험은 전제하지 않으며, 무엇을 하기 전에 아키텍처 문서를 전부 읽어야 한다고도 전제하지 않습니다.
동시에 작업은 자기 손으로 한다는 전제도 있습니다. 절차는 모두 자신의 저장소, 자신의 호스팅 계정, 자신의 도메인에서 작업하는 사람을 향해 쓰였습니다. 계정 주인만 만들 수 있는 것이 필요한 절차(등록 사업자의 DNS 설정 접근 등)에서는 그 자리에서 그렇게 적혀 있습니다. 나중에 알게 되는 일은 없습니다.
반면 매뉴얼이 여러분을 대신해 정하지는 않습니다. 플랫폼이 지원하는 선택지와 각각의 결과를 설명하지만, 어느 호스팅 사업자를 쓸지, 몇 개 언어를 공개할지, 사이트를 직접 운영할지는 지정하지 않습니다. 그것은 사업에 대한 판단이고, 문서의 역할은 그것을 우연한 판단이 아니라 근거 있는 판단으로 만드는 것입니다.
먼저 밝혀 둘 한계도 있습니다. 매뉴얼이 설명할 수 있는 것은 플랫폼 자체의 동작과 도입하는 쪽의 책임입니다. 사이트가 연결하는 제3자 서비스의 내부까지는 설명할 수 없고 그럴 생각도 없습니다. 연결 지점이 다른 회사의 제품을 가리키면 그 제품의 문서가 기준이 됩니다.
저장소 최상위 문서
절차가 아니라 제품 자체를 설명하는 다섯 개의 파일입니다.