Skip to content

Commit

Permalink
(from getambassador.io) edits
Browse files Browse the repository at this point in the history
  • Loading branch information
mattmcclure-dw committed May 5, 2021
1 parent af423d2 commit eb79567
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion community.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Community

## Contributor's Guide
## Contributor's guide
Please review our [contributor's guide](https://github.com/telepresenceio/telepresence/blob/release/v2/DEVELOPING.md)
on GitHub to learn how you can help make Telepresence better.

Expand Down
4 changes: 2 additions & 2 deletions concepts/devloop.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The developer experience is the workflow a developer uses to develop, test, depl

Typically this experience has consisted of both an inner dev loop and an outer dev loop. The inner dev loop is where the individual developer codes and tests, and once the developer pushes their code to version control, the outer dev loop is triggered.

The outer dev loop is _everything else _that happens leading up to release. This includes code merge, automated code review, test execution, deployment, [controlled (canary) release](../../../../argo/latest/concepts/canary/), and observation of results. The modern outer dev loop might include, for example, an automated CI/CD pipeline as part of a [GitOps workflow](../../../../argo/latest/concepts/gitops/#what-is-gitops) and a progressive delivery strategy relying on automated canaries, i.e. to make the outer loop as fast, efficient and automated as possible.
The outer dev loop is _everything else_ that happens leading up to release. This includes code merge, automated code review, test execution, deployment, [controlled (canary) release](../../../../argo/latest/concepts/canary/), and observation of results. The modern outer dev loop might include, for example, an automated CI/CD pipeline as part of a [GitOps workflow](../../../../argo/latest/concepts/gitops/#what-is-gitops) and a progressive delivery strategy relying on automated canaries, i.e. to make the outer loop as fast, efficient and automated as possible.

Cloud-native technologies have fundamentally altered the developer experience in two ways: one, developers now have to take extra steps in the inner dev loop; two, developers need to be concerned with the outer dev loop as part of their workflow, even if most of their time is spent in the inner dev loop.

Expand All @@ -18,7 +18,7 @@ The inner dev loop is the single developer workflow. A single developer should b

Even within the Kubernetes space, developers will find much of the inner dev loop familiar. That is, code can still be written locally at a level that a developer controls and committed to version control.

In a traditional inner dev loop, if a typical developer codes for 360 minutes (6 hours) a day, with a traditional local iterative development loop of 5 minutes 3 coding, 1 building, i.e. compiling/deploying/reloading, 1 testing inspecting, and 10-20 seconds for committing code -- they can expect to make ~70 iterations of their code per day. Any one of these iterations could be a release candidate. The only “developer tax” being paid here is for the commit process, which is negligible.
In a traditional inner dev loop, if a typical developer codes for 360 minutes (6 hours) a day, with a traditional local iterative development loop of 5 minutes - 3 coding, 1 building, i.e. compiling/deploying/reloading, 1 testing inspecting, and 10-20 seconds for committing code - they can expect to make ~70 iterations of their code per day. Any one of these iterations could be a release candidate. The only “developer tax” being paid here is for the commit process, which is negligible.

![traditional inner dev loop](../../images/trad-inner-dev-loop.png)

Expand Down
6 changes: 3 additions & 3 deletions doc-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
link: /install/
- title: Upgrade
link: /install/upgrade/
- title: Core Concepts
- title: Core concepts
items:
- title: The changing development workflow
link: /concepts/devworkflow
Expand All @@ -24,15 +24,15 @@
link: /concepts/faster
- title: Context propagation
link: /concepts/context-prop
- title: How Do I...
- title: How do I...
items:
- title: Intercept a service in your own environment
link: /howtos/intercepts
- title: Share dev environments with preview URLs
link: /howtos/preview-urls
- title: Proxy outbound traffic to my cluster
link: /howtos/outbound
- title: Technical Reference
- title: Technical reference
items:
- title: Architecture
link: /reference/architecture
Expand Down
2 changes: 1 addition & 1 deletion quick-start/TelepresenceQuickStartLanding.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class TelepresenceQuickStartLanding extends Component {
<path fillRule="evenodd" clipRule="evenodd" d="M11.25 11.8492C13.4065 11.3163 14.9999 9.43704 14.9999 7.20045C14.9999 4.54948 12.7613 2.40045 9.99992 2.40045C7.2385 2.40045 4.99992 4.54948 4.99992 7.20045C4.99992 9.43707 6.59342 11.3164 8.74998 11.8492V26.5519C6.59342 27.0847 4.99992 28.964 4.99992 31.2006C4.99992 33.8516 7.2385 36.0006 9.99992 36.0006C12.7613 36.0006 14.9999 33.8516 14.9999 31.2006C14.9999 28.9641 13.4065 27.0847 11.25 26.5519V11.8492ZM10.0557 9.59986C10.0372 9.59909 10.0186 9.59869 9.99998 9.59869C9.9813 9.59869 9.96272 9.59909 9.94425 9.59986C8.58925 9.57144 7.49992 8.50807 7.49992 7.20045C7.49992 5.87497 8.61921 4.80045 9.99992 4.80045C11.3806 4.80045 12.4999 5.87497 12.4999 7.20045C12.4999 8.50805 11.4106 9.5714 10.0557 9.59986ZM7.49992 31.2006C7.49992 29.8752 8.61921 28.8006 9.99992 28.8006C11.3806 28.8006 12.4999 29.8752 12.4999 31.2006C12.4999 32.5261 11.3806 33.6006 9.99992 33.6006C8.61921 33.6006 7.49992 32.5261 7.49992 31.2006Z" fill="#003380"/>
<ellipse cx="30" cy="31.2001" rx="2.5" ry="2.4" fill="#00C05B"/>
</svg>
Telepresence Quick Start
Telepresence quick start
</h1>
<p>
Code and test microservices <strong>locally</strong> against a <strong>remote</strong> Kubernetes cluster.
Expand Down
2 changes: 1 addition & 1 deletion reference/intercepts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Intercepts

## Intercept behvaior when logged into Ambassador CLoud
## Intercept behvaior when logged into Ambassador Cloud

After logging into Ambassador Cloud (with `telepresence login`), Telepresence will default to `--preview-url=true`, which will use Ambassador Cloud to create a sharable preview URL for this intercept. (Creating an intercept without logging in will default to `--preview-url=false`).

Expand Down
4 changes: 2 additions & 2 deletions reference/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ In addition to the above, there is also a consideration of how to manage Users a
- Kubernetes version 1.16+
- Cluster admin privileges to apply RBAC

## Editing your Kubeconfig
## Editing your kubeconfig

This guide also assumes that you are utilizing a Kubeconfig file that is specified by the `KUBECONFIG` environment variable. This is a `yaml` file that contains the cluster's API endpoint information as well as the user data being supplied for authentication. The Service Account name used in the example below is called tp2-user. This can be replaced by any value (i.e. John or Jane) as long as references to the Service Account are consistent throughout the `yaml`. After an administrator has applied the RBAC configuration, a user should create a `config.yaml` in your current directory that looks like the following:​
This guide also assumes that you are utilizing a kubeconfig file that is specified by the `KUBECONFIG` environment variable. This is a `yaml` file that contains the cluster's API endpoint information as well as the user data being supplied for authentication. The Service Account name used in the example below is called tp2-user. This can be replaced by any value (i.e. John or Jane) as long as references to the Service Account are consistent throughout the `yaml`. After an administrator has applied the RBAC configuration, a user should create a `config.yaml` in your current directory that looks like the following:​

```yaml
apiVersion: v1
Expand Down

0 comments on commit eb79567

Please sign in to comment.