Skip to content

Commit

Permalink
Merge pull request #2 from joschobart/documentation
Browse files Browse the repository at this point in the history
Documentation
  • Loading branch information
joschobart authored Aug 1, 2024
2 parents e0a86e9 + e3eb12c commit 5340297
Show file tree
Hide file tree
Showing 35 changed files with 4,562 additions and 4,448 deletions.
140 changes: 70 additions & 70 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
@@ -1,71 +1,71 @@
name: ci

on:
push:
branches:
- 'main'


jobs:
publish-couchdb-container:
runs-on: ubuntu-latest
steps:
-
name: Set up QEMU
uses: docker/setup-qemu-action@v3
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
-
name: Login to APPUiO registry
uses: docker/login-action@v3
with:
registry: ${{ vars.REGISTRY_URL }}
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
-
name: Build and push
uses: docker/build-push-action@v5
with:
push: true
tags: ${{ vars.REGISTRY_URL }}/${{ vars.OPENSHIFT_PROJECT }}/couchdb-image:latest
file: docker/Dockerfile.couchdb
build-args: |
pw=${{ secrets.COUCHDB_PW }}
publish-app-container:
runs-on: ubuntu-latest
steps:
-
name: Set up QEMU
uses: docker/setup-qemu-action@v3
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
-
name: Login to APPUiO registry
uses: docker/login-action@v3
with:
registry: ${{ vars.REGISTRY_URL }}
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
-
name: Build and push
uses: docker/build-push-action@v5
with:
push: true
tags: ${{ vars.REGISTRY_URL }}/${{ vars.OPENSHIFT_PROJECT }}/fun-with-flags_app-image:latest
file: docker/Dockerfile.app
build-args: |
ck=${{ secrets.HATTRICK_OAUTH_CONSUMER_KEY }}
cs=${{ secrets.HATTRICK_OAUTH_CONSUMER_SECRET }}
fls=${{ secrets.FLASK_SECRET }}
fes=${{ secrets.FERNET_SECRET }}
cdbcs=${{ secrets.COUCHDB_CONNECTION_STRING }}
stest=${{ secrets.STRIPE_ENDPOINT_SECRET_TEST }}
stwhst=${{ secrets.STRIPE_WEBHOOK_SECRET_TEST }}
stpit=${{ secrets.STRIPE_PRICE_ITEM_TEST }}
stes=${{ secrets.STRIPE_ENDPOINT_SECRET }}
stwhs=${{ secrets.STRIPE_WEBHOOK_SECRET }}
name: ci

on:
push:
branches:
- 'main'


jobs:
publish-couchdb-container:
runs-on: ubuntu-latest
steps:
-
name: Set up QEMU
uses: docker/setup-qemu-action@v3
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
-
name: Login to APPUiO registry
uses: docker/login-action@v3
with:
registry: ${{ vars.REGISTRY_URL }}
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
-
name: Build and push
uses: docker/build-push-action@v5
with:
push: true
tags: ${{ vars.REGISTRY_URL }}/${{ vars.OPENSHIFT_PROJECT }}/couchdb-image:latest
file: docker/Dockerfile.couchdb
build-args: |
pw=${{ secrets.COUCHDB_PW }}
publish-app-container:
runs-on: ubuntu-latest
steps:
-
name: Set up QEMU
uses: docker/setup-qemu-action@v3
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
-
name: Login to APPUiO registry
uses: docker/login-action@v3
with:
registry: ${{ vars.REGISTRY_URL }}
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
-
name: Build and push
uses: docker/build-push-action@v5
with:
push: true
tags: ${{ vars.REGISTRY_URL }}/${{ vars.OPENSHIFT_PROJECT }}/fun-with-flags_app-image:latest
file: docker/Dockerfile.app
build-args: |
ck=${{ secrets.HATTRICK_OAUTH_CONSUMER_KEY }}
cs=${{ secrets.HATTRICK_OAUTH_CONSUMER_SECRET }}
fls=${{ secrets.FLASK_SECRET }}
fes=${{ secrets.FERNET_SECRET }}
cdbcs=${{ secrets.COUCHDB_CONNECTION_STRING }}
stest=${{ secrets.STRIPE_ENDPOINT_SECRET_TEST }}
stwhst=${{ secrets.STRIPE_WEBHOOK_SECRET_TEST }}
stpit=${{ secrets.STRIPE_PRICE_ITEM_TEST }}
stes=${{ secrets.STRIPE_ENDPOINT_SECRET }}
stwhs=${{ secrets.STRIPE_WEBHOOK_SECRET }}
stpi=${{ secrets.STRIPE_PRICE_ITEM }}
24 changes: 12 additions & 12 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# python generated files
__pycache__/
*.py[oc]
build/
dist/
wheels/
*.egg-info

# venv
.venv

# babel
# python generated files
__pycache__/
*.py[oc]
build/
dist/
wheels/
*.egg-info

# venv
.venv

# babel
*.pot
2 changes: 1 addition & 1 deletion .python-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.12.0
3.12.0
158 changes: 79 additions & 79 deletions CODE_OF_CONDUCT.rst
Original file line number Diff line number Diff line change
@@ -1,79 +1,79 @@
.. _code_of_conduct:

Contributor Covenant Code of Conduct
++++++++++++++++++++++++++++++++++++

Our Pledge
==========

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and
expression, level of experience, education, socio-economic status, nationality,
personal appearance, race, religion, or sexual identity and orientation.

Our Standards
=============

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members


Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others’ private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting


Our Responsibilities
====================

Maintainers are responsible for clarifying the standards of acceptable behavior
and are expected to take appropriate and fair corrective action in response to
any instances of unacceptable behavior.

Maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

Scope
=====

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

Enforcement
===========

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting joschobart. All complaints will be reviewed and investigated
and will result in a response that is deemed necessary and appropriate
to the circumstances. joschobart is obligated to
maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted
separately.

Attribution
===========

This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
.. _code_of_conduct:

Contributor Covenant Code of Conduct
++++++++++++++++++++++++++++++++++++

Our Pledge
==========

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and
expression, level of experience, education, socio-economic status, nationality,
personal appearance, race, religion, or sexual identity and orientation.

Our Standards
=============

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members


Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others’ private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting


Our Responsibilities
====================

Maintainers are responsible for clarifying the standards of acceptable behavior
and are expected to take appropriate and fair corrective action in response to
any instances of unacceptable behavior.

Maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

Scope
=====

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

Enforcement
===========

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting joschobart. All complaints will be reviewed and investigated
and will result in a response that is deemed necessary and appropriate
to the circumstances. joschobart is obligated to
maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted
separately.

Attribution
===========

This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
Loading

0 comments on commit 5340297

Please sign in to comment.