Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticmachine committed Dec 6, 2023
1 parent fdce58b commit 0f1a881
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ in the [observability-docs](https://github.com/elastic/observability-docs) repo.

### Changelog

The changelog for the Elastic Agent is generated and maintained using the [elastic-agent-changelog-tool](https://github.com/elastic/elastic-agent-changelog-tool). Read the [installation](https://github.com/elastic/elastic-agent-changelog-tool/blob/main/docs/install.md)
and [usage](https://github.com/elastic/elastic-agent-changelog-tool/blob/main/docs/usage.md#im-a-developer) instructions to get started.
The changelog for the Elastic Agent is generated and maintained using the [elastic-agent-changelog-tool](https://github.com/elastic/elastic-agent-changelog-tool). Read the [installation](https://github.com/elastic/elastic-agent-changelog-tool/blob/8.12/docs/install.md)
and [usage](https://github.com/elastic/elastic-agent-changelog-tool/blob/8.12/docs/usage.md#im-a-developer) instructions to get started.

The changelog tool produces fragement files that are consolidated to generate a changelog for each release. Each PR containing a change with user
impact (new feature, bug fix, etc.) must contain a changelog fragement describing the change. There is a GitHub action in CI that will fail
Expand All @@ -36,7 +36,7 @@ pr: https://github.com/elastic/elastic-agent/pull/823
Prerequisites:
- installed [mage](https://github.com/magefile/mage)
- [Docker](https://docs.docker.com/get-docker/)
- [X-pack](https://github.com/elastic/beats/tree/main/x-pack) to pre-exist in the parent folder of the local Git repository checkout
- [X-pack](https://github.com/elastic/beats/tree/8.12/x-pack) to pre-exist in the parent folder of the local Git repository checkout
- [elastic-agent-changelog-tool](https://github.com/elastic/elastic-agent-changelog-tool) to add changelog fragments for changelog generation
To build a local version of the agent for development, run the command below. The following platforms are supported:
Expand Down Expand Up @@ -89,10 +89,10 @@ for the standard variant.
### Testing Elastic Agent on Kubernetes

#### Prerequisites
- create kubernetes cluster using kind, check [here](https://github.com/elastic/beats/blob/main/metricbeat/module/kubernetes/_meta/test/docs/README.md) for details
- deploy kube-state-metrics, check [here](https://github.com/elastic/beats/blob/main/metricbeat/module/kubernetes/_meta/test/docs/README.md) for details
- create kubernetes cluster using kind, check [here](https://github.com/elastic/beats/blob/8.12/metricbeat/module/kubernetes/_meta/test/docs/README.md) for details
- deploy kube-state-metrics, check [here](https://github.com/elastic/beats/blob/8.12/metricbeat/module/kubernetes/_meta/test/docs/README.md) for details
- deploy required infrastructure:
- for elastic agent in standalone mode: EK stack or use [elastic cloud](https://cloud.elastic.co), check [here](https://github.com/elastic/beats/blob/main/metricbeat/module/kubernetes/_meta/test/docs/README.md) for details
- for elastic agent in standalone mode: EK stack or use [elastic cloud](https://cloud.elastic.co), check [here](https://github.com/elastic/beats/blob/8.12/metricbeat/module/kubernetes/_meta/test/docs/README.md) for details
- for managed mode: use [elastic cloud](https://cloud.elastic.co) or bring up the stack on docker and then connect docker network with kubernetes kind nodes:
```
elastic-package stack up -d -v
Expand Down
2 changes: 1 addition & 1 deletion version/docs/version.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:stack-version: 8.8.1
:stack-version: 8.12.0
:doc-branch: main
// FIXME: once elastic.co docs have been switched over to use `main`, remove
// the `doc-site-branch` line below as well as any references to it in the code.
Expand Down

0 comments on commit 0f1a881

Please sign in to comment.