Skip to content

Commit

Permalink
Rebrand docs (#3844) (#3878)
Browse files Browse the repository at this point in the history
* Rebrand docs (#3844)

* pass part 1
* update part 2
* update part three
* update part four
* update five
* update six
* update seven
* Merge branch 'master' into rebrand-docs
* fix Gloo Edge Gateway naming
* update images part 1
* replace Dev Portal references
* image updates
* changelog
* Merge branch 'master' into rebrand-docs
* image update part two
* Merge branch 'master' into rebrand-docs
* replace docs.solo.io/gloo/ with gloo-edge
* update dev-portal to gloo-portal in docs URL
* Merge refs/heads/master into rebrand-docs
* generated-code run
* Merge branch 'rebrand-docs' of https://github.com/solo-io/gloo into rebrand-docs
merge pull from remote
* Move changelog
* Remove example doc
* Rebrand in CLI messages
* Regen code
* Fix log message
* Fix bad merge
* Fix bad replace
* Regen code
* Merge branch 'v1.5.x' into v1.5.8-docs-update
* add changelog
* move changelog
* Better route replacement docs (#3877)

* Better route replacement docs
* remove extra changelog
* changelog
* Update main image logo in docs and README (#3860)

* Update README

* Resizing

* Update logo image

* Update logo image

(cherry picked from commit df1ec48)
* Update readme (#3861)
* Docs 404 (#3857)

* fix 404 in new docs

* changelog

* oops

Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com>
* consolidate changelog
* generated-code run
  • Loading branch information
ned1313 committed Nov 17, 2020
1 parent 5a56823 commit c02c864
Show file tree
Hide file tree
Showing 252 changed files with 2,279 additions and 2,187 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ A clear and concise description of what you expected to happen.

**Additional context**
Add any other context about the problem here, e.g.
- Gloo version
- Gloo Edge version
- Kubernetes version
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ assignees: ''
---

**Describe the requested changes**
List the desired changes to be made to the Gloo docs.
List the desired changes to be made to the Gloo Edge docs.

**Link to any relevant existing docs**
1. https://docs.solo.io/gloo/latest/...
1. https://docs.solo.io/gloo-edge/latest/...
2. ...

**Browser Information**
Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Users ran into this bug doing ... \ Users needed this feature to ...

- [ ] I included a concise, user-facing changelog (for details, see https://github.com/solo-io/go-utils/tree/master/changelogutils) which references the issue that is resolved.
- [ ] If I updated APIs (our protos) or helm values, I ran `make install-go-tools generated-code` to ensure there will be no code diff
- [ ] I followed guidelines laid out in the Gloo [contribution guide](https://docs.solo.io/gloo/latest/contributing/)
- [ ] I followed guidelines laid out in the Gloo Edge [contribution guide](https://docs.solo.io/gloo-edge/latest/contributing/)
- [ ] I opened a draft PR or added the work in progress label if my PR is not ready for review
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
Expand Down
6 changes: 3 additions & 3 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Building Gloo
## Building Gloo Edge

To build Gloo locally, follow [these steps](https://docs.solo.io/gloo/latest/guides/dev/setting-up-dev-environment/), mostly duplicated below:
To build Gloo Edge locally, follow [these steps](https://docs.solo.io/gloo-edge/latest/guides/dev/setting-up-dev-environment/), mostly duplicated below:

Checkout gloo:

Expand All @@ -14,7 +14,7 @@ Navigate to the source directory:
cd $GOPATH/src/github.com/solo-io/gloo
```

Gloo uses [go modules](https://github.com/golang/go/wiki/Modules) for dependency management. Ensure you have go 1.13+ installed.
Gloo Edge uses [go modules](https://github.com/golang/go/wiki/Modules) for dependency management. Ensure you have go 1.13+ installed.

At this point you should be able to build the individual components that comprise gloo:

Expand Down
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Contributing to Gloo
## Contributing to Gloo Edge

Excited about Gloo and want to help make it better?
Excited about Gloo Edge and want to help make it better?

At Solo we strive to make the world of microservices, serverless and service mesh available to everyone.
If you want to help but don't know where to start, let us know, and we'll find something for you.
Expand All @@ -24,11 +24,11 @@ If an issue you have is already reported, please add additional information or a

### Improving the documentation

The docs for Gloo are built from the contents found in the [`docs/content`](/docs/content) directory of this repository.
The docs for Gloo Edge are built from the contents found in the [`docs/content`](/docs/content) directory of this repository.

Improving the documentation, adding examples or use cases can be the easiest way to contribute to Gloo. If you see a piece of content that can be better, open a PR with an improvement, it doesn't matter how small!
Improving the documentation, adding examples or use cases can be the easiest way to contribute to Gloo Edge. If you see a piece of content that can be better, open a PR with an improvement, it doesn't matter how small!

For more detailed guidance on contributing to the documentation, check out the guide on the [docs website](https://docs.solo.io/gloo/latest/contributing).
For more detailed guidance on contributing to the documentation, check out the guide on the [docs website](https://docs.solo.io/gloo-edge/latest/contributing).

### Small bug fixes

Expand All @@ -53,9 +53,9 @@ For significant changes to the repository, it’s important to settle on a desig

### Code review guidelines

It’s important that every piece of code in Gloo is reviewed by at least one Solo team member familiar with that codebase.
It’s important that every piece of code in Gloo Edge is reviewed by at least one Solo team member familiar with that codebase.

1. **Changelog** Every PR in Gloo needs a changelog entry. For more information about changelogs, see the [readme](https://github.com/solo-io/go-utils/tree/master/changelogutils).
1. **Changelog** Every PR in Gloo Edge needs a changelog entry. For more information about changelogs, see the [readme](https://github.com/solo-io/go-utils/tree/master/changelogutils).
2. **CI check** A Solo team member needs to kick off the CI process by commenting `/test` on your PR.
3. **Testing** Please write tests for your changes. Bias towards fast / unit testing.
4. **Comments** The code reviewer may leave comments to discuss changes. Minor preferences are often called out with `nit`.
Expand Down
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ discovery-docker: $(DISCOVERY_OUTPUT_DIR)/discovery-linux-$(GOARCH) $(DISCOVERY_
-t $(IMAGE_REPO)/discovery:$(VERSION)

#----------------------------------------------------------------------------------
# Gloo
# Gloo Edge
#----------------------------------------------------------------------------------

GLOO_DIR=projects/gloo
Expand All @@ -353,7 +353,7 @@ gloo-docker: $(GLOO_OUTPUT_DIR)/gloo-linux-$(GOARCH) $(GLOO_OUTPUT_DIR)/Dockerfi
-t $(IMAGE_REPO)/gloo:$(VERSION)

#----------------------------------------------------------------------------------
# SDS Server - gRPC server for serving Secret Discovery Service config for Gloo MTLS
# SDS Server - gRPC server for serving Secret Discovery Service config for Gloo Edge MTLS
#----------------------------------------------------------------------------------

SDS_DIR=projects/sds
Expand Down Expand Up @@ -501,7 +501,7 @@ ifeq ($(RELEASE),"true")
endif

#----------------------------------------------------------------------------------
# Build the Gloo Manifests that are published as release assets
# Build the Gloo Edge Manifests that are published as release assets
#----------------------------------------------------------------------------------

.PHONY: render-manifests
Expand Down Expand Up @@ -630,10 +630,10 @@ push-kind-images: docker
#
# The following targets are used to generate the assets on which the kube2e tests rely upon. The following actions are performed:
#
# 1. Generate Gloo value files
# 2. Package the Gloo Helm chart to the _test directory (also generate an index file)
# 1. Generate Gloo Edge value files
# 2. Package the Gloo Edge Helm chart to the _test directory (also generate an index file)
#
# The Kube2e tests will use the generated Gloo Chart to install Gloo to the GKE test cluster.
# The Kube2e tests will use the generated Gloo Edge Chart to install Gloo Edge to the GKE test cluster.

.PHONY: build-test-assets
build-test-assets: build-test-chart $(OUTPUT_DIR)/glooctl-linux-$(GOARCH) \
Expand Down
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@


<h1 align="center">
<img src="https://docs.solo.io/gloo/latest/img/Gloo-01.png" alt="Gloo" width="200" height="242">
<img src="https://docs.solo.io/gloo-edge/master/img/Gloo-01.png" alt="Gloo Edge" width="200" height="155">
<br>
An Envoy-Powered API Gateway
</h1>

Gloo is a feature-rich, Kubernetes-native ingress controller, and next-generation API gateway. Gloo is exceptional in its function-level routing; its support for legacy apps, microservices and serverless; its discovery capabilities; its numerous features; and its tight integration with leading open-source projects. Gloo is uniquely designed to support hybrid applications, in which multiple technologies, architectures, protocols, and clouds can coexist.
Gloo Edge is a feature-rich, Kubernetes-native ingress controller, and next-generation API gateway. Gloo Edge is exceptional in its function-level routing; its support for legacy apps, microservices and serverless; its discovery capabilities; its numerous features; and its tight integration with leading open-source projects. Gloo Edge is uniquely designed to support hybrid applications, in which multiple technologies, architectures, protocols, and clouds can coexist.


[**Installation**](https://gloo.solo.io/installation/) &nbsp; |
Expand All @@ -16,25 +16,25 @@ Gloo is a feature-rich, Kubernetes-native ingress controller, and next-generatio
&nbsp; [**Twitter**](https://twitter.com/soloio_inc) |
&nbsp; [**Enterprise Trial**](https://www.solo.io/products/gloo/#enterprise-trial)

<BR><center><img src="https://docs.solo.io/gloo/latest/img/gloo-architecture-envoys.png" alt="Gloo Architecture" width="906"></center>
<BR><center><img src="https://docs.solo.io/gloo-edge/master/img/gloo-architecture-envoys.png" alt="Gloo Edge Architecture" width="906"></center>

## Summary

- [**Using Gloo**](#using-gloo)
- [**What makes Gloo unique**](#what-makes-gloo-unique)
- [**Using Gloo Edge**](#using-gloo-edge)
- [**What makes Gloo Edge unique**](#what-makes-gloo-edge-unique)


## Using Gloo
- **Kubernetes ingress controller**: Gloo can function as a feature-rich ingress controller, built on top of the Envoy Proxy.
- **Next-generation API gateway** : Gloo provides a long list of API gateway features, including rate limiting, circuit breaking, retries, caching, external authentication and authorization, transformation, service-mesh integration, and security.
- **Hybrid apps**: Gloo creates applications that route to backends implemented as microservices, serverless functions, and legacy apps. This feature can help users to gradually migrate from their legacy code to microservices and serverless; can let users add new functionalities using cloud-native technologies while maintaining their legacy codebase; can be used in cases where different teams in an organization choose different architectures; and more. See [here](https://www.solo.io/hybrid-app) for more on the Hybrid App paradigm.
## Using Gloo Edge
- **Kubernetes ingress controller**: Gloo Edge can function as a feature-rich ingress controller, built on top of the Envoy Proxy.
- **Next-generation API gateway** : Gloo Edge provides a long list of API gateway features, including rate limiting, circuit breaking, retries, caching, external authentication and authorization, transformation, service-mesh integration, and security.
- **Hybrid apps**: Gloo Edge creates applications that route to backends implemented as microservices, serverless functions, and legacy apps. This feature can help users to gradually migrate from their legacy code to microservices and serverless; can let users add new functionalities using cloud-native technologies while maintaining their legacy codebase; can be used in cases where different teams in an organization choose different architectures; and more. See [here](https://www.solo.io/hybrid-app) for more on the Hybrid App paradigm.


## What makes Gloo unique
- **Function-level routing allows integration of legacy applications, microservices and serverless**: Gloo can route requests directly to _functions_, which can be a serverless function call (e.g. Lambda, Google Cloud Function, OpenFaaS function, etc.), an API call on a microservice or a legacy service (e.g. a REST API call, OpenAPI operation, XML/SOAP request etc.), or publishing to a message queue (e.g. NATS, AMQP, etc.). This unique ability is what makes Gloo the only API gateway that supports hybrid apps, as well as the only one that does not tie the user to a specific paradigm.
- **Gloo incorporates vetted open-source projects to provide broad functionality**: Gloo support high-quality features by integrating with top open-source projects, including gRPC, GraphQL, OpenTracing, NATS and more. Gloo's architecture allows rapid integration of future popular open-source projects as they emerge.
- **Full automated discovery lets users move fast**: Upon launch, Gloo creates a catalog of all available destinations, and continuously maintains it up to date. This takes the responsibility for 'bookkeeping' away from the developers, and guarantees that new feature become available as soon as they are ready. Gloo discovers across IaaS, PaaS and FaaS providers, as well as Swagger, gRPC, and GraphQL.
- **Gloo integrates intimately with the user's environment**: with Gloo, users are free to choose their favorite tools for scheduling (such as K8s, Nomad, OpenShift, etc), persistence (K8s, Consul, etcd, etc) and security (K8s, Vault).
## What makes Gloo Edge unique
- **Function-level routing allows integration of legacy applications, microservices and serverless**: Gloo Edge can route requests directly to _functions_, which can be a serverless function call (e.g. Lambda, Google Cloud Function, OpenFaaS function, etc.), an API call on a microservice or a legacy service (e.g. a REST API call, OpenAPI operation, XML/SOAP request etc.), or publishing to a message queue (e.g. NATS, AMQP, etc.). This unique ability is what makes Gloo Edge the only API gateway that supports hybrid apps, as well as the only one that does not tie the user to a specific paradigm.
- **Gloo Edge incorporates vetted open-source projects to provide broad functionality**: Gloo Edge support high-quality features by integrating with top open-source projects, including gRPC, GraphQL, OpenTracing, NATS and more. Gloo Edge's architecture allows rapid integration of future popular open-source projects as they emerge.
- **Full automated discovery lets users move fast**: Upon launch, Gloo Edge creates a catalog of all available destinations, and continuously maintains it up to date. This takes the responsibility for 'bookkeeping' away from the developers, and guarantees that new feature become available as soon as they are ready. Gloo Edge discovers across IaaS, PaaS and FaaS providers, as well as Swagger, gRPC, and GraphQL.
- **Gloo Edge integrates intimately with the user's environment**: with Gloo Edge, users are free to choose their favorite tools for scheduling (such as K8s, Nomad, OpenShift, etc), persistence (K8s, Consul, etcd, etc) and security (K8s, Vault).


## Next Steps
Expand All @@ -46,9 +46,9 @@ Gloo is a feature-rich, Kubernetes-native ingress controller, and next-generatio

### Thanks

**Gloo** would not be possible without the valuable open-source work of projects in the community. We would like to extend a special thank-you to [Envoy](https://www.envoyproxy.io).
**Gloo Edge** would not be possible without the valuable open-source work of projects in the community. We would like to extend a special thank-you to [Envoy](https://www.envoyproxy.io).


# Security

*Reporting security issues:* We take Gloo's security very seriously. If you've found a security issue or a potential security issue in Gloo, please DO NOT file a public Github issue, instead send your report privately to [security@solo.io](mailto:security@solo.io).
*Reporting security issues:* We take Gloo Edge's security very seriously. If you've found a security issue or a potential security issue in Gloo Edge, please DO NOT file a public Github issue, instead send your report privately to [security@solo.io](mailto:security@solo.io).
2 changes: 1 addition & 1 deletion artifacts.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# For building Gloo artifacts with Valet
# For building Gloo Edge artifacts with Valet

# Make sure repo is clean (`git status` returns clean) and run:
# valet build -v $(git describe --tags)
Expand Down
4 changes: 2 additions & 2 deletions changelog/v0.18.0/summary.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
In Gloo 0.18.0, we added support for TCP proxying, which required a breaking change to the gateway API.
Please check out https://gloo.solo.io/operations/upgrading/0.18.1/ for details on how to seamlessly upgrade Gloo,
In Gloo Edge 0.18.0, we added support for TCP proxying, which required a breaking change to the gateway API.
Please check out https://gloo.solo.io/operations/upgrading/0.18.1/ for details on how to seamlessly upgrade Gloo Edge,
automatically convert existing configuration, and migrate traffic while avoiding downtime.
2 changes: 1 addition & 1 deletion changelog/v1.0.0-rc1/fix-generated-links-cp-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ changelog:
dependencyRepo: solo-kit
dependencyTag: v0.11.5
- type: FIX
description: Fix generated API field links in docs.solo.io/gloo/latest/.
description: Fix generated API field links in docs.solo.io/gloo-edge/latest/.
issueLink: https://github.com/solo-io/gloo/issues/1477
- type: NON_USER_FACING
description: Cherry-pick recent docs updates from solo-docs.
Expand Down
2 changes: 1 addition & 1 deletion changelog/v1.0.0-rc2/consolidate-legacy-docs-mgmt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ changelog:
- type: NON_USER_FACING
description: >
Include make targets for producing docs images from master/v0.20.x APIs
that can be hosted at docs.solo.io/gloo/latest/.
that can be hosted at docs.solo.io/gloo-edge/latest/.
2 changes: 1 addition & 1 deletion changelog/v1.3.6/gloo-mtls.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ changelog:
glooMtls:
enabled: true
```
For more information, check out the [corresponding documentation](https://docs.solo.io/gloo/latest/security/mtls/).
For more information, check out the [corresponding documentation](https://docs.solo.io/gloo-edge/latest/security/mtls/).
issueLink: https://github.com/solo-io/gloo/issues/2134
- type: FIX
description: Pin versions of base docker images for Gloo containers
Expand Down
2 changes: 1 addition & 1 deletion changelog/v1.3.8/sds-envoy-helm-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ changelog:
image:
tag: test
```
For more information, check out the [corresponding documentation](https://docs.solo.io/gloo/latest/security/mtls/).
For more information, check out the [corresponding documentation](https://docs.solo.io/gloo-edge/latest/security/mtls/).
issueLink: https://github.com/solo-io/gloo/issues/2134
2 changes: 1 addition & 1 deletion changelog/v1.5.0-beta19/healthcheck-secret-header.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changelog:
- type: NEW_FEATURE
description: Allow users to specify extra headers for health check requests as secrets. New gloo secret type "header", containing header name-value pairs, can now be created (details [here](https://docs.solo.io/gloo/latest/guides/traffic_management/request_processing/health_checks/)). Health checks can reference header secrets for additional headers to add in addition to specifying them explicitly.
description: Allow users to specify extra headers for health check requests as secrets. New gloo secret type "header", containing header name-value pairs, can now be created (details [here](https://docs.solo.io/gloo-edge/latest/guides/traffic_management/request_processing/health_checks/)). Health checks can reference header secrets for additional headers to add in addition to specifying them explicitly.
issueLink: https://github.com/solo-io/gloo/issues/2914
2 changes: 1 addition & 1 deletion changelog/v1.5.0-beta22/update-dev-portal-docs.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
changelog:
- type: NON_USER_FACING
description: >
Update the Dev Portal section of the Gloo docs to redirect users to the [new Dev Portal docs](https://docs.solo.io/dev-portal/latest).
Update the Dev Portal section of the Gloo docs to redirect users to the [new Dev Portal docs](https://docs.solo.io/gloo-portal/latest).
issueLink: https://github.com/solo-io/gloo/issues/3598
resolvesIssue: false
2 changes: 1 addition & 1 deletion changelog/v1.5.0-beta8/new_rate-limit-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ changelog:
The API allows users to apply policies by referencing a set of `RateLimitConfig`
resources on `VirtualHosts` and `Routes`. Each resource represents a rate limit policy
that will be independently enforced on the routing resource that references it.
Please see the [docs](https://docs.solo.io/gloo/latest/guides/security/rate_limiting/crds)
Please see the [docs](https://docs.solo.io/gloo-edge/latest/guides/security/rate_limiting/crds)
for a detailed explanation of the new API.
issueLink: https://github.com/solo-io/gloo/issues/3335
resolvesIssue: false
Expand Down
5 changes: 5 additions & 0 deletions changelog/v1.5.10/docs-rebranding.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
changelog:
- type: NON_USER_FACING
description: Update docs for rebranding of Gloo Platform
- type: NON_USER_FACING
description: Add 404.html page from latest docs so that firebase knows how to serve it.
4 changes: 2 additions & 2 deletions cloudbuild.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
steps:

# clones Gloo so it can be setup & tested
# All steps after this must set working directory to use the cloned Gloo source
# clones Gloo Edge so it can be setup & tested
# All steps after this must set working directory to use the cloned Gloo Edge source

# $COMMIT_SHA is a default gcloud env var, to run via cloudbuild submit use:
# gcloud builds submit --substitutions COMMIT_SHA=<commit sha>,REPO_NAME=solo-io/gloo --project solo-public
Expand Down
Loading

0 comments on commit c02c864

Please sign in to comment.