Skip to content

Commit

Permalink
Replaces multiple blank lines with a single blank line
Browse files Browse the repository at this point in the history
  • Loading branch information
ctauchen committed Oct 28, 2022
1 parent d962031 commit 20979cf
Show file tree
Hide file tree
Showing 116 changed files with 19 additions and 3,888 deletions.
3 changes: 0 additions & 3 deletions CONTRIBUTING_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,20 +186,17 @@ The naming and layout of the side navigation bar is stored in `_data/$VERSION/na
> **Note**: Sidebar paths to index files (see [next section](#linking-content)) should end in a `/` in the yaml file. Sidebar paths to actual files should not end in a `/` in the yaml file.
## Link syntax
### Closing slashes
To link to a page not named `index.md`, omit the closing slash. To link to a page named `index.md`, include a closing slash. See the following table for some examples.
| URL | File path |
|-----------------------------------------------|---------------------------------------------------|
| `/getting-started/kubernetes/` | `/getting-started/kubernetes/index.md` |
| `/getting-started/kubernetes/troubleshooting` | `/getting-started/kubernetes/troubleshooting.md` |
### `site.url`, `site.baseurl`, and `absolute_url`
**`site.baseurl`**
Expand Down
3 changes: 1 addition & 2 deletions app-policy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ processed. We compute policy based on a global store which is distributed to Di
Application Layer Policy is described in the [Project Calico docs][docs].

- [Enabling Application Layer Policy](https://docs.projectcalico.org/master/security/app-layer-policy)



[calico]: https://projectcalico.org
[istio]: https://istio.io
[docs]: https://docs.projectcalico.org/latest
Expand Down
22 changes: 0 additions & 22 deletions calico/DOC_STYLE_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Calico documentation style guide


## Overview

We follow [_The Chicago Manual of Style_, 17th Edition](http://chicagomanualofstyle.org/), the [_Yahoo! Style Guide_](https://www.amazon.com/Yahoo-Style-Guide-Ultimate-Sourcebook/dp/031256984X), and the [Merriam-Webster dictionary](https://www.merriam-webster.com/).
Expand All @@ -11,7 +10,6 @@ This style guide contains:
- Clarification on frequent points of confusion
- Terminology guidelines


## Voice

The passive voice can obscure the actor and result in weak sentences.
Expand All @@ -21,7 +19,6 @@ topic, consult the following resources:
- [Purdue Online Writing Lab](https://owl.english.purdue.edu/owl/resource/539/02/)
- [Grammar Girl](http://www.quickanddirtytips.com/education/grammar/active-voice-versus-passive-voice)


## Pronouns

Use the second person to refer to your reader.
Expand All @@ -34,7 +31,6 @@ Use the first person plural to refer to Project Calico.
- **Correct**: "We recommend five nodes."
- **Incorrect**: "Five nodes are recommended."


## Anthropomorphism

Avoid personifying software.
Expand All @@ -47,12 +43,10 @@ Avoid personifying software.
- "Kubernetes sees that Calico is installed."
- "The delimiter tells Calico where to split the string."


## Future features

Avoid documenting future features or products.


## Graphics

### Screenshots and animated GIFs
Expand All @@ -70,7 +64,6 @@ sequences, use GIF.

For diagrams and other vector illustrations, we prefer the SVG format.


## Format of source

### HTML versus Markdown
Expand All @@ -81,7 +74,6 @@ We prefer Markdown for readability.

Wrap lines at 80 characters—except [URLs](#line-breaks).


## Punctuation

### Commas
Expand All @@ -94,7 +86,6 @@ Use hyphens only when necessary to prevent confusion. Examples include:
- A prefix ends in the same vowel that the word begins with: "re-entry".
- Compound modifiers: "You can find Calico easter eggs in read-only memory."


## Capitalization

### Proper nouns
Expand All @@ -106,7 +97,6 @@ Only capitalize proper nouns.
Use [sentence case](https://www.snappysentences.com/sentence-case-v-title-case/)
for headings.


## Computer interfaces

### Code in headings
Expand Down Expand Up @@ -203,7 +193,6 @@ for detailed instructions.
Do not insert line breaks inside a URL.
## Lists
### At least two items
Expand Down Expand Up @@ -295,7 +284,6 @@ Congratulations to the following winners of the Calico pop quiz:
- Chris.
```
## Procedures
Use numbered lists to indicate a series of steps that should be performed
Expand All @@ -304,7 +292,6 @@ in sequence.
Avoid giving the reader more than one way to accomplish a task. Just
describe the best method.
## Numbers and dates
Spell out numbers zero through nine. Use numeric form for 10 and above.
Expand All @@ -314,7 +301,6 @@ Spell out dates.
- **Incorrect**: Jan 1, 1970
- **Incorrect**: 1/1/1970
## Acronyms and file types
Treat file types as acronyms when used in text. Use all caps.
Expand All @@ -325,7 +311,6 @@ Examples:
To pluralize an acronym, add a lowercase "s". Example: "Deploy the VMs in
a single click."
## Notes
While notes can help to call attention to important information, too
Expand All @@ -350,7 +335,6 @@ is reserved for the note that appears at the top of the page to let people
know they are viewing a version of the documentation other than the
current release.
## Storage, memory, and speed abbreviations
Don't put a space between the number and the abbreviation. Examples: 500Kbps,
Expand All @@ -364,7 +348,6 @@ Don't add an "s" after the abbreviation to form a plural.
Repeat the abbreviation in a series. Example: "The device offers 2MB, 4MB,
or 6MB of storage."
## American conventions
### Spelling
Expand All @@ -380,7 +363,6 @@ Use a comma in whole numbers with four or more digits. Example: 1,200.
Use decimal points. Example, 2.5 pounds.
## Terminology
| Correct | Incorrect
Expand Down Expand Up @@ -408,7 +390,6 @@ Use decimal points. Example, 2.5 pounds.
| web interface | GUI, UI
| web server | webserver
## Commonly confused
### a | an
Expand Down Expand Up @@ -454,7 +435,6 @@ Use it as a mass noun, not a count noun.
- **Correct**: "less data"
- **Incorrect**: "fewer data"
### e.g. | i.e.
The abbreviation "e.g." refers to "exempli gratia" in Latin and means "for the sake of example."
Expand Down Expand Up @@ -495,5 +475,3 @@ deleted the clause, use "which".
- "Give me the book, which is on the table." There is only one book
in the room and it happens to be on the table.
1 change: 0 additions & 1 deletion calico/_includes/content/config-calico-upgrade-etcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ The full list of possible configuration file options and environment variables f
> useful if the non-prefixed names clash with existing environment variables.
{: .alert .alert-info}


