Skip to content

Commit b577e8a

Browse files
benz0libenz0li
committed
Update README, Add code of coduct
1 parent 4540a80 commit b577e8a

File tree

4 files changed

+244
-4
lines changed

4 files changed

+244
-4
lines changed

‎CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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, 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
49+
moderation 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
56+
address, posting via an official social media account, or acting as an
57+
appointed 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+
<[email protected]>. All complaints will be reviewed and investigated
64+
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.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎README.md

+114-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,115 @@
1-
<a href="https://liberapay.com/benz0li/donate"><img src="https://liberapay.com/assets/widgets/donate.svg" alt="Donate using Liberapay" height="20"></a> <a href="https://benz0li.b-data.io/donate?project=1"><img src="https://benz0li.b-data.io/donate/static/donate-with-fosspay.png" alt="Donate with fosspay"></a>
1+
[![minimal-readme compliant](https://img.shields.io/badge/readme%20style-minimal-brightgreen.svg)](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/minimal-readme.md) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) <a href="https://liberapay.com/benz0li/donate"><img src="https://liberapay.com/assets/widgets/donate.svg" alt="Donate using Liberapay" height="20"></a> <a href="https://benz0li.b-data.io/donate?project=1"><img src="https://benz0li.b-data.io/donate/static/donate-with-fosspay.png" alt="Donate with fosspay"></a>
22

3-
# Docker stack
3+
# Julia docker stack
4+
5+
Pre-built multi-arch (`linux/amd64`, `linux/arm64/v8`) docker images:
6+
7+
* `registry.gitlab.b-data.ch/julia/ver`
8+
* `registry.gitlab.b-data.ch/julia/base`
9+
* `registry.gitlab.b-data.ch/julia/pubtools`
10+
11+
Images considered stable for Julia versions ≥ 1.7.3.
12+
:point_right: The current state may eventually be backported to versions ≥
13+
1.5.4.
14+
15+
**Features**
16+
17+
`registry.gitlab.b-data.ch/julia/ver` serves as base image for
18+
`registry.gitlab.b-data.ch/jupyterlab/julia/base`.
19+
20+
The other images are counterparts to the JupyterLab images but **without**
21+
22+
* code-server
23+
* IJulia
24+
* JupyterHub
25+
* JupyterLab
26+
* JupyterLab Extensions
27+
* JupyterLab Integrations
28+
* Jupyter Notebook
29+
* Jupyter Notebook Conversion
30+
* LSP Servers
31+
* Oh My Zsh
32+
* Powerlevel10k Theme
33+
* MesloLGS NF Font
34+
35+
and any configuration thereof.
36+
37+
## Table of Contents
38+
39+
* [Prerequisites](#prerequisites)
40+
* [Install](#install)
41+
* [Usage](#usage)
42+
* [Contributing](#contributing)
43+
* [License](#license)
44+
45+
## Prerequisites
46+
47+
This projects requires an installation of docker.
48+
49+
## Install
50+
51+
To install docker, follow the instructions for your platform:
52+
53+
* [Install Docker Engine | Docker Documentation > Supported platforms](https://docs.docker.com/engine/install/#supported-platforms)
54+
* [Post-installation steps for Linux](https://docs.docker.com/engine/install/linux-postinstall/)
55+
56+
## Usage
57+
58+
### Build image (ver)
59+
60+
latest:
61+
62+
```bash
63+
cd ver && docker build \
64+
--build-arg JULIA_VERSION=1.8.1 \
65+
-t julia-ver \
66+
-f latest.Dockerfile .
67+
```
68+
69+
version:
70+
71+
```bash
72+
cd ver && docker build \
73+
-t julia-ver:<major>.<minor>.<patch> \
74+
-f <major>.<minor>.<patch>.Dockerfile .
75+
```
76+
77+
For `<major>.<minor>.<patch>` ≥ `1.7.3`.
78+
79+
### Run container
80+
81+
self built:
82+
83+
```bash
84+
docker run -it --rm julia-ver[:<major>.<minor>.<patch>]
85+
```
86+
87+
from the project's GitLab Container Registries:
88+
89+
* [julia/ver](https://gitlab.b-data.ch/julia/ver/container_registry)
90+
```bash
91+
docker run -it --rm \
92+
registry.gitlab.b-data.ch/julia/ver[:<major>[.<minor>[.<patch>]]]
93+
```
94+
* [julia/base](https://gitlab.b-data.ch/julia/base/container_registry)
95+
```bash
96+
docker run -it --rm \
97+
registry.gitlab.b-data.ch/julia/base[:<major>[.<minor>[.<patch>]]]
98+
```
99+
* [julia/pubtools](https://gitlab.b-data.ch/julia/pubtools/container_registry)
100+
```bash
101+
docker run -it --rm \
102+
registry.gitlab.b-data.ch/julia/pubtools[:<major>[.<minor>[.<patch>]]]
103+
```
104+
105+
## Contributing
106+
107+
PRs accepted.
108+
109+
This project follows the
110+
[Contributor Covenant](https://www.contributor-covenant.org)
111+
[Code of Conduct](CODE_OF_CONDUCT.md).
112+
113+
## License
114+
115+
[MIT](LICENSE) © 2020 b-data GmbH

‎base/.gitlab-ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
DOCKER_DRIVER: overlay2
3535
DOCKER_TLS_CERTDIR: "/certs"
3636
JULIA_VERSION: "1.8.1"
37-
UPDATE_MODE: "true"
37+
UPDATE_MODE: "false"
3838
before_script:
3939
- *before-script-build
4040

‎pubtools/.gitlab-ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
DOCKER_DRIVER: overlay2
3535
DOCKER_TLS_CERTDIR: "/certs"
3636
JULIA_VERSION: "1.8.1"
37-
UPDATE_MODE: "true"
37+
UPDATE_MODE: "false"
3838
before_script:
3939
- *before-script-build
4040

0 commit comments

Comments
 (0)