文档
文档
Foundation 的文档不是附了一份说明的小册子。它就是运作这套软件所需的知识本身,并且与它所描述的代码发布在同一个代码仓库里。因此说明与实现不会脱节,无论后续如何变化,它都会留在您手里。
这里的一切都是公开的
在判断 Foundation 是否适合自己的项目之前,您可以先把全部内容读完。不需要账户,也不需要与任何人联系,可以按自己的节奏跟着步骤走。没有上锁的部分,也没有只对客户开放的版本。
这是项目构建方式的一部分。只有当实施、配置、部署与维护所需的知识随软件一同移动,而不是留在写它的人手里时,平台才真正可被复用。
运维手册
共有八本手册,每一本都是其主题上的依据,都面向第一次接触 Foundation 的人。
- Adoption — 创建新的 Foundation 项目
如何从固定的 Foundation 版本开始一个新项目,让平台与运维知识从第一天起就与您同在。
- Deployment — 发布经过校验的网站
网站公开前的流程与必须完成的确认,包括只有账户持有人才能完成的工作:域名与 DNS。
- Foundation Upgrade — 采用新版本
如何采用新的 Foundation 版本,以及平台文件与站点文件的分隔如何保护配置、内容、资源与品牌。
- Site customization — 站点定制
面向使用者的指南:具体修改什么、如何添加语言,以及站点的身份实际存放在哪里。
- Branding and assets — 品牌与资源
站点用自己的成果替换的资源各自承担什么作用,以及每一类的替换方式。
- Content management — 内容管理
页面、导航与站点文案如何以文件保存,如何新增与修改。
- Validation — 校验关口
在变更被接受之前会检查什么,以及如何自行运行这些检查。
- Troubleshooting — 缩小问题范围
出现异常时的第一步:从部署输出到无法显示的页面。
阅读不需要账户,也不需要许可
手册写给任何可以阅读和照着执行的人。没有注册,没有订阅,也没有只对谈过话的人开放的部分。只有一件事文档做不到:替您完成需要账户访问权的工作(例如 DNS 记录设置)。那必须由账户持有人来做。
从哪里开始
最不浪费时间的顺序。每个步骤都附上处理它的文档。
先读 Foundation 是什么
代码仓库中的 README:平台提供什么、刻意不包含什么,以及建在其上的网站是什么样子。
在读更多之前先跑起来
在本地启动并试着操作基础站点。动手一小时,能回答比读一天说明更多的疑问。
决定以什么方式拥有它
一个站点还是多个;用您自己的账户,还是把运营交出去。这个决定比任何技术选择都更能决定后续。
创建自己的项目
Adoption 手册:从 Foundation 版本建立项目,让平台与运维知识从第一天起就在您手里。
把站点变成自己的
Site customization 与 Branding and assets:身份、内容、语言、资源。通过配置与文件完成,而不是改写平台。
在自己的域名上发布
Deployment 手册与部署流程,其中包括只有域名持有人才能完成的 DNS 工作。
保持更新
采用新版本时看 Foundation Upgrade;校验关口能证明什么,看 Validation。
手册预设了什么,又不替您决定什么
手册面向第一次接触 Foundation、且具备动手能力的开发者。它预设您会使用终端、运行包管理器、编辑文件,并能把 Web 应用发布到任意服务商。它不预设您写过框架,也不预设您在动手之前会读完整个架构文档。
同时还有一个预设:工作由您自己完成。所有步骤都写给在自己的代码仓库、自己的托管账户、自己的域名下操作的人。凡是需要账户持有人才能完成的操作(例如注册商的 DNS 记录访问),都在当场写明,而不是事后才发现。
反过来说,手册不替您作决定。它说明平台支持哪些选择以及各自的后果,但不指定该用哪家托管服务商、该发布多少种语言、是否自己运营站点。那些属于业务判断;文档的作用是让这个判断有依据,而不是碰运气。
还有一个限制值得提前说明:手册能解释的是平台自身的行为以及采用方的责任。它不解释网站所接入的第三方服务的内部机制,也不打算这样做。如果接点指向别人的产品,那个产品的文档才是依据。
代码仓库根目录中的文档
以下五个文件描述的是产品本身,而不是操作步骤。