Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v1.14.x] Docs - Rebrand Gloo Edge #9792

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions changelog/v1.14.32/docs-rebrand.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
changelog:
- type: NON_USER_FACING
issueLink: https://github.com/solo-io/docs/issues/404
description: >-
Rebrands Gloo Edge to Gloo Gateway.
Updates logo.
Bumps versions.
skipCI-kube-tests:false
16 changes: 8 additions & 8 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
weight: 99
title: Gloo Edge
title: Gloo Gateway
---

# An Envoy-Powered API Gateway


## What is Gloo Edge
## What is Gloo Gateway

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.
Gloo Gateway is a feature-rich, Kubernetes-native ingress controller, and next-generation API gateway. Gloo Gateway 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 Gateway is uniquely designed to support hybrid applications, in which multiple technologies, architectures, protocols, and clouds can coexist.

![Gloo Edge Architecture]({{% versioned_link_path fromRoot="/img/gloo-architecture-envoys.png" %}})
![Gloo Gateway Architecture]({{% versioned_link_path fromRoot="/img/gloo-architecture-envoys.png" %}})

## Next Generation API Gateway

Although the idea of the [API Gateway](https://www.solo.io/solutions/api-gateway/) has been around for a bit, [the role of the API Gateway is going through an identity crisis](https://www.solo.io/blog/api-gateway-identity-crisis/) as we adopt more automated, self-service, platforms like Kubernetes, Cloud Foundry, and public-cloud. Your existing API Management solutions weren't built for highly dynamic environments like Kubernetes and require a lot of additional infrastructure to keep up, be highly-available, and production ready. Additionally, a lot of organizations have deployed these pieces of infrastructure in a highly centralized way that plays to the assumptions of the solution and not the desires of the the organization.

When we say Gloo Edge is a "next-generation" gateway, we mean that it was purpose-built for a highly dynamic, ephemeral environment like Kubernetes (or other workload orchestration platforms) and is built with the assumption of decentralized ownership. Gloo Edge can provide powerful API Gateway functionality for both existing, on-premises investments (like VM deployments or physical hardware), as well as Kubernetes, and even including forward-leaning compute options like Function as a Service. Legacy API Management vendors would have to completely re-write their solutions to play nicely in this new cloud-native world.
When we say Gloo Gateway is a "next-generation" gateway, we mean that it was purpose-built for a highly dynamic, ephemeral environment like Kubernetes (or other workload orchestration platforms) and is built with the assumption of decentralized ownership. Gloo Gateway can provide powerful API Gateway functionality for both existing, on-premises investments (like VM deployments or physical hardware), as well as Kubernetes, and even including forward-leaning compute options like Function as a Service. Legacy API Management vendors would have to completely re-write their solutions to play nicely in this new cloud-native world.

---

## Getting to know Gloo Edge
## Getting to know Gloo Gateway

* [**Getting Started**]({{% versioned_link_path fromRoot="/getting_started/" %}})
* [**Installation**]({{% versioned_link_path fromRoot="/installation" %}})
Expand All @@ -32,7 +32,7 @@ When we say Gloo Edge is a "next-generation" gateway, we mean that it was purpos
## Blogs & Demos

* [Blog Articles](https://www.solo.io/blog/announcing-gloo-the-function-gateway/)
* [Watch Gloo Edge Videos and Demos](https://www.youtube.com/watch?v=HEN8IHCOqSo&list=PLBOtlFtGznBgrbLwyrPNIsdXLuq-mqa6U)
* [Watch Gloo Gateway Videos and Demos](https://www.youtube.com/watch?v=HEN8IHCOqSo&list=PLBOtlFtGznBgrbLwyrPNIsdXLuq-mqa6U)

## Community

Expand All @@ -44,4 +44,4 @@ When we say Gloo Edge is a "next-generation" gateway, we mean that it was purpos

## Thanks

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).
Gloo Gateway 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).
12 changes: 6 additions & 6 deletions docs/content/contributing/_index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
title: "Contributing"
menuTitle: Contributing
description: How to contribute to Gloo Edge.
description: How to contribute to Gloo Gateway.
weight: 150
---

There are several ways to get involved with Gloo Edge as a developer.
There are several ways to get involved with Gloo Gateway as a developer.

## Working on Gloo Edge OSS
## Working on Gloo Gateway OSS

You can help us improve and extend Gloo Edge itself by helping with bug fixes and open issues. You can also assist with feature development and major changes. Please take a moment and read through the [development contributing doc]({{< versioned_link_path fromRoot="/contributing/developers/" >}}) for more information on how to get started.
You can help us improve and extend Gloo Gateway itself by helping with bug fixes and open issues. You can also assist with feature development and major changes. Please take a moment and read through the [development contributing doc]({{< versioned_link_path fromRoot="/contributing/developers/" >}}) for more information on how to get started.

* Help with bug fixes and open issues
* Assist with feature development

## Extend Gloo Edge's functionality
## Extend Gloo Gateway's functionality

We have put together a set of development guides to get started on extending and improving Gloo Edge through the addition of new plugins. Checkout out the [introductory doc]({{< versioned_link_path fromRoot="/guides/dev/" >}}) in the developer guides for more information on getting going.
We have put together a set of development guides to get started on extending and improving Gloo Gateway through the addition of new plugins. Checkout out the [introductory doc]({{< versioned_link_path fromRoot="/guides/dev/" >}}) in the developer guides for more information on getting going.

## Improve the documentation

Expand Down
10 changes: 5 additions & 5 deletions docs/content/contributing/developers/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Developers
menuTitle: Developers
description: Ways to contribute to Gloo Edge.
description: Ways to contribute to Gloo Gateway.
weight: 10
---

Excited about Gloo Edge and want to help make it better?
Excited about Gloo Gateway 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 @@ -27,7 +27,7 @@ If you encounter a bug, please file an issue on GitHub. If an issue you have is

### Improving the documentation

[Improving the documentation]({{< versioned_link_path fromRoot="/contributing/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!
[Improving the documentation]({{< versioned_link_path fromRoot="/contributing/documentation/" >}}), adding examples or use cases can be the easiest way to contribute to Gloo Gateway. If you see a piece of content that can be better, open a PR with an improvement, it doesn't matter how small!

### Small bug fixes

Expand All @@ -51,9 +51,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 Edge is reviewed by at least one Solo team member familiar with that codebase.
It’s important that every piece of code in Gloo Gateway is reviewed by at least one Solo team member familiar with that codebase.

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).
1. **Changelog** Every PR in Gloo Gateway 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
36 changes: 18 additions & 18 deletions docs/content/contributing/documentation/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Contributing to the Gloo Edge Documentation
title: Contributing to the Gloo Gateway Documentation
menuTitle: Documentation
weight: 20
description: Read this guide to help make Gloo Edge docs the best they can be!
description: Read this guide to help make Gloo Gateway docs the best they can be!
---

Hi! So you'd like to help us out with the Gloo Edge documentation. That is awesome! Before you get started, we have a couple things to mention about contributing standards and process. We'd like to make this easy as possible, so if you have a tiny edit to make, check out the [Quickstart](#quickstart) section of the guide. Otherwise, here are the ways you can get involved:
Hi! So you'd like to help us out with the Gloo Gateway documentation. That is awesome! Before you get started, we have a couple things to mention about contributing standards and process. We'd like to make this easy as possible, so if you have a tiny edit to make, check out the [Quickstart](#quickstart) section of the guide. Otherwise, here are the ways you can get involved:

* Log documentation issues
* Correct some minor errors on a page
Expand All @@ -15,7 +15,7 @@ Hi! So you'd like to help us out with the Gloo Edge documentation. That is aweso

## Background

The Gloo Edge docs live in the `docs/content` directory of the Gloo Edge GitHub repository. The docs are written in Markdown and rendered to a static site using [Hugo](https://gohugo.io/). The docs make use of *shortcodes* from Hugo and some custom shortcodes that are part of a solo-io theme stored in [this repository](https://github.com/solo-io/hugo-theme-soloio). Shortcodes are a way to render custom HTML on a page without injecting that HTML directly into Markdown.
The Gloo Gateway docs live in the `docs/content` directory of the Gloo Gateway GitHub repository. The docs are written in Markdown and rendered to a static site using [Hugo](https://gohugo.io/). The docs make use of *shortcodes* from Hugo and some custom shortcodes that are part of a solo-io theme stored in [this repository](https://github.com/solo-io/hugo-theme-soloio). Shortcodes are a way to render custom HTML on a page without injecting that HTML directly into Markdown.

The docs website can be rendered locally for updates and testing by using Hugo and `make`. There are some software prerequisites that need to be fulfilled in order to render and view the site successfully. More information can be found in the **[Install prerequisite software]({{< versioned_link_path fromRoot="/contributing/documentation/editing_locally/#install-prerequisite-software" >}})** section of the Editing Locally guide.

Expand All @@ -25,43 +25,43 @@ For minor changes and edits, it is not necessary to clone the repository and ren

## Log an issue

The simplest way to get involved with docs is by submitting an issue when you see something that needs to be changed. It could be a grammatical error, an unclear statement, or a suggestion for a new document or example. If you see something that should be amended or improved, head on over to the Gloo Edge GitHub repository and follow the [steps in the Quickstart](#log-an-issue-on-the-main-gloo-edge-repository) for logging an issue.
The simplest way to get involved with docs is by submitting an issue when you see something that needs to be changed. It could be a grammatical error, an unclear statement, or a suggestion for a new document or example. If you see something that should be amended or improved, head on over to the Gloo Gateway GitHub repository and follow the [steps in the Quickstart](#log-an-issue-on-the-main-gloo-edge-repository) for logging an issue.

---

## Quickstart

While it is possible to clone the entire Gloo Edge repository, make changes to the documentation, render it locally to validate, and then submit a PR; that's a lot of work. For minor edits and small improvements, it is much simpler to edit the docs directly on GitHub and submit a pull request. Here is the quickstart process:
While it is possible to clone the entire Gloo Gateway repository, make changes to the documentation, render it locally to validate, and then submit a PR; that's a lot of work. For minor edits and small improvements, it is much simpler to edit the docs directly on GitHub and submit a pull request. Here is the quickstart process:

1. Log an issue on the main Gloo Edge repository
2. Fork the Gloo Edge repository to your own account
1. Log an issue on the main Gloo Gateway repository
2. Fork the Gloo Gateway repository to your own account
3. Make the update and commit it
4. Create a pull request to merge the change

Once the PR has been submitted, someone from solo.io will review the change and either approve it or ask for more information. See below for an example of creating and submitting a change.

### Log an issue on the main Gloo Edge repository
### Log an issue on the main Gloo Gateway repository

In this step you will log an issue on the Gloo Edge GitHub repository so that others know you are working on a fix. You can also simply log an issue with the documentation to let others know about the problem.
In this step you will log an issue on the Gloo Gateway GitHub repository so that others know you are working on a fix. You can also simply log an issue with the documentation to let others know about the problem.

* On the Gloo Edge repository, go to the **Issues** tab and click on the **New Issue** button.
* On the Gloo Gateway repository, go to the **Issues** tab and click on the **New Issue** button.
* Click on **Get started** for a Bug report.
* Add the label **Area: Docs** to the Bug report
* Fill out the form with the issue you found in the docs and what changes you plan to make
* Click on **Submit new issue**

### Fork the Gloo Edge repository to your own account
### Fork the Gloo Gateway repository to your own account

In this step you will fork the Gloo Edge repository into your own account. This step assumes that you already have a GitHub account. More information on forking a repository can be found on [GitHub's website](https://guides.github.com/activities/forking/).
In this step you will fork the Gloo Gateway repository into your own account. This step assumes that you already have a GitHub account. More information on forking a repository can be found on [GitHub's website](https://guides.github.com/activities/forking/).

* On the Gloo Edge repository, click on the **Fork** button at the top of the screen
* On the Gloo Gateway repository, click on the **Fork** button at the top of the screen
* Select your account as a destination for the fork

After a few moments the fork will complete and you will be taken to the page with your fork of the Gloo Edge repository. Now you can make edits and submit a PR.
After a few moments the fork will complete and you will be taken to the page with your fork of the Gloo Gateway repository. Now you can make edits and submit a PR.

### Make the update and commit it

In this step you will make the actual change to the document that has an issue. From the forked repository, select the branch you want to make changes to. The current branch being used to generate the Gloo Edge docs is `master`. The files that make up the docs website are in `docs/content`, and the directory structure follows the menu structure of the docs site.
In this step you will make the actual change to the document that has an issue. From the forked repository, select the branch you want to make changes to. The current branch being used to generate the Gloo Gateway docs is `master`. The files that make up the docs website are in `docs/content`, and the directory structure follows the menu structure of the docs site.

* Select the correct branch to edit (`master`)
* Find the file you want to edit and click the **pencil** icon
Expand All @@ -74,10 +74,10 @@ The change has been committed to a new branch on your forked repository.

### Create a pull request to merge the change

Now that the change has been committed to your fork of the Gloo Edge repository, it's time to submit a pull request to merge the change into the official Gloo Edge repository.
Now that the change has been committed to your fork of the Gloo Gateway repository, it's time to submit a pull request to merge the change into the official Gloo Gateway repository.

* Go back to the main page of your forked repository and click on **New pull request**
* Select the proper branch for the Gloo Edge repository (`master`) and the branch you just created
* Select the proper branch for the Gloo Gateway repository (`master`) and the branch you just created
* Click on **Create pull request**
* Fill out the comment field with the changes made and reference the Issue created earlier
* Select the label **Area: Docs**
Expand Down
Loading
Loading