Skip to content

Commit 7050ae7

Browse files
z9r5z9r5
committed
Add content
1 parent b8b80bd commit 7050ae7

25 files changed

+1169
-0
lines changed

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,7 @@ out/
3535
# Dev environment
3636
bin/
3737
include/
38+
39+
# HuGo public directory and lock file
40+
public
41+
.hugo_build.lock

‎CODE_OF_CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
community@deckhouse.io.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contributing
2+
3+
This is an Open Source project, and third-party contributions are warmly welcome.
4+
5+
## What to do
6+
7+
- Contact us via [Telegram chat](https://t.me/deckhouse) for any questions on developing Deckhouse & contributing to this repo. _There's a dedicated [Telegram chat in Russian](https://t.me/deckhouse_ru) as well._
8+
- Open your [issues](https://github.com/deckhouse/hugo-web-product-module/issues) in this repo.
9+
- If you believe no preliminary discussion is required, submit your [PRs](https://github.com/deckhouse/hugo-web-product-module/pulls) with your code changes straight away.
10+
11+
P.S. The [maintainers list](https://github.com/deckhouse/hugo-web-product-module/blob/main/MAINTAINERS.md) might also be helpful to reach our core developers.
12+

‎LICENSE‎

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

‎MAINTAINERS.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Core maintainers
2+
3+
| Name | Email | GitHub | Telegram
4+
|------------------|---------------------------|--------------------------------------------------------|--------------------------------------
5+
| Artem Kladov | artem.kladov@flant.com | [@z9r5](https://github.com/z9r5) | `@KladovArtem`
6+
7+
## Triage/docs maintainers
8+
9+
| Name | Email | GitHub | Telegram
10+
|-----------------------|------------------------------|------------------------------------------------------------|--------------------------------------
11+
| Artem Kladov | artem.kladov@flant.com | [@z9r5](https://github.com/z9r5) | `@KladovArtem`

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Hugo module for the Deckhouse websites
2+
3+
This is the source for the Hugo module, used in Deckhouse documentation websites.
4+
5+
Add it in your hugo configuration.
6+
7+
For the local development, you can use the following replace directive in your `go.mod`:
8+
9+
```go
10+
replace github.com/deckhouse/hugo-web-product-module => ../hugo-web-product-module
11+
```
12+
13+
or use use the modules configuration [replacements](https://gohugo.io/configuration/module/#replacements) option.

0 commit comments

Comments
 (0)