Skip to content

Commit

Permalink
Merge remote-tracking branch 'calico/master' into instant-search
Browse files Browse the repository at this point in the history 
# Conflicts:
#	_config.yml
  • Loading branch information
Artyom Rymarchik committed Dec 17, 2018
2 parents f95c73c + 7c70b30 commit 86f215e
Show file tree
Hide file tree
Showing 1,743 changed files with 44,156 additions and 6,005 deletions.
151 changes: 151 additions & 0 deletions AUTHORS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
# Calico authors

This file is auto-generated based on contribution records reported
by GitHub for the core repositories within the projectcalico/ organization. It is ordered alphabetically.

| Name | GitHub |
|--------|--------|
| Albert Vaca | @albertvaka |
| Alex Altair | @alexaltair |
| Alex Chan | @alexwlchan |
| Alex Pollitt | @lxpollitt |
| Alex Rowley | @rowleyaj |
| Alexander Golovko | @0xBF |
| Alexander Hersh | @alexhersh |
| Anatoly Popov | @aensidhe |
| Andrei Nistor | @codertux |
| Andy Randall | @ahrkrak |
| Anthony Arnaud | @aarnaud |
| Anton Antonov | @syndbg |
| Artem Panchenko | @artem-panchenko |
| Avi Deitcher | @deitch |
| Benjamin | @ben-st |
| Bo Liu | @liubog2008 |
| Brad Beam | @bradbeam |
| Brad Behle | @bradbehle |
| Brendan Creane | @bcreane |
| Bryan Bell | @bjwbell |
| Carlos Alberto (Euprogramador) | @euprogramador |
| Casey Davenport | @caseydavenport |
| Christian Simon | @simonswine |
| Christophe van de Kerchove | @zopanix |
| Christopher LIJLENSTOLPE | @liljenstolpe |
| Chu Xiangyang | @xychu |
| Cody McCain | @McCodeman |
| Cory Benfield | @Lukasa |
| Dalton Hubble | @dghubble |
| Dan (Turk) Osborne | @ozdanborne |
| Dario Nieuwenhuis | @Dirbaio |
| Dave Langridge | @DaveLangridge |
| David Tesar | @dtzar |
| David Wilder | @djlwilder |
| depay | @depay |
| Derek McQuay | @dmmcquay |
| Doug Collier | @doucol |
| Doug Davis | @duglin |
| Dylan Pindur | @dpindur |
| Ed Harrison | @eepyaich |
| Eran Reshef | @eranreshef |
| Eric Hoffmann | @2ffs2nns |
| Erik Stidham | @tmjd |
| Fabian Ruff | @databus23 |
| Feilong Wang | @openstacker |
| Fernando Alvarez | @methadata |
| fumihiko kakuma | @fkakuma |
| Gerard Hickey | @hickey |
| Giancarlo Rubio | @gianrubio |
| Guang Ya Liu | @gyliu513 |
| Gunjan Patel | @gunjan5 |
| He Yi | @heyi-arm |
| huikang | @huikang |
| IWAMOTO Toshihiro | @toshiiw |
| J. Grizzard | @elfchief |
| Jan Ivar Beddari | @beddari |
| Jeff Schroeder | @SEJeff |
| jie zhang | @jiulongzaitian |
| Joel Bastos | @kintoandar |
| Jose Bigio | @jose-bigio |
| Josh Conant | @insequent |
| Justin Nauman | @jrnt30 |
| Justin Ohms | @JustinOhms |
| Karthik Krishnan Ramasubramanian | @doublek |
| Ketan Kulkarni | @ketkulka |
| Lance Robson | @lwr20 |
| libby kent | @libby |
| lilianrong | @nightmeng |
| Liz Rice | @lizrice |
| Logan V | @logan2211 |
| Luiz Filho | @luizbafilho |
| Lv Jiawei | @MIBc |
| maao | @420691301 |
| Mark Fermor | @markfermor |
| Mark Petrovic | @ae6rt |
| Martin Evgeniev | @suizman |
| Mat Meredith | @MatMeredith |
| Matt Dupre | @matthewdupre |
| Matt Kelly | @mattkelly |
| Matt Leung | @mgleung |
| Maxim Ivanov | @redbaron |
| Maxime Guyot | @Miouge1 |
| Michael Dong | @michaeldongvrviu |
| Michael Stowe | @mikestowe |
| Mike Frisch | @EmmEff |
| Mike Scherbakov | @mihgen |
| Mike Spreitzer | @MikeSpreitzer |
| Muhammad Saghir | @msagheer |
| Neil Jerram | @neiljerram |
| Nic Doye | @nicdoye |
| Nick Bartos | @nbartos |
| Nick Wood | @nwoodmsft |
| Noah Treuhaft | @nwt |
| Paul Tiplady | @paultiplady |
| Pavel Khusainov | @alvelcom |
| Peter White | @plwhite |
| Pike | @pikeszfish |
| Qiu Yu | @unicell |
| Rahul Krishna Upadhyaya | @rakrup |
| Renan Gonçalves | @renan |
| Ricardo Katz | @rikatz |
| Rob Brockbank | @robbrockbank |
| Roma Sokolkov | @r7vme |
| Rush Tehrani | @rushtehrani |
| Ryan Zhang | @ry4nz |
| Saeid | @sudomakeinstall2 |
| Saurabh Mohan | @saumoh |
| Seth | @sethmccombs |
| Shatru | @shatrugna |
| Shaun Crampton | @fasaxc |
| Song Jiang | @song-jiang |
| Spike Curtis | @spikecurtis |
| Stephen Schlie | @heschlie |
| Suraj Narwade | @surajnarwade |
| Tamal Saha | @tamalsaha |
| Timo Beckers | @ti-mo |
| Timothy Briggs | @TrimBiggs |
| Tom Denham | @tomdee |
| Tomas | @ToroNZ |
| Tomas Mazak | @tomas-mazak |
| Vincent Schwarzer | @VincentS |
| Wei Kin Huang | @weikinhuang |
| Wietse Muizelaar | @wmuizelaar |
| YAMAMOTO Takashi | @yamt |
| Yecheng Fu | @cofyc |
| Yumo Yang | @elementyang |
| Zhaole Yang | @ijumps |
| Àbéjídé Àyodélé | @bjhaid |
| --- | @alexvarsh |
| --- | @briansan |
| --- | @Brook-Roberts |
| --- | @Calpicow |
| --- | @CaoShuFeng |
| --- | @chakravarthy392 |
| --- | @djosborne |
| --- | @emanic |
| --- | @fen4o |
| --- | @frnkdny |
| --- | @marvin-tigera |
| --- | @mikev |
| --- | @mofelee |
| --- | @OwenTuz |
| --- | @saumohos |
| --- | @svInfra17 |
35 changes: 22 additions & 13 deletions CONTRIBUTING_DOCS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

