Skip to content

Commit

Permalink
[WIP] Add Observability docs (#1877)
Browse files Browse the repository at this point in the history
* Add observability attributes

* Update config and doc aliases
  • Loading branch information
EamonnTP authored Jul 1, 2020
1 parent 38cedd4 commit e8f1b64
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 6 deletions.
26 changes: 23 additions & 3 deletions conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ repos:
kibana-cn: https://github.com/elasticsearch-cn/kibana.git
logstash: https://github.com/elastic/logstash.git
logstash-docs: https://github.com/elastic/logstash-docs.git
observability-docs: https://github.com/elastic/observability-docs.git
security-docs: https://github.com/elastic/security-docs.git
sense: https://github.com/elastic/sense.git
stack-docs: https://github.com/elastic/stack-docs.git
Expand Down Expand Up @@ -908,6 +909,25 @@ contents:

- title: "Observability: APM, Logs, Metrics, and Uptime"
sections:
- title: Observability
prefix: en/observability
current: master
branches: [ master ]
live: *stacklive
index: docs/en/observability/index.asciidoc
chunk: 1
tags: Observability/Guide
subject: Observability
sources:
-
repo: observability-docs
path: docs/en
-
repo: docs
path: shared/versions/stack/{version}.asciidoc
-
repo: docs
path: shared/attributes.asciidoc
- title: Application Performance Monitoring (APM)
base_dir: en/apm
sections:
Expand Down Expand Up @@ -1079,7 +1099,7 @@ contents:
subject: Logs
sources:
-
repo: stack-docs
repo: observability-docs
path: docs/en
-
repo: docs
Expand All @@ -1098,7 +1118,7 @@ contents:
subject: Metrics
sources:
-
repo: stack-docs
repo: observability-docs
path: docs/en
-
repo: docs
Expand Down Expand Up @@ -1690,7 +1710,7 @@ contents:
subject: Ingest Management
sources:
-
repo: stack-docs
repo: observability-docs
path: docs/en
-
repo: beats
Expand Down
8 changes: 5 additions & 3 deletions doc_build_aliases.sh
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,11 @@ alias docbldsoold=docbldso
alias docbldaz='$GIT_HOME/docs/build_docs --doc $GIT_HOME/azure-marketplace/docs/index.asciidoc --chunk 1'

# Solutions
alias docbldmet='$GIT_HOME/docs/build_docs --doc $GIT_HOME/stack-docs/docs/en/metrics/index.asciidoc --chunk 1'
alias docbldob='$GIT_HOME/docs/build_docs --doc $GIT_HOME/observability-docs/docs/en/observability/index.asciidoc --chunk 1'

alias docbldlog='$GIT_HOME/docs/build_docs --doc $GIT_HOME/stack-docs/docs/en/logs/index.asciidoc --chunk 1'
alias docbldmet='$GIT_HOME/docs/build_docs --doc $GIT_HOME/observability-docs/docs/en/metrics/index.asciidoc --chunk 1'

alias docbldlog='$GIT_HOME/docs/build_docs --doc $GIT_HOME/observability-docs/docs/en/logs/index.asciidoc --chunk 1'

alias docbldup='$GIT_HOME/docs/build_docs --doc $GIT_HOME/kibana/docs/uptime-guide/index.asciidoc --chunk 1'

Expand Down Expand Up @@ -117,7 +119,7 @@ alias docbldfnb='$GIT_HOME/docs/build_docs --respect_edit_url_overrides --doc $G
alias docbldjb='$GIT_HOME/docs/build_docs --respect_edit_url_overrides --doc $GIT_HOME/beats/journalbeat/docs/index.asciidoc --chunk 1'

# Ingest management
alias docbldim='$GIT_HOME/docs/build_docs --doc $GIT_HOME/stack-docs/docs/en/ingest-management/index.asciidoc --resource=$GIT_HOME/beats/x-pack/elastic-agent/docs --chunk 1'
alias docbldim='$GIT_HOME/docs/build_docs --doc $GIT_HOME/observability-docs/docs/en/ingest-management/index.asciidoc --resource=$GIT_HOME/beats/x-pack/elastic-agent/docs --chunk 1'

# APM
alias docbldamg='$GIT_HOME/docs/build_docs --doc $GIT_HOME/apm-server/docs/guide/index.asciidoc --chunk 1'
Expand Down
2 changes: 2 additions & 0 deletions shared/attributes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ endif::[]
:logs-ref: https://www.elastic.co/guide/en/logs/{branch}
:logs-guide: https://www.elastic.co/guide/en/logs/guide/{branch}
:uptime-guide: https://www.elastic.co/guide/en/uptime/{branch}
:observability-guide: https://www.elastic.co/guide/en/observability/{branch}
:siem-guide: https://www.elastic.co/guide/en/siem/guide/{branch}
:endpoint-guide: https://www.elastic.co/guide/en/endpoint/{branch}
:sql-odbc: https://www.elastic.co/guide/en/elasticsearch/sql-odbc/{branch}
Expand Down Expand Up @@ -296,6 +297,7 @@ Common words and phrases

:default-dist: default distribution
:oss-dist: OSS-only distribution
:observability: Observability

:api-request-title: Request
:api-prereq-title: Prerequisites
Expand Down

0 comments on commit e8f1b64

Please sign in to comment.