Skip to content

Commit 67b4366

Browse files
AlexanderWertAlexanderWert
committed
Introduced Jekyll for docs rendering
Signed-off-by: Alexander Wert <[email protected]>
1 parent 8d98c6e commit 67b4366

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+844
-212
lines changed

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
docs/_site
2+
docs/.sass-cache
3+
docs/.jekyll-cache
4+
docs/.jekyll-metadata
5+
docs/vendor
6+
docs/Gemfile.lock

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Each EDOT distribution is asssembled with carefully curated OpenTelemetry compon
1313

1414
| EDOT Distribution | Status |
1515
|-------------------|---------------|
16-
| [EDOT Collector](docs/EDOT-collector/README.md) | Technical Preview |
16+
| [EDOT Collector](docs/_edot-collector/README.md) | Technical Preview |
1717
| [EDOT Java](https://github.com/elastic/elastic-otel-java) | GA |
1818
| [EDOT Python](https://github.com/elastic/elastic-otel-python) | Technical Preview |
1919
| [EDOT Node.js](https://github.com/elastic/elastic-otel-node) | Technical Preview |

‎docs/404.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
permalink: /404.html
3+
layout: page
4+
---
5+
6+
<style type="text/css" media="screen">
7+
.container {
8+
margin: 10px auto;
9+
max-width: 600px;
10+
text-align: center;
11+
}
12+
h1 {
13+
margin: 30px 0;
14+
font-size: 4em;
15+
line-height: 1;
16+
letter-spacing: -1px;
17+
}
18+
</style>
19+
20+
<div class="container">
21+
<h1>404</h1>
22+
23+
<p><strong>Page not found :(</strong></p>
24+
<p>The requested page could not be found.</p>
25+
</div>

‎docs/Gemfile‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
gem "jekyll", "~> 3.10.0"
11+
12+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
13+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
14+
gem "github-pages", "~> 232", group: :jekyll_plugins
15+
# If you have any plugins, put them here!
16+
group :jekyll_plugins do
17+
gem "just-the-docs"
18+
end
19+
20+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
21+
# and associated library.
22+
platforms :mingw, :x64_mingw, :mswin, :jruby do
23+
gem "tzinfo", ">= 1", "< 3"
24+
gem "tzinfo-data"
25+
end
26+
27+
# Performance-booster for watching directories on Windows
28+
gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin]
29+
30+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
31+
# do not have a Java counterpart.
32+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

‎docs/_config.yml‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your whole blog, values
4+
# which you are expected to set up once and rarely edit after that. If you find
5+
# yourself editing this file very often, consider using Jekyll's data files
6+
# feature for the data you need to update frequently.
7+
#
8+
# For technical reasons, this file is *NOT* reloaded automatically when you use
9+
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
10+
#
11+
# If you need help with YAML syntax, here are some quick references for you:
12+
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
13+
# https://learnxinyminutes.com/docs/yaml/
14+
#
15+
# Site settings
16+
# These are used to personalize your new site. If you look in the HTML files,
17+
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
18+
# You can create any custom variable you would like, and they will be accessible
19+
# in the templates via {{ site.myvariable }}.
20+
21+
title: EDOT
22+
description: >-
23+
Elastic Distributions of OpenTelemetry is an open-source ecosystem of tailored OpenTelemetry distributions,
24+
comprising an OpenTelemetry Collector and various OpenTelemetry Language SDKs.
25+
Each EDOT distribution is asssembled with carefully curated OpenTelemetry components,
26+
then rigorously tested to ensure production readiness.
27+
This provides a reliable and optimized OpenTelemetry experience with Elastic,
28+
enabling seamless adoption with confidence and expert support.
29+
baseurl: "" # the subpath of your site, e.g. /blog
30+
url: "https://elastic.github.io/opentelemetry/" # the base hostname & protocol for your site, e.g. http://example.com
31+
logo: /images/edot.png
32+
favicon_ico: "/images/favicon.ico"
33+
34+
# Build settings
35+
theme: just-the-docs
36+
37+
color_scheme: elastic
38+
39+
collections:
40+
edot-collector:
41+
output: true
42+
edot-sdks:
43+
output: true
44+
kubernetes:
45+
output: true
46+
47+
callouts:
48+
note:
49+
title: "Note"
50+
color: el_green
51+
warning:
52+
title: "Warning"
53+
color: yellow
54+
55+
just_the_docs:
56+
collections:
57+
edot-collector:
58+
name: EDOT Collector
59+
nav_fold: true
60+
edot-sdks:
61+
name: EDOT SDKs
62+
nav_fold: true
63+
kubernetes:
64+
name: Kubernetes
65+
nav_fold: true
66+
nav_sort: case_insensitive
67+
68+
69+
70+
# Exclude from processing.
71+
# The following items will not be processed, by default.
72+
# Any item listed under the `exclude:` key here will be automatically added to
73+
# the internal "default list".
74+
#
75+
# Excluded items can be processed by explicitly listing the directories or
76+
# their entries' file path in the `include:` list.
77+
#
78+
# exclude:
79+
# - .sass-cache/
80+
# - .jekyll-cache/
81+
# - gemfiles/
82+
# - Gemfile
83+
# - Gemfile.lock
84+
# - node_modules/
85+
# - vendor/bundle/
86+
# - vendor/cache/
87+
# - vendor/gems/
88+
# - vendor/ruby/

docs/EDOT-collector/configure-upstream-collector.md renamed to docs/_edot-collector/configure-upstream-collector.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Customization
3+
layout: default
4+
nav_order: 5
5+
---
6+
17
# Build a custom collector or configure the OpenTelemetry Collector Contrib distribution
28

39
You can build and configure a [custom collector](https://opentelemetry.io/docs/collector/custom-collector/) or extend the [OpenTelemetry Collector Contrib ](https://github.com/open-telemetry/opentelemetry-collector-contrib) distribution to collect logs and metrics and send them to Elastic Observability.

‎docs/_edot-collector/download.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Download
3+
layout: default
4+
nav_order: 2
5+
---
6+
7+
# Download
8+
9+
TODO

docs/EDOT-collector/edot-collector-config.md renamed to docs/_edot-collector/edot-collector-config.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1+
---
2+
title: Configuration
3+
layout: default
4+
nav_order: 3
5+
---
6+
17
## Collector Configuration
28

39
The EDOT Collector uses a YAML-based configuration file. Below is a sample configuration:
410

11+
```
512
hostmetrics/system:
613
collection_interval: 30s
714
scrapers:

docs/EDOT-collector/edot-collector-limitations.md renamed to docs/_edot-collector/edot-collector-limitations.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# EDOT Collector limitations
1+
---
2+
title: Limitations
3+
layout: default
4+
nav_order: 4
5+
---
6+
7+
# EDOT Collector Limitations
28

39
The Elastic Distribution of the OpenTelemetry (EDOT) Collector has the following limitations:
410

‎docs/_edot-collector/faq.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Frequently Asked Questions
3+
layout: default
4+
nav_order: 7
5+
---
6+
7+
# Frequently Asked Questions

0 commit comments

Comments
 (0)