status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Adds redirects and updates links for learn.hashicorp (#4878) 

* Adds redirects for Getting Started pages

* Uses correct links to resources at learn.hashicorp

* Reconfigures "Learn more" links to point to learn.hashicorp

* Links to learn.hashicorp on segmentation page

* Adds redirect for sample config file

* Fixes links to Getting Started guide on learn.hashicorp

* Remove getting started guide which is now on learn.hashicorp

* Corrects link to `consul/io` which should go to `consul.io`

* Revert "Remove getting started guide which is now on learn.hashicorp"

This reverts commit 2cebacf402f83fb936718b41ac9a27415f4e9f21 so a placeholder
message can be written here while we are transitioning content to
learn.hashicorp

* Adding a new page for getting started to direct users to learn.

* Added a note at the being of each doc to notify users about the temporary repo change.

* Revert "Added a note at the being of each doc to notify users about the temporary repo change."

This reverts commit 9a2a8781f9705028e4f53f758ef235e74b2b7198.

From conversation at https://github.com/hashicorp/consul/pull/4878

* Removes redirect from sample web.json demo file

* Removed typo
This commit is contained in:
Geoffrey Grosenbach 2018-11-01 14:44:49 -07:00 committed by Jack Pearkes
parent f26f88071e
commit 3981c5d48c
11 changed files with 48 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
website/redirects.txt
View File

@ -38,3 +38,13 @@
/api.html /api/index.html
/docs/agent/http.html /api/index.html
/intro/getting-started/install.html https://learn.hashicorp.com/consul/getting-started/install.html
/intro/getting-started/agent.html https://learn.hashicorp.com/consul/getting-started/agent.html
/intro/getting-started/services.html https://learn.hashicorp.com/consul/getting-started/services.html
/intro/getting-started/connect.html https://learn.hashicorp.com/consul/getting-started/connect.html
/intro/getting-started/join.html https://learn.hashicorp.com/consul/getting-started/join.html
/intro/getting-started/checks.html https://learn.hashicorp.com/consul/getting-started/checks.html
/intro/getting-started/kv.html https://learn.hashicorp.com/consul/getting-started/kv.html
/intro/getting-started/ui.html https://learn.hashicorp.com/consul/getting-started/ui.html
/intro/getting-started/next-steps.html https://learn.hashicorp.com/consul/getting-started/next-steps.html

6
website/source/configuration.html.erb
View File

@ -17,7 +17,7 @@ description: |-
</svg>
Download
</a>
<a href="/intro/getting-started/kv.html" class="g-btn dark-outline">Explore Docs</a>
<a href="https://learn.hashicorp.com/consul/getting-started/kv.html" class="g-btn dark-outline">Explore Docs</a>
</div>
</section>
@ -66,7 +66,7 @@ description: |-
<h3>Key/Value Store</h3>
<p>Feature rich key/value store for dynamic service configuration data. Use it for feature flagging, maintenance modes, and more.</p>
<p>
<a class="learn-more" href='/intro/getting-started/kv.html'>Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/kv.html">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
</p>
</div>
</div>
@ -264,7 +264,7 @@ description: |-
</svg>
Download
</a>
<a href="/intro/getting-started/kv.html" class="g-btn white-outline">Explore docs</a>
<a href="https://learn.hashicorp.com/consul/getting-started/kv.html" class="g-btn white-outline">Explore docs</a>
</div>
</section>

12
website/source/discovery.html.erb
View File

@ -18,7 +18,7 @@ description: |-
</svg>
Download
</a>
<a href="/intro/getting-started/services.html" class="g-btn dark-outline">Explore Docs</a>
<a href="https://learn.hashicorp.com/consul/getting-started/services.html" class="g-btn dark-outline">Explore Docs</a>
</div>
</section>
@ -64,7 +64,7 @@ description: |-
<h3>Service Registry</h3>
<p>Consul provides a registry of all the running nodes and services, along with their current health status. This allows operators to understand the environment, and applications and automation tools to interact with dynamic infrastructure using an HTTP API.</p>
<p>
<a class="learn-more" href='/intro/getting-started/services.html'>Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/services.html">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
</p>
</div>
</div>
@ -93,7 +93,7 @@ description: |-
<h3>DNS Query Interface</h3>
<p>Consul enables service discovery using a built-in DNS server. This allows existing applications to easily integrate, as almost all applications support using DNS to resolve IP addresses. Using DNS instead of a static IP address allows services to scale up/down and route around failures easily.</p>
<p>
<a class="learn-more" href='/intro/getting-started/services.html#querying-services'>Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/services.html#querying-services">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
</p>
</div>
</div>
@ -130,7 +130,7 @@ web-frontend.service.consul. 0 IN A <code class='keyword'>10.0.1.109</code></cod
<h3>HTTP API with Edge Triggers</h3>
<p>Consul provides an HTTP API to query the service registry for nodes, services, and health check information. The API also supports blocking queries, or long-polling for any changes. This allows automation tools to react to services being registered or health status changes to change configurations or traffic routing in real time.</p>
<p>
<a class="learn-more" href='/intro/getting-started/services.html#http-api'>Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/services.html#http-api">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
</p>
</div>
</div>
@ -211,7 +211,7 @@ $ curl http://localhost:8500/v1/catalog/nodes?<code class='keyword'>dc=dc2</code
<h3>Health Checks</h3>
<p>Pairing service discovery with health checking prevents routing requests to unhealthy hosts and enables services to easily provide circuit breakers.</p>
<p>
<a class="learn-more" href='/intro/getting-started/checks.html'>Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
<a class="learn-more" href="https://learn.hashicorp.com/consul/getting-started/checks.html">Learn more<svg xmlns="http://www.w3.org/2000/svg" width="6" height="10" viewBox="0 0 6 10"><g fill="none" fill-rule="evenodd" transform="translate(-6 -3)"><mask id="a" fill="#fff"><path d="M7.138 3.529a.666.666 0 1 0-.942.942l3.528 3.53-3.529 3.528a.666.666 0 1 0 .943.943l4-4a.666.666 0 0 0 0-.943l-4-4z"/></mask><g fill="#1563FF" mask="url(#a)"><path d="M0 0h16v16H0z"/></g></g></svg></a>
</p>
</div>
</div>
@ -285,7 +285,7 @@ $ curl http://localhost:8500/v1/catalog/nodes?<code class='keyword'>dc=dc2</code
</svg>
Download
</a>
<a href="/intro/getting-started/services.html" class="g-btn white-outline">Explore docs</a>
<a href="https://learn.hashicorp.com/consul/getting-started/services.html" class="g-btn white-outline">Explore docs</a>
</div>
</section>

3
website/source/docs/connect/index.html.md
View File

@ -73,7 +73,7 @@ in microseconds.
There are several ways to try Connect in different environments.
* The [Connect introduction](/intro/getting-started/connect.html) in the
* The [Connect introduction](https://learn.hashicorp.com/consul/getting-started/connect.html) in the
Getting Started guide provides a simple walk through of getting two services
to communicate via Connect using only Consul directly on your local machine.
@ -135,4 +135,3 @@ Multi-datacenter support for Connect is under development and will be
released as a feature of Consul Enterprise in late 2018. This feature will
facilitate intention replication, datacenter constraints on intentions,
CA state replication, multi-datacenter certificate rotations, and more.

10
website/source/docs/guides/connect-production.md
View File

@ -10,7 +10,7 @@ description: |-
Consul Connect can secure all inter-service communication via mutual TLS. It's
designed to work with [minimal configuration out of the
box](/intro/getting-started/connect.html), but completing the [security
box](https://learn.hashicorp.com/consul/getting-started/connect.html), but completing the [security
checklist](/docs/connect/security.html) and understanding the [Consul security
model](/docs/internals/security.html) are prerequisites for production
deployments.
@ -104,10 +104,10 @@ Vault](https://www.vaultproject.io/docs/secrets/consul/index.html).
Consul's gossip (UDP) and RPC (TCP) communications need to be encrypted
otherwise attackers may be able to see ACL tokens while in flight
between the server and client agents (RPC) or between client agent and
application (HTTP). Certificate private keys never leave the host they
are used on but are delivered to the application or proxy over local
HTTP so local agent traffic should be encrypted where potentially
between the server and client agents (RPC) or between client agent and
application (HTTP). Certificate private keys never leave the host they
are used on but are delivered to the application or proxy over local
HTTP so local agent traffic should be encrypted where potentially
untrusted parties might be able to observe localhost agent API traffic.
Follow the [encryption documentation](/docs/agent/encryption.html) to ensure

2
website/source/docs/upgrade-specific.html.md
View File

@ -102,7 +102,7 @@ All of Consul's previously deprecated command line flags and config options have
| `-retry-join-gce-tag-name` | [`-retry-join`](/docs/agent/options.html#google-compute-engine) |
| `-retry-join-gce-zone-pattern` | [`-retry-join`](/docs/agent/options.html#google-compute-engine) |
| `addresses.rpc` | None, the RPC server for CLI commands is no longer supported. |
| `advertise_addrs` | [`ports`](/docs/agent/options.html#ports) with [`advertise_addr`](https://www.consul/io/docs/agent/options.html#advertise_addr) and/or [`advertise_addr_wan`](/docs/agent/options.html#advertise_addr_wan) |
| `advertise_addrs` | [`ports`](/docs/agent/options.html#ports) with [`advertise_addr`](https://www.consul.io/docs/agent/options.html#advertise_addr) and/or [`advertise_addr_wan`](/docs/agent/options.html#advertise_addr_wan) |
| `dogstatsd_addr` | [`telemetry.dogstatsd_addr`](/docs/agent/options.html#telemetry-dogstatsd_addr) |
| `dogstatsd_tags` | [`telemetry.dogstatsd_tags`](/docs/agent/options.html#telemetry-dogstatsd_tags) |
| `http_api_response_headers` | [`http_config.response_headers`](/docs/agent/options.html#response_headers) |

4
website/source/index.html.erb
View File

@ -22,7 +22,7 @@ description: |-
</svg>
Download
</a>
<a href='/intro/getting-started/install.html' class='g-btn dark-outline'>Get Started</a>
<a href="https://learn.hashicorp.com/consul/getting-started/install.html" class='g-btn dark-outline'>Get Started</a>
<div>
<a href='https://demo.consul.io/' class='secondary-link'>View demo of web UI</a>
</div>
@ -298,4 +298,4 @@ description: |-
<% content_for :scripts do %>
<script src='/assets/javascripts/consul-connect/home-hero.js' defer></script>
<% end %>
<% end %>

14
website/source/intro/getting-started.html.md Normal file
View File

@ -0,0 +1,14 @@
---
layout: "intro"
page_title: "Getting Started"
sidebar_current: "start"
description: |-
Welcome to the intro guide to Consul! This guide is the best place to start with Consul.
---
# Getting Started
The Getting Started guides will help you learn the basics of using Consul. They will walk you through how to set up a local development instance of Consul to practice running an agent, starting a service, and using Connect. Then you will set up a couple Consul servers and connect them to make a small cluster.
After completing the guides, you will be familiar with all three of Consul’s use cases, service discovery, service configuration, and service segmentation. Continue to the Getting Started guides on our learning platform [learn.hashicorp.com](https://learn.hashicorp.com/consul).

2
website/source/intro/index.html.md
View File

@ -86,5 +86,5 @@ forward the request to the remote datacenter and return the result.
* See [how Consul compares to other software](/intro/vs/index.html) to assess how it fits into your
existing infrastructure.
* Continue onwards with the [getting started guide](/intro/getting-started/install.html)
* Continue onwards with the [getting started guide](https://learn.hashicorp.com/consul/getting-started/install.html)
to get Consul up and running.

33
website/source/layouts/intro.erb
View File

@ -41,37 +41,8 @@
</ul>
</li>
<li<%= sidebar_current("gettingstarted") %>>
<a href="/intro/getting-started/install.html">Getting Started</a>
<ul class="nav">
<li<%= sidebar_current("gettingstarted-install") %>>
<a href="/intro/getting-started/install.html">Install Consul</a>
</li>
<li<%= sidebar_current("gettingstarted-agent") %>>
<a href="/intro/getting-started/agent.html">Run the Agent</a>
</li>
<li<%= sidebar_current("gettingstarted-services") %>>
<a href="/intro/getting-started/services.html">Services</a>
</li>
<li<%= sidebar_current("gettingstarted-connect") %>>
<a href="/intro/getting-started/connect.html">Connect</a>
</li>
<li<%= sidebar_current("gettingstarted-join") %>>
<a href="/intro/getting-started/join.html">Consul Cluster</a>
</li>
<li<%= sidebar_current("gettingstarted-checks") %>>
<a href="/intro/getting-started/checks.html">Health Checks</a>
</li>
<li<%= sidebar_current("gettingstarted-kv") %>>
<a href="/intro/getting-started/kv.html">KV Data</a>
</li>
<li<%= sidebar_current("gettingstarted-ui") %>>
<a href="/intro/getting-started/ui.html">Web UI</a>
</li>
<li<%= sidebar_current("gettingstarted-nextsteps") %>>
<a href="/intro/getting-started/next-steps.html">Next Steps</a>
</li>
</ul>
<li<%= sidebar_current("start") %>>
<a href="/intro/getting-started.html">Getting Started</a>
</li>
</ul>
<% end %>

6
website/source/segmentation.html.erb
View File

@ -18,7 +18,7 @@ description: |-
</svg>
Download
</a>
<a href="/docs/connect/index.html" class="g-btn dark-outline">Explore Docs</a>
<a href="https://learn.hashicorp.com/consul/getting-started/connect.html" class="g-btn dark-outline">Explore Docs</a>
</div>
</section>
@ -194,13 +194,13 @@ Secure Sockets Layer
<section class='g-section g-cta-section'>
<div>
<h2>Ready to get started?</h2>
<a href="/intro/getting-started/connect.html" class="g-btn white download">
<a href="/downloads.html" class="g-btn white download">
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="22" viewBox="0 0 20 22">
<path d="M9.292 15.706a1 1 0 0 0 1.416 0l3.999-3.999a1 1 0 1 0-1.414-1.414L11 12.586V1a1 1 0 1 0-2 0v11.586l-2.293-2.293a1 1 0 1 0-1.414 1.414l3.999 3.999zM20 16v3c0 1.654-1.346 3-3 3H3c-1.654 0-3-1.346-3-3v-3a1 1 0 1 1 2 0v3c0 .551.448 1 1 1h14c.552 0 1-.449 1-1v-3a1 1 0 1 1 2 0z"/>
</svg>
Download
</a>
<a href="/docs/connect/index.html" class="g-btn white-outline">Explore docs</a>
<a href="https://learn.hashicorp.com/consul/getting-started/connect.html" class="g-btn white-outline">Explore docs</a>
</div>
</section>