Skip to content

Commit b40b0e1

Browse files
committed
Refactor news/releases to be like stroom-docs
1 parent 4eef48a commit b40b0e1

File tree

8 files changed

+119
-33
lines changed

8 files changed

+119
-33
lines changed
File renamed without changes.

docs/content/en/news/_index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
2-
title: "News / Releases"
3-
linkTitle: "News / Releases"
2+
title: "News"
3+
linkTitle: "News"
4+
weight: 50
45
menu:
56
main:
6-
weight: 30
7+
weight: 50
78
cascade:
89
- type: "blog"
910
---
1011

1112

12-
This is the **blog** section. It has two categories: News and Releases.
13+
This is the **blog** section.
1314

1415
Files in these directories will be listed in reverse chronological order.
1516

docs/content/en/news/news/_index.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/content/en/news/releases/_index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/content/en/news/releases/v04.00-beta.5.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/content/en/releases/_index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
---
3+
title: "Release Notes"
4+
linkTitle: "Releases Notes"
5+
weight: 30
6+
menu:
7+
main:
8+
weight: 30
9+
cascade:
10+
- type: "docs"
11+
description: >
12+
This section contains the release notes for the major and minor Stroom release versions.
13+
---
14+
15+
File renamed without changes.
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
weight: 30
3+
title: "Version 4.0.0"
4+
linkTitle: "4.0.0"
5+
date: 2023-11-20
6+
description: >
7+
Key new features and changes present in v4.0.0.
8+
---
9+
10+
{{% pageinfo %}}
11+
For a detailed list of the changes in v4.00 see the {{< external-link "changelog" "https://github.com/gchq/event-logging-schema/blob/v4.0.0/CHANGELOG.md" >}}
12+
{{% /pageinfo %}}
13+
14+
15+
## Breaking changes
16+
17+
The following changes have been made that break backward compatibility with documents created using older versions of the schema.
18+
19+
* Remove deprecated `AntiMalware` element.
20+
21+
* Remove deprecated `LocationComplexType/TimeZone`.
22+
23+
* Remove deprecated `EventDetail/Classification`.
24+
25+
* Remove deprecated `SearchResult` and `SearchResultComplexType`.
26+
27+
28+
## Additions
29+
30+
* Add `<SecutiryDomain>` element to `<System>`.
31+
32+
* Add `<SharingData>` element to `<Events>` and `<Event>`.
33+
34+
* Add `Keyboard`,`Mouse` and `Webcam` to `HardwareTypeSimpleType`.
35+
36+
* Add `MemoryCard` to `MediaTypeSimpleType`.
37+
38+
* Add additional `annotation/documentation` elements.
39+
40+
41+
## Schema structure changes
42+
43+
These changes affect the structure of the schema itself but have no bearing on what documents are considered valid or not.
44+
They were made to improve the generated Java code used in the {{< external-link "event-logging Java library" "https://github.com/gchq/event-logging" >}}.
45+
46+
* Extract new complex type `AuthenticateComplexType` from `Authenticate` element.
47+
48+
* Extract new complex type `AuthoriseComplexType` from `Authorise` element.
49+
50+
* Extract new complex type `CopyComplexType` from `CopyMoveComplexType`.
51+
52+
* Extract new complex type `MoveComplexType` from `CopyMoveComplexType`.
53+
54+
* Remove complex type `CopyMoveComplexType`.
55+
56+
* Extract new complex type `CreateComplexType` from `Create` element.
57+
58+
* Extract new complex type `ViewComplexType` from `View` element.
59+
60+
* Extract new complex type `DeleteComplexType` from `Delete` element.
61+
62+
* Extract new complex type `ProcessComplexType` from `Process` element.
63+
64+
* Extract new complex type `PrintComplexType` from `Print` element.
65+
66+
* Extract `InstallationGroup` from `InstallComplexType`.
67+
68+
* Refactor `InstallComplexType` to use `InstallationGroup`.
69+
70+
* Extract `UninstallComplexType` from `Uninstall` element.
71+
72+
* Extract new complex type `NetworkEventActionComplexType` from `Network` element.
73+
74+
* Extract new complex type `AlertComplexType` from `Alert` element.
75+
76+
* Extract `SendReceiveGroup` from `SendReceiveComplexType`.
77+
78+
* Extract `SendComplexType` from `Send` element.
79+
80+
* Extract `ReceiveComplexType` from `Receive` element.
81+
82+
* Extract `MetaDataTagsComplexType` from `Tags` element.
83+
84+
* Remove `AntiMalwareComplexType`.
85+
86+
* Merge `BaseAntiMalwareComplexType` into `AntiMalwareThreatComplexType`.
87+
88+
* Remove `BaseAdvancedQueryItemComplexType`.
89+
90+
* Extract `BaseMultiObjectGroup` from `BaseMultiObjectComplexType`.
91+
92+
* Rename `NetworkSrcDstComplexType` to `NetworkLocationComplexType`.
93+
94+
* Rename `NetworkSrcDstTransportProtocolSimpleType` to `NetworkProtocolSimpleType`.
95+
96+
* Remove deprecated `SearchResultComplexType`.
97+
98+
* Remove unused `FromComplexType`.
99+

0 commit comments

Comments
 (0)