Skip to content

Commit d392d9f

Browse files
Initial commit
0 parents  commit d392d9f

File tree

9 files changed

+147
-0
lines changed

9 files changed

+147
-0
lines changed

.github/CODEOWNERS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# The releng team is by default the owner of everything.
2+
* @{{ org }}/eclipsefdn-releng
3+
4+
# Otterdog related configurations are also owned by the security team.
5+
/otterdog/** @{{ org }}/eclipsefdn-security

.github/dependabot.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: "/"
5+
# We scan and create dependabot PRs against the develop branch only.
6+
# Such a branch only exists for the template master at EclipseFdn/.eclipsefdn-template
7+
# dependabot shall only update the template master, and changes will be synchronized to
8+
# all repos by otterdog using the sync-template operation to avoid having many similar
9+
# dependabot PRs for each individual .eclipsefdn repo which we would like to avoid at all costs.
10+
target-branch: "develop"
11+
schedule:
12+
interval: daily
13+
open-pull-requests-limit: 10

.github/workflows/build-page.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Build GH Page
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- 'main'
8+
paths:
9+
- 'docs/**'
10+
- 'mkdocs.yml'
11+
- '.github/workflows/build-page.yml'
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
jobs:
23+
build-page:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
27+
- uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
28+
with:
29+
python-version: 3.x
30+
cache: 'pip'
31+
- run: pip install -r requirements.txt
32+
- name: Build with Mkdocs
33+
run: mkdocs build
34+
- name: Setup Pages
35+
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
36+
- name: Upload artifact
37+
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
38+
39+
deploy:
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
runs-on: ubuntu-latest
44+
needs: build-page
45+
steps:
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Eclipse Foundation Config Repo
2+
3+
Repository to host configurations related to the Eclipse Foundation.
4+
5+
## Self service of your GitHub organization
6+
7+
You can find more information at <https://{{ org }}.github.io/.eclipsefdn/>.

docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
7+
# Self-service of GitHub resources
8+
9+
General documentation for using the self-service (stored in directory *otterdog*) can be accessed at [otterdog.readthedocs.io](https://otterdog.readthedocs.io).
10+
11+
## Current configuration
12+
13+
The current configuration can be reviewed in the [Otterdog Dashboard](https://otterdog.eclipse.org/organizations/{{ org_id }}).
14+
15+
## Playground
16+
17+
A playground for creating and testing resources in jsonnet format is available [here](https://otterdog.eclipse.org/organizations/{{ org_id }}/playground).

docs/overrides/main.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{% extends "base.html" %}
2+
3+
{% block site_meta %}
4+
{{ super() }}
5+
<!-- prevent caching -->
6+
<meta http-equiv="cache-control" content="no-cache, must-revalidate, post-check=0, pre-check=0" />
7+
<meta http-equiv="cache-control" content="max-age=0" />
8+
<meta http-equiv="expires" content="0" />
9+
<meta http-equiv="expires" content="Tue, 01 Jan 1980 1:00:00 GMT" />
10+
<meta http-equiv="pragma" content="no-cache" />
11+
{% endblock %}

docs/stylesheets/extra.css

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.md-grid {
2+
max-width: 1440px;
3+
}

mkdocs.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
site_name: Otterdog configuration @ {{ org }}
2+
site_description: Otterdog configuration @ {{ org }}
3+
strict: false
4+
5+
site_url: https://{{ org }}.github.io/.eclipsefdn/
6+
7+
repo_name: {{ org }}/.eclipsefdn
8+
repo_url: https://github.com/{{ org }}/.eclipsefdn/
9+
10+
docs_dir: ./docs
11+
site_dir: ./_site
12+
13+
theme:
14+
name: 'material'
15+
custom_dir: docs/overrides
16+
features:
17+
- navigation.tabs
18+
19+
markdown_extensions:
20+
- pymdownx.superfences
21+
- pymdownx.tabbed:
22+
alternate_style: true
23+
- attr_list
24+
- pymdownx.emoji:
25+
emoji_index: !!python/name:materialx.emoji.twemoji
26+
emoji_generator: !!python/name:materialx.emoji.to_svg
27+
28+
plugins:
29+
- macros
30+
31+
nav:
32+
- Overview: index.md
33+
34+
watch: []
35+
36+
extra:
37+
org_id: {{ org }}
38+
39+
extra_css:
40+
- stylesheets/extra.css

requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkdocs ~= 1.5
2+
mkdocs-material ~= 9.4
3+
mkdocs-macros-plugin ~= 1.0

0 commit comments

Comments
 (0)