### Configuring calico-upgrade to connect to the etcdv3 cluster

You can use either configuration files or environment variables to configure
Expand Down
1 change: 0 additions & 1 deletion calico/_includes/content/deleting-etcd-v2-v3-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ This procedure requires etcdctl v3. The etcdctl tool is installed along with etc
### Prerequisites

This procedure requires etcdctl v3. The etcdctl tool is installed along with etcd. To install just etcdctl, [download the etcd release binary](https://github.com/coreos/etcd/releases){:target="_blank"}, untar it, and extract the etcdctl binary.


### Deleting Calico data from etcdv3

Expand Down
2 changes: 0 additions & 2 deletions calico/_includes/content/environment-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ For a Kubernetes datastore (default) set the following:
{: .alert .alert-info}
{% endif %}


%>
<label: etcd datastore>
<%
Expand Down Expand Up @@ -68,7 +67,6 @@ For either datastore set the following:
| NO_DEFAULT_POOLS | Set to true to prevent {{site.prodname}} from creating a default pool if one does not exist. Pools are used for workload endpoints and not required for non-cluster hosts. |
| CALICO_NETWORKING_BACKEND | The networking backend to use. In `bird` mode, Calico will provide BGP networking using the BIRD BGP daemon; VXLAN networking can also be used. In `vxlan` mode, only VXLAN networking is provided; BIRD and BGP are disabled. If you want to run Calico for policy only, set to `none`. |


Sample `EnvironmentFile` - save to `/etc/calico/calico.env`

```shell
Expand Down
1 change: 0 additions & 1 deletion calico/_includes/content/install-calico-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,3 @@

1. Congratulations! You've installed `calico-upgrade`. Continue to [Configuring calico-upgrade](#configuring-calico-upgrade).


1 change: 0 additions & 1 deletion calico/_includes/content/testing-data-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,4 @@ calico-upgrade dry-run --output-dir=temp --apiconfigv1 etcdv2.yaml --apiconfigv3

- **Other errors**: if you receive any other errors, especially if they pertain to a
workload endpoint, contact Tigera for assistance.


3 changes: 0 additions & 3 deletions calico/about/about-calico.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,3 @@ custom_css: css/intro.css
</div>
</div>




2 changes: 0 additions & 2 deletions calico/about/about-k8s-networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,5 +134,3 @@ as IPv4 or IPv6 addresses.
- {% include open-new-window.html text='Video: Everything you need to know about Kubernetes networking on Google Cloud'
url='https://www.projectcalico.org/everything-you-need-to-know-about-kubernetes-networking-on-google-cloud/' %}



5 changes: 0 additions & 5 deletions calico/about/about-kubernetes-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,3 @@ provides even load balancing independent of topology, with reduced CPU and laten
- {% include open-new-window.html text='Blog: Hands on with Calico eBPF native service handling'
url='https://www.projectcalico.org/hands-on-with-calicos-ebpf-service-handling/' %}






8 changes: 0 additions & 8 deletions calico/about/about-network-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,11 +222,3 @@ multiple teams.
![Example tiers]({{site.baseurl}}/images/example-tiers.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,6 @@ kubectl logs -n kube-system -l k8s-app=flannel-migration-controller

If you need to revert a cluster from {{site.prodname}} back to flannel, follow these steps.


1. Remove the migration controller and {{site.prodname}}.

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ Label the default namespace, which you will use for the tutorial.
kubectl label namespace default istio-injection=enabled
```


## Test application layer policy

You can test application layer policy by following the [Application Layer Policy tutorial](/security/tutorials/app-layer-policy/enforce-policy-istio).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ To interact directly with the {{site.prodname}} datastore, use the `calicoctl` c

On most systems, kubeconfig is located at `~/.kube/config`. You may wish to add the `export` lines to your `~/.bashrc` so they will persist when you log in next time.


### Test

Verify `calicoctl` can reach your datastore by running
Expand Down Expand Up @@ -103,7 +102,6 @@ You should see an empty result
```
NAME CIDR SELECTOR
```

## Next
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,6 @@ The following table outlines the remaining supported `ConfigMap` options.
### CNI network configuration template
The `cni_network_config` configuration option supports the following template fields, which will
be filled in automatically by the `calico/cni` container:
Expand All @@ -269,7 +268,6 @@ be filled in automatically by the `calico/cni` container:
| `__ETCD_CERT_FILE__` | The path to the etcd certificate file installed to the host, empty if no cert present.
| `__ETCD_CA_CERT_FILE__` | The path to the etcd certificate authority file installed to the host. Empty if no certificate authority is present.
### About customizing application layer policy manifests
Instead of installing from our pre-modified Istio manifests, you may wish to
Expand Down
2 changes: 0 additions & 2 deletions calico/getting-started/kubernetes/k3s/multi-node-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,6 @@ Install {{site.prodname}} by creating the necessary custom resource. For more in
%>
{% endtabs %}



#### Check the installation

1. Confirm that all of the pods are running using the following command.
Expand Down
2 changes: 0 additions & 2 deletions calico/getting-started/kubernetes/k3s/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,8 @@ kube-system coredns-8655855d6-blzl5 1/1 Running 0
%>
{% endtabs %}


1. Press CTRL+C to exit `watch`.


2. Confirm that you now have a node in your cluster with the
following command.

Expand Down
2 changes: 0 additions & 2 deletions calico/getting-started/kubernetes/managed-public-cloud/aks.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ To enable {{site.prodname}} network policy enforcement, follow these step-by-ste
- [eBPF dataplane]({{ site.baseurl }}/maintenance/ebpf/use-cases-ebpf) is not supported.
- [VPP dataplane](https://github.com/projectcalico/vpp-dataplane) is not supported.


The geeky details of what you get:
{% include geek-details.html details='Policy:Calico,IPAM:Calico,CNI:Calico,Overlay:VXLAN,Routing:Calico,Datastore:Kubernetes' %}

Expand Down Expand Up @@ -87,7 +86,6 @@ The geeky details of what you get:
```
Wait until each pod has the `STATUS` of `Running`.
### Next steps
Expand Down
1 change: 0 additions & 1 deletion calico/getting-started/kubernetes/minikube.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,6 @@ Issuing a delete command will destroy the cluster that you created in this tutor
minikube delete
```


### Next steps

**Required**
Expand Down
1 change: 0 additions & 1 deletion calico/getting-started/kubernetes/rancher.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ The geeky details of what you get:

#### Install {{site.prodname}}


1. Install the Tigera {{site.prodname}} operator and custom resource definitions.

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ you generate a {% include open-new-window.html text='gossip' url='https://kops.s

You can further customize the {{site.prodname}} install with {% include open-new-window.html text='options listed in the kops documentation' url='https://kops.sigs.k8s.io/networking/calico' %}.


### Cleanup

If you wish to remove resources created by this tutorial
Expand Down
Loading

0 comments on commit 20979cf

Please sign in to comment.