Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prepare the readme intro and changelog for 1.0.0-beta1 #174

Merged
merged 9 commits into from
Nov 7, 2018
Merged

Prepare the readme intro and changelog for 1.0.0-beta1 #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2168792
Tweak top warning, and create a #Versions section at the top of the R…
Nov 6, 2018
bad97ca
Remove empty changelog section and add mention of 0.1.0 at the bottom
Nov 6, 2018
719e7d2
Rename Changelog section Unreleased to 1.0.0-beta.1
Nov 6, 2018
5f57cc1
Add a caveats section to the release
Nov 6, 2018
ac22d37
Link to the changelog of the current version from the intro
Nov 6, 2018
18d6618
Tweak changelog based on feedback
Nov 7, 2018
9db5cf8
Make the intro/version text less maintenance to adjust around releases
Nov 7, 2018
7924db7
Remove the caveats from the changelog
Nov 7, 2018
001d194
Add warning about the readme superseding the other generated files as…
Nov 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
# Change Log
# CHANGELOG
All notable changes to this project will be documented in this file based on the [Keep a Changelog](http://keepachangelog.com/) Standard. This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased

## [Unreleased](https://github.com/elastic/ecs/compare/0.1.0...master)
### Breaking changes

### Bugfixes

### Added

### Improvements

### Deprecated

## 1.0.0-beta1

### Breaking changes
* Change structure of URL. #7
Expand Down Expand Up @@ -32,8 +43,6 @@ All notable changes to this project will be documented in this file based on the
* Rename `url.hostname` to `url.domain`. #175
* Remove `source.hostname` and `destination.hostname`. #175

### Bugfixes

### Added
* Add `network.total.packets` and `network.total.bytes` field. PR#2
* Add `event.action` field. #21
Expand All @@ -54,4 +63,6 @@ All notable changes to this project will be documented in this file based on the
* Remove duplicate definitions of the reuseable `os` field set from `host.os` and
`user_agent.os`. #168

### Deprecated
## 0.1.0

Initial draft release
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ See CONTRIBUTING.md for more details on setting up.

-->

**WARNING: THIS IS WORK IN PROGRESS**
**WARNING: THE MASTER BRANCH IS FOR WORK IN PROGRESS**

# Elastic Common Schema (ECS)

Expand All @@ -23,7 +23,18 @@ ECS is still under development and backward compatibility is not guaranteed. Any
feedback on the general structure, missing fields, or existing fields is appreciated.
For contributions please read the [Contributing Guide](CONTRIBUTING.md).

<a name="ecs-version"></a>The current version of ECS is `0.1.0`.
<a name="ecs-version"></a>
# Versions

The master branch of this repository should never be considered an
official release of ECS. You can browse official releases of ECS
[here](https://github.com/elastic/ecs/releases).

Please note that when the README.md file and other generated files
(like schema.csv and template.json) are not in agreement,
the README.md should be considered the official spec.
The other two files are simply provided as a convenience, and may not always be
fully up to date.

# In this readme

Expand Down
15 changes: 13 additions & 2 deletions docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ See CONTRIBUTING.md for more details on setting up.

-->

**WARNING: THIS IS WORK IN PROGRESS**
**WARNING: THE MASTER BRANCH IS FOR WORK IN PROGRESS**

# Elastic Common Schema (ECS)

Expand All @@ -23,7 +23,18 @@ ECS is still under development and backward compatibility is not guaranteed. Any
feedback on the general structure, missing fields, or existing fields is appreciated.
For contributions please read the [Contributing Guide](CONTRIBUTING.md).

<a name="ecs-version"></a>The current version of ECS is `0.1.0`.
<a name="ecs-version"></a>
# Versions

The master branch of this repository should never be considered an
official release of ECS. You can browse official releases of ECS
[here](https://github.com/elastic/ecs/releases).

Please note that when the README.md file and other generated files
(like schema.csv and template.json) are not in agreement,
the README.md should be considered the official spec.
The other two files are simply provided as a convenience, and may not always be
fully up to date.

# In this readme

Expand Down