跳到主要内容

帮助

不产生依赖的帮助

Foundation 被设计为可以自助,帮助模式也反映了这一点。没有 Foundation 支持台,没有需要创建的账号,本站也没有联系表单:编造一个就等于暗示一项并不存在的服务。以下是真正可用的内容。

  • 文档在公开仓库中与代码一起分发,因此不会脱离它所描述的内容。
  • 三种正当路径 —— 自己动手、使用自己的开发者或代理机构、或 Provelopment 的可选协助 —— 没有推荐的优胜者。
  • 这里描述的内容都没有被锁定,本页也不承诺响应时间。

三种正当的获得帮助方式

这是人们真正会走的路径,同等有效。本页不偏袒任何一种:无论选择哪种,最终得到的网站相同。

  • 自助

    公开仓库是 Foundation 的主要帮助渠道。文档是为跟随执行而写,而不是为浏览而写,并与它所描述的代码一起版本化。

    • README、定制指南、架构文档、部署运行手册和手册各自掌握自己的主题。
    • 校验关卡在构建时以指明设置的方式报告配置问题,多数问题因此当场解决。
    • 没有任何内容被保留:不存在解锁文档、代码或可运行安装的付费等级。

    手册

  • 使用自己的开发者或代理机构

    由于部署需要修改的一切都在配置、内容和资源中而不是平台代码,Foundation 网站可以由任何有能力的前端开发者接手,即使从未见过 Foundation。

    • 交接不依赖隐性知识:所有权边界和架构都有文档,测试强制这些边界。
    • 存在从零到高效工作的最短路径,长度是两份文档。
    • 运行、修改或部署 Foundation 网站都不需要 Provelopment 介入。

    定制指南

  • 询问 Provelopment

    Provelopment 可以为需要的组织提供实施协助、技术支持、服务支持和托管服务。它与基础分离,完全可选。

    • Foundation 不要求它,软件的任何部分也不依赖它。
    • 它与项目分开商定:本站不运营支持或销售渠道。
    • 采用 Foundation、自行部署并从不联系 Provelopment,是完全成功的结果。

    Provelopment

三者都不是被推荐的方式。是否引入协助是一项服务决定,您随时可以决定或改变,而不需要修改软件。

掌握答案的文档

技术问题在仓库中处理,紧邻答案所描述的代码。以下每份文档在其主题上都是权威,因此本页不做重复。

  • README

    项目是什么、如何开始、仓库结构,以及真实的校验命令。

  • CUSTOMIZING.md

    面向下游使用者的指南与完整配置参考,包括区分您与平台各自范畴的对照表。

  • ARCHITECTURE.md

    架构风格、边界、依赖方向与集成模式。

  • DEPLOYMENT.md

    发布运行手册:首次部署、持续集成保护、自定义域名与部署后检查。

  • BRAND_ASSETS.md

    品牌资源替换契约:每个可替换的视觉角色及其顺序。

  • instruction-manuals/

    流程:采用、定制、品牌、内容、校验、部署、升级与排障。

  • troubleshooting.md

    反复出现的故障及其安全解决方式,包括升级后出现的那些。

如果本站与仓库出现分歧,以仓库为准。本页告诉您看哪里;工作由仓库完成。

哪个来源回答哪个问题

大多数访客带着少数几个问题之一而来。以下是回答它们的位置,都不需要账号或交谈。

  • Foundation 是什么,提供什么?

    项目自身对其范围、边界以及各部分行为的说明。

    功能

  • 它在技术上如何构成?

    分层、依赖方向,以及由测试强制执行的边界。

    架构

  • 如何把网站适配我的业务?

    标识、品牌、内容、字典与资源,以及您可以修改的文件。

    站点定制

  • 如何把它上线?

    部署运行手册:首次部署、自定义域名,以及之后的检查。

    部署

  • 完成后的 Foundation 网站是什么样?

    在同一基础上构建、内容与标识和导航各不相同的两个运行中的演示。

    演示

  • 我自己的网站出了问题。

    排障流程包含真正反复出现过的问题,每个都有经过验证的安全解决方式;校验流程定义了检查通过意味着什么。

    排障流程

  • 我希望由别人来实施或维护。

    Provelopment 自己的网站说明了它提供什么。那项安排与项目分开进行。

    Provelopment

本页刻意不再复述手册。它只做指引,让每个答案都只有一个权威来源。

如果您现在就卡住了

Foundation 网站上的多数问题都是配置问题,而基础被设计为报告而不是隐藏它们。在假设项目有问题之前,请先按这个清单排查。

  1. 1

    运行校验关卡并阅读失败信息

    配置问题在构建时以指明设置的方式报告,多数问题因此当场解决。README 说明了项目自身会执行的命令。

  2. 2

    阅读排障流程

    手册包含反复出现的故障及其安全解决方式,也包括升级上游之后出现的那些。

  3. 3

    如果刚升级,先确认什么发生了变化

    升级流程记录了 Foundation 各版本之间哪些内容发生移动、哪些文件属于采用方,这解释了升级后立刻出现的大部分问题。

  4. 4

    询问构建您网站的人

    如果有人为您实施或维护网站,他手里就有部署环境,是最快得到答案的路径。

这里的任何步骤都不需要联系 Provelopment,也没有附带响应时间。

如需要,帮助是可用的

Provelopment 可以为需要的组织提供实施协助、技术支持、服务支持和托管服务。它与基础分离,完全可选。

  • 它与项目分开商定:本站没有任何可以注册的内容。
  • 软件、文档或运行中的演示都不依赖它。
  • 使用它,或决定永不使用,都不会改变 Foundation 是什么。

Provelopment

先按 Foundation 自身的条款使用它,如需要再考虑协助。

采用开源软件不包含什么

帮助模式的诚实与其中的路径同样重要,因此本页说明边界,而不是让您去猜。

  • 没有支持台,也没有保证的回复:这里描述的内容没有专职人员值守,本站也不接受支持请求。
  • 没有服务等级、事件响应或可用性承诺:部署由您运行,软件按现状提供且不含担保。
  • 没有维护合同:吸收上游改进是您或您的开发者执行的文档化流程。
  • 没有被锁定的文档,也没有付费等级:本页描述的每份文档都是公开的,代码采用 Apache-2.0。
  • 对 Provelopment 没有隐含义务:可选协助是单独的服务协议,而不是软件可用的前提条件。

可用的是仓库中的成果,以及(如果您选择)一份单独的服务协议。此外没有任何暗示。

从您的问题所在开始

阅读掌握您问题的文档,查看运行中的演示,或在准备好构建时走采用路径。