同步操作将从 countingStars1/calico 强制同步，此操作会覆盖自 Fork 仓库以来所做的任何修改，且无法恢复！！！
This repository contains the source code for Project Calico's documentation and demos.
If you are a Calico user, you probably want the live documentation site.
If you are looking for the repository formerly known as
it has been renamed to
You can find archives of the previous documentation at:
The docs require jekyll, a ruby gem. Install the
github-pages gem which includes
jekyll to ensure you are using the exact version of jekyll that github pages
is using to serve the live site.
gem install github-pages jekyll serve -I
Note:As more versioned directories are created, build speeds will increase by a factor of 2. The
-Iis an optional flag for development that enables incremental builds, allowing jekyll to only rebuild changed files. This should keep subsequent builds down to less than one second.
Alternatively, you can easily volume mount the source files into the official jekyll docker image via using a simple makefile step:
As the output states, docs should then be viewable at http://localhost:4000/ .
The live site is generated from the master branch of this repository.
Documentation for past releases is maintained as a folder in the root of this repository.
Most pull requests which modify information in the docs should primarily target
/master/ folder, especially if they are describing newly added features.
However, changes should also be applied to past-release directories if they fix
general typos or incorrect information.
Let's say there's a single commit that makes changes to Master which I want to apply to the v1.5 directory. First, generate a diff:
git diff f35c02fe73e6a64d187ee3f6e9298ca47ded91ab^1 f35c02fe73e6a64d187ee3f6e9298ca47ded91ab > my-patch.diff
Then, apply that diff to the target version directory.
git apply -p2 --directory=v1.5 my-patch.diff
-p2strips off /master on the front of the paths.
--directory=v1.5adds "v1.5" to the start of the paths.
Then simply inspect the results (
git diff, etc.) and commit.
The docs (currently) are split into 4 sections:
The naming and layout of these navbars are stored in
_data/$VERSION/navbars/*. Jekyll automatically stores information from the
_data dir in an accessible variable called
site.data. The toplevel layout (
_layout/docwithnav.html) will iterate through all the files in
site.data[version].navbars to construct the sidebar based on which version is being viewed.
Note: Sidebar paths to index files (see next section) should end in a
/in the yaml file. Sidebar paths to actual files should not end in a
/in the yaml file.
URL structure is important. In order to create a toplevel splash page for a URL path, simply name the file
index.md. See the following example:
All links should be absolute links. To link to versioned content, prefix all links with:
page.versionwill be inherited from the default set in
_config.ymlfor the current page's directory.
Print all broken links:
Most of the theming of this site is based on the Kubernetes documentation. The original Kubernetes Apache license in in LICENSE.
At least some of this work is based on the basic Jekyll theme from scotch.io - see scotch.io.github.io license.