Skip to content

Commit 915c92e

Browse files
authored
[improve] prepare for release hertzbeat v1.6.0 (apache#1929)
1 parent 81da126 commit 915c92e

File tree

28 files changed

+463
-183
lines changed

28 files changed

+463
-183
lines changed

.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,8 @@
1616
#
1717

1818
/home export-ignore
19+
/hip export-ignore
20+
/.github export-ignore
21+
/.idea export-ignore
1922
.gitattributes export-ignore
2023
.gitignore export-ignore

LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ MIT License
206206

207207
The following components are provided under the MIT License
208208
These files from https://github.com/ng-alain/ng-alain
209+
The text of the license is included in material/licenses/frontend/LICENSE-ng-alain.txt
209210

210211
web-app/src/app/core/**
211212
web-app/src/app/layout/**

collector/pom.xml

Lines changed: 79 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<activeByDefault>true</activeByDefault>
208208
</activation>
209209
<build>
210-
<finalName>hertzbeat-collector</finalName>
210+
<finalName>apache-hertzbeat-collector</finalName>
211211
<plugins>
212212
<plugin>
213213
<groupId>org.apache.maven.plugins</groupId>
@@ -229,7 +229,7 @@
229229
<profile>
230230
<id>cluster</id>
231231
<build>
232-
<finalName>hertzbeat-collector</finalName>
232+
<finalName>apache-hertzbeat-collector</finalName>
233233
<resources>
234234
<resource>
235235
<directory>src/main/resources</directory>
@@ -248,8 +248,83 @@
248248
<groupId>org.apache.maven.plugins</groupId>
249249
<artifactId>maven-compiler-plugin</artifactId>
250250
<configuration>
251-
<source>11</source>
252-
<target>11</target>
251+
<source>17</source>
252+
<target>17</target>
253+
</configuration>
254+
</plugin>
255+
<plugin>
256+
<groupId>org.apache.maven.plugins</groupId>
257+
<artifactId>maven-jar-plugin</artifactId>
258+
<version>${maven-jar-plugin.version}</version>
259+
<configuration>
260+
<classesDirectory>target/classes/</classesDirectory>
261+
<archive>
262+
<!--Generated JAR does not include Maven descriptor-related files-->
263+
<addMavenDescriptor>false</addMavenDescriptor>
264+
<manifest>
265+
<!--Project startup class-->
266+
<mainClass>org.apache.hertzbeat.collector.Collector</mainClass>
267+
<useUniqueVersions>false</useUniqueVersions>
268+
<!--Third-party JARs are added to the classpath using maven-dependency-plugin-->
269+
<addClasspath>true</addClasspath>
270+
<!--Location of external dependency JARs-->
271+
<classpathPrefix>lib/</classpathPrefix>
272+
</manifest>
273+
<manifestEntries>
274+
<Class-Path>. config</Class-Path>
275+
</manifestEntries>
276+
</archive>
277+
</configuration>
278+
</plugin>
279+
<plugin>
280+
<groupId>org.apache.maven.plugins</groupId>
281+
<artifactId>maven-assembly-plugin</artifactId>
282+
<version>${maven-assembly-plugin.version}</version>
283+
<executions>
284+
<execution>
285+
<id>without-jdk</id>
286+
<!--Bound Maven operation-->
287+
<phase>package</phase>
288+
<!--Run once-->
289+
<goals>
290+
<goal>single</goal>
291+
</goals>
292+
<configuration>
293+
<descriptors>
294+
<descriptor>../script/assembly/collector/assembly.xml</descriptor>
295+
</descriptors>
296+
<outputDirectory>../dist</outputDirectory>
297+
</configuration>
298+
</execution>
299+
</executions>
300+
</plugin>
301+
</plugins>
302+
</build>
303+
</profile>
304+
<profile>
305+
<id>runtime</id>
306+
<build>
307+
<finalName>apache-hertzbeat-collector</finalName>
308+
<resources>
309+
<resource>
310+
<directory>src/main/resources</directory>
311+
<filtering>true</filtering>
312+
<includes>
313+
<include>*.yml</include>
314+
<include>*.properties</include>
315+
<include>*.xml</include>
316+
<include>banner.txt</include>
317+
<include>META-INF/**</include>
318+
</includes>
319+
</resource>
320+
</resources>
321+
<plugins>
322+
<plugin>
323+
<groupId>org.apache.maven.plugins</groupId>
324+
<artifactId>maven-compiler-plugin</artifactId>
325+
<configuration>
326+
<source>17</source>
327+
<target>17</target>
253328
</configuration>
254329
</plugin>
255330
<plugin>

home/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

home/README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# HertzBeat Website
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/).
4-
Learn From [webdriverio](https://webdriver.io/)
3+
This website is built with [Docusaurus](https://docusaurus.io/).
54

65
## Installation
76

@@ -49,3 +48,34 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
4948
```console
5049
GITHUB_HOST=gitee.com USE_SSH=true yarn deploy
5150
```
51+
52+
53+
## Directory Structure
54+
55+
```html
56+
|-- docs
57+
|-- blog
58+
|-- i18n
59+
| `-- zh-CN // internationalized chinese
60+
| |-- code.json
61+
| |-- docusaurus-plugin-content-blog
62+
| |-- docusaurus-plugin-content-docs
63+
| `-- docusaurus-theme-classic
64+
|-- resource // static resource file
65+
|-- src
66+
| |-- theme
67+
| |-- css
68+
| |-- js
69+
| |-- pages
70+
| | |-- components
71+
| | |-- index.js
72+
| |-- constants.js
73+
|-- static // picture static resource
74+
| |-- img //
75+
| | |-- blog // blog picture
76+
| | |-- docs // document picture
77+
| | |-- home // product picture
78+
| | |-- icons // icon
79+
|-- docusaurus.config.js
80+
|-- sidebars.js // document sidebar menu configuration
81+
```

home/docs/community/development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ sidebar_label: Development
6060

6161
2. Execute under the project root directory: `mvn clean package`
6262

63-
The HertzBeat install package will at `manager/target/hertzbeat-{version}.tar.gz`
63+
The HertzBeat install package will at `dist/hertzbeat-{version}.tar.gz`
6464

6565
### Collector build
6666

@@ -72,4 +72,4 @@ The HertzBeat install package will at `manager/target/hertzbeat-{version}.tar.gz
7272

7373
4. Execute under `collector` directory: `mvn clean package -Pcluster`
7474

75-
The HertzBeat collector package will at `collector/target/hertzbeat-collector-{version}.tar.gz`
75+
The HertzBeat collector package will at `dist/hertzbeat-collector-{version}.tar.gz`

home/docs/community/document.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,4 @@ css and other style files are placed in the `src/css` directory
9494

9595
> All pages doc can be directly jumped to the corresponding github resource modification page through the 'Edit this page' button at the bottom
9696
97-
### Page style modification
98-
99-
Visit the page https://hertzbeat.apache.org/
100-
位于 `src/pages/components`
10197

0 commit comments

Comments
 (0)