Skip to content

Commit c482f09

Browse files
authored
Restructure quickstart section (#529)
There is no need to know about older versions of Fluentd or td-agent, so move it from quickstart section. It is still useful for migration, so keep it as appendix section. NOTE: v1.18.0 still points to ruby 2.7. In a sooner or later, it will be bumped up to 3.2 in v1.19.0. Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
1 parent 1aec8e7 commit c482f09

File tree

6 files changed

+21
-11
lines changed

6 files changed

+21
-11
lines changed

.gitbook.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ redirects:
99

1010
# Overview
1111
v1.0/articles/support: overview/support.md
12-
v1.0/articles/update-from-v0.12: overview/update-from-v0.12.md
12+
v1.0/articles/update-from-v0.12: appendix/update-from-v0.12.md
1313
v1.0/articles/life-of-a-fluentd-event: overview/life-of-a-fluentd-event.md
1414
v1.0/articles/logo: overview/logo.md
1515
v1.0/articles/faq: overview/faq.md
16-
v1.0/articles/td-agent-v2-vs-v3: overview/td-agent-v2-vs-v3-vs-v4.md
17-
v1.0/articles/fluent-package-v5-vs-td-agent-v4: overview/fluent-package-v5-vs-td-agent.md
18-
quickstart/td-agent-v2-vs-v3: overview/td-agent-v2-vs-v3-vs-v4.md
16+
v1.0/articles/td-agent-v2-vs-v3: appendix/td-agent-v2-vs-v3-vs-v4.md
17+
v1.0/articles/fluent-package-v5-vs-td-agent-v4: quickstart/fluent-package-v5-vs-td-agent.md
18+
quickstart/td-agent-v2-vs-v3: appendix/td-agent-v2-vs-v3-vs-v4.md
1919

2020
# Install
2121
v1.0/articles/install-by-dmg: install/install-by-dmg.md

SUMMARY.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
* [Introduction](README.md)
44
* [Overview](quickstart/README.md)
55
* [Life of a Fluentd event](quickstart/life-of-a-fluentd-event.md)
6-
* [Update from v0.12 to v1](quickstart/update-from-v0.12.md)
76
* [Support](quickstart/support.md)
87
* [FAQ](quickstart/faq.md)
98
* [Logo](quickstart/logo.md)
10-
* [td-agent v2 vs v3 vs v4](quickstart/td-agent-v2-vs-v3-vs-v4.md)
119
* [fluent-package v5 vs td-agent v4](quickstart/fluent-package-v5-vs-td-agent.md)
1210
* [Installation](installation/README.md)
1311
* [Before Installation](installation/before-install.md)
@@ -197,4 +195,7 @@
197195
* [Plugin Helper: Http Server](plugin-helper-overview/api-plugin-helper-http_server.md)
198196
* [Plugin Helper: Service Discovery](plugin-helper-overview/api-plugin-helper-service_discovery.md)
199197
* [Troubleshooting Guide](troubleshooting-guide.md)
198+
* [Appendix](appendix/README.md)
199+
* [Update from v0.12 to v1](appendix/update-from-v0.12.md)
200+
* [td-agent v2 vs v3 vs v4](appendix/td-agent-v2-vs-v3-vs-v4.md)
200201

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# td-agent v2 vs v3 vs v4
22

3+
{% hint style='danger' %}
4+
The series of td-agent had already reached End of Life (EOL). td-agent should not be newly installed because no support, no new release and no security updates anymore.
5+
{% endhint %}
6+
37
## Supported Platforms
48

59
[ClearCode, Inc.](https://www.clear-code.com) maintains stable packages for Fluentd and canonical plugins as Treasure Agent \(the package is called `td-agent`\). `td-agent` has v2, v3 and v4. [Chronosphere](https://chronosphere.io/) (formerly Calyptia) maintains stable packages as Calyptia-fluentd as another option. Supported OS is the same as td-agent v4 currently.
@@ -49,10 +53,10 @@ This is for v0.12 and old distribution users. We don't recommend this version fo
4953

5054
## How to Install
5155

52-
* [Ubuntu/Debian](../installation/install-by-deb.md)
53-
* [RedHat/CentOS](../installation/install-by-rpm.md)
54-
* [Windows](../installation/install-by-msi.md)
55-
* [macOS](../installation/install-by-dmg.md)
56+
* [Ubuntu/Debian](../installation/install-by-deb-td-agent-v4.md)
57+
* [RedHat/CentOS](../installation/install-by-rpm-td-agent-v4.md)
58+
* [Windows](../installation/install-by-msi-td-agent-v4.md)
59+
* [macOS](../installation/install-by-dmg-td-agent-v4.md)
5660
* [RubyGems](../installation/install-by-gem.md)
5761

5862
If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](http://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under under [the Apache License 2.0.](https://www.apache.org/licenses/LICENSE-2.0)
File renamed without changes.

installation/install-by-gem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Please follow the [Pre-installation Guide](before-install.md) to configure your
88

99
## Step 1: Install Ruby Interpreter
1010

11-
Install Ruby `>= 2.4` on your local environment. In addition, install `ruby-dev` package via Package Manager to build native extension gems.
11+
Install Ruby `>= 2.7` on your local environment. In addition, install `ruby-dev` package via Package Manager to build native extension gems.
1212

1313
## Step 2: Install Fluentd Gem
1414

quickstart/fluent-package-v5-vs-td-agent.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# fluent-package v5 vs td-agent v4
22

3+
{% hint style='danger' %}
4+
The series of td-agent had already reached End of Life (EOL). td-agent should not be newly installed because of no support, no new release and no security updates anymore.
5+
Use fluent-package instead!
6+
{% endhint %}
7+
38
## Supported Platforms
49

510
[Fluentd Project](https://www.fluentd.org) maintains stable packages for Fluentd and canonical plugins as Fluent Package \(the package is called `fluent-package`\)

0 commit comments

Comments
 (0)