We welcome contributions to the Calico documentation.
We welcome contributions to the Calico documentation.

Instead of filing a GitHub issue, consider making a PR instead. You are likely to see a much more rapid resolution.

Expand All @@ -16,7 +16,7 @@ The doc contribution process works as follows.
1. [Check for broken links](#checking-for-broken-links).
1. Submit a pull request (PR) against the master branch of the [Project Calico repo](https://github.com/projectcalico/calico).
1. If you haven't already signed our contributer agreement, GitHub will prompt you to do so (required).
1. Request a review from one or more Calico maintainers.
1. Request a review from one or more Calico maintainers.
1. After getting the approval of at least one Calico maintainer, we ask that you [backport the changes in the `master` folder to the folders of the last two releases](#how-to-quickly-apply-changes-in-master-to-a-previous-release), if appropriate.
1. Squash your commits.
1. One of the doc repo maintainers will give the PR a final look and then merge it.
Expand All @@ -31,7 +31,7 @@ We also encourage you to review [Doc site organization](#doc-site-organization),

## Building the doc site locally

We use GitHub Pages and Jekyll to serve and build our site. While there are [several ways to build the site locally](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/), we recommend using our Docker image and the Makefile in the root of the repo. These will allow you to build the site with a single command.
We use GitHub Pages and Jekyll to serve and build our site. While there are [several ways to build the site locally](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/), we recommend using our Docker image and the Makefile in the root of the repo. These will allow you to build the site with a single command.

> **Prerequisite**: [Docker](https://docs.docker.com/engine/installation/).
Expand Down Expand Up @@ -59,14 +59,14 @@ To check for broken links, navigate into the root of the repo and issue the foll
make htmlproofer
```

The submission of a PR kicks off a continuous integration process which includes a `make htmlproofer` command. Any errors from `htmlproofer` will cause your PR to fail the continuous integration test, so it's best to run this locally before submitting your PR.
The submission of a PR kicks off a continuous integration process which includes a `make htmlproofer` command. Any errors from `htmlproofer` will cause your PR to fail the continuous integration test, so it's best to run this locally before submitting your PR.

However, you can also run this after submitting your PR and experiencing an `htmlproofer` failure from the Semaphore job.


## How to quickly apply changes in master to a previous release

Let's say there's a single commit that makes changes to the `master` directory which I want to apply to the `v1.5` directory.
Let's say there's a single commit that makes changes to the `master` directory which I want to apply to the `v1.5` directory.

1. Generate a diff. A sample command follows which stores the diff in a file called `my-patch.diff`.

Expand All @@ -79,7 +79,7 @@ Let's say there's a single commit that makes changes to the `master` directory w
```
git apply -p2 --directory=v1.5 my-patch.diff
```
- `-p2` strips off /master on the front of the paths.
- `--directory=v1.5` adds "v1.5" to the start of the paths.
Expand Down Expand Up @@ -108,7 +108,7 @@ Each orchestrator has a landing page that is targeted at people who are coming t
### Usage
This section contains task-based information. All top-level titles in this section should start with a gerund. Each topic should include why you want to perform the task, a goal, and a set of steps you can follow to achieve it.
This section contains task-based information. All top-level titles in this section should start with a gerund. Each topic should include why you want to perform the task, a goal, and a set of steps you can follow to achieve it.
Examples:
Expand Down Expand Up @@ -138,7 +138,6 @@ Examples:
- To create a top level splash page for a URL path, simply name the file `index.md`.
- If you are adding a new page to the current release directory, add the following metadata just under the `title` of the page: `redirect_from: latest/<path-to-new-file>`. This ensures that readers who use `latest` in their paths instead of the version number of the current release get redirected to your new page. If you do not add this, you may experience `htmlproofer` errors.
- [Add the new page to the side navigation bar](#linking-content).
Expand All @@ -153,10 +152,10 @@ If you need to delete or rename a directory or file:
- Update any `canonical_url` paths that reference the deleted or renamed page. The `canonical_url` metadata of all previous instances of the page may reference the deleted or renamed page. You must correct these pages to reference the final instance of the page. When you submit your PR, `htmlproofer` will flag these errors.
- _Deletion example_: If you delete a page from the `master` and `v3.0` directories, you must update the `canonical_url` path of the page in the `v2.6` directory to point to itself. You would also need to update the `canonical_url` paths of any previous instances of the page to point to the copy in the `v2.6` directory. This final copy becomes the new canonical copy.
- _Deletion example_: If you delete a page from the `master` and `v3.0` directories, you must update the `canonical_url` path of the page in the `v2.6` directory to point to itself. You would also need to update the `canonical_url` paths of any previous instances of the page to point to the copy in the `v2.6` directory. This final copy becomes the new canonical copy.
- _Renaming example_: If you rename a page from the `master` and `v3.0` directories, you must update the `canonical_url` path of the page in the `v2.6` directory to point to the new path. Also correct any copies in previous directories.
- For more discussion of canonical URLs, refer to the [Canonical URLs](#canonical-urls) section.
### Side navigation bar
Expand Down Expand Up @@ -205,11 +204,21 @@ An anchor link for each heading is automatically created. It consists of the tit
Because the documentation site includes content for past versions as well as the latest version, it contains many duplicate pages. When Google indexes the site, it needs to know which copy we prefer. We use [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) to add [canonical URLs](https://support.google.com/webmasters/answer/139066?hl=en) to each page. This helps us to ensure that the latest copy of the page comes up first when people search for information via Google.
Each page should include a `canonical_url` tag that contains the absolute path to the latest copy of the page, even if the latest copy is the page itself.
Each page should include a `canonical_url` tag that contains the absolute path to the latest copy of the page, even if the latest copy is the page itself.
You should _not_ need to modify the `canonical_url` metadata unless you are adding, deleting, or renaming a page.
## Code samples
Our site adds a copy button to each code block by default. To ensure that readers can copy and paste the code successfully, follow the [Code samples](https://github.com/projectcalico/calico/blob/master/DOC_STYLE_GUIDE.md#code-samples) recommendations in the DOC_STYLE_GUIDE.
To modify the default behavior for code samples that should not be copied, such as responses, append `{: .no-select-button}`. An example follows.
```
Successfully created 8 resource(s)
{: .no-select-button}
```
## Releases
See [RELEASING.md](RELEASING.md)
See [RELEASING.md](RELEASING.md)
18 changes: 16 additions & 2 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,18 @@ release-publish: release-prereqs
release-notes: release-prereqs
VERSION=$(CALICO_VER) GITHUB_TOKEN=$(GITHUB_TOKEN) python2 ./release-scripts/generate-release-notes.py

update-authors:
ifndef GITHUB_TOKEN
$(error GITHUB_TOKEN must be set)
endif
@echo "# Calico authors" > AUTHORS.md
@echo "" >> AUTHORS.md
@echo "This file is auto-generated based on contribution records reported" >> AUTHORS.md
@echo "by GitHub for the core repositories within the projectcalico/ organization. It is ordered alphabetically." >> AUTHORS.md
@echo "" >> AUTHORS.md
@docker run -ti --rm -v $(PWD):/code -e GITHUB_TOKEN=$(GITHUB_TOKEN) python:3 \
bash -c 'pip install pygithub && /usr/local/bin/python /code/release-scripts/get-contributors.py >> /code/AUTHORS.md'

# release-prereqs checks that the environment is configured properly to create a release.
release-prereqs:
ifndef RELEASE_STREAM
Expand All @@ -144,7 +156,9 @@ endif
echo "Expected CALICO_VER $(CALICO_VER) to equal NODE_VER $(NODE_VER)"; \
exit 1; fi

RELEASE_DIR?=_output/release-$(CALICO_VER)
OUTPUT_DIR?=_output
RELEASE_DIR_NAME?=release-$(CALICO_VER)
RELEASE_DIR?=$(OUTPUT_DIR)/$(RELEASE_DIR_NAME)
RELEASE_DIR_K8S_MANIFESTS?=$(RELEASE_DIR)/k8s-manifests
RELEASE_DIR_IMAGES?=$(RELEASE_DIR)/images
RELEASE_DIR_BIN?=$(RELEASE_DIR)/bin
Expand All @@ -154,7 +168,7 @@ MANIFEST_SRC ?= ./_site/$(RELEASE_STREAM)/getting-started/kubernetes/installatio
release-archive: release-prereqs $(RELEASE_DIR).tgz

$(RELEASE_DIR).tgz: $(RELEASE_DIR) $(RELEASE_DIR_K8S_MANIFESTS) $(RELEASE_DIR_IMAGES) $(RELEASE_DIR_BIN) $(RELEASE_DIR)/README
tar -czvf $(RELEASE_DIR).tgz $(RELEASE_DIR)/*
tar -czvf $(RELEASE_DIR).tgz -C $(OUTPUT_DIR) $(RELEASE_DIR_NAME)

$(RELEASE_DIR_IMAGES): $(RELEASE_DIR_IMAGES)/calico-node.tar $(RELEASE_DIR_IMAGES)/calico-typha.tar $(RELEASE_DIR_IMAGES)/calico-cni.tar $(RELEASE_DIR_IMAGES)/calico-kube-controllers.tar
$(RELEASE_DIR_BIN): $(RELEASE_DIR_BIN)/calicoctl $(RELEASE_DIR_BIN)/calicoctl-windows-amd64.exe $(RELEASE_DIR_BIN)/calicoctl-darwin-amd64
Expand Down
Loading

0 comments on commit 86f215e

Please sign in to comment.