Skip to content

Commit 8d9033e

Browse files
twoGiantsclaude
andcommitted
docs: add GitHub Pages landing page
Add a simple landing page with quick install instructions, a direct link to plugin.yaml, and links to the repository and container registry. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent bad8bec commit 8d9033e

2 files changed

Lines changed: 71 additions & 1 deletion

File tree

.github/workflows/ci.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,13 +143,14 @@ jobs:
143143
- name: Setup Helm
144144
uses: azure/setup-helm@v5
145145

146-
- name: Generate deployment YAML
146+
- name: Generate deployment YAML and landing page
147147
run: |
148148
mkdir public
149149
helm template console-functions-plugin charts/openshift-console-plugin \
150150
-n console-functions-plugin \
151151
--set "plugin.image=${{ env.IMAGE }}@${{ needs.publish.outputs.digest }}" \
152152
> public/plugin.yaml
153+
cp pages/index.html public/index.html
153154
154155
- name: Upload Pages artifact
155156
uses: actions/upload-pages-artifact@v5

pages/index.html

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
<title>Serverless Functions Console Plugin</title>
7+
<style>
8+
* { margin: 0; padding: 0; box-sizing: border-box; }
9+
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: #f5f5f5; color: #333; }
10+
.container { max-width: 720px; margin: 80px auto; padding: 0 24px; }
11+
h1 { font-size: 1.8rem; margin-bottom: 8px; }
12+
.subtitle { color: #666; margin-bottom: 32px; }
13+
.card { background: #fff; border: 1px solid #ddd; border-radius: 8px; padding: 24px; margin-bottom: 24px; }
14+
h2 { font-size: 1.1rem; margin-bottom: 12px; }
15+
pre { background: #1e1e1e; color: #d4d4d4; padding: 16px; border-radius: 6px; overflow-x: auto; font-size: 0.9rem; line-height: 1.5; }
16+
a { color: #0066cc; }
17+
.links { display: flex; gap: 16px; flex-wrap: wrap; }
18+
.links a { display: inline-block; padding: 8px 16px; background: #0066cc; color: #fff; text-decoration: none; border-radius: 4px; font-size: 0.9rem; }
19+
.links a:hover { background: #0052a3; }
20+
.links a.secondary { background: #fff; color: #0066cc; border: 1px solid #0066cc; }
21+
.links a.secondary:hover { background: #f0f6ff; }
22+
.yaml-container { max-height: 500px; overflow-y: auto; margin-top: 12px; }
23+
.yaml-container pre { margin: 0; }
24+
.loading { color: #999; font-style: italic; }
25+
</style>
26+
</head>
27+
<body>
28+
<div class="container">
29+
<h1>Serverless Functions Console Plugin</h1>
30+
<p class="subtitle">A FaaS UI for the OpenShift Web Console.</p>
31+
32+
<div class="card">
33+
<h2>Quick install</h2>
34+
<pre><code>oc new-project console-functions-plugin
35+
oc apply -f https://twogiants.github.io/func-console/plugin.yaml</code></pre>
36+
</div>
37+
38+
<div class="card">
39+
<h2>Resources</h2>
40+
<div class="links">
41+
<a href="plugin.yaml">plugin.yaml</a>
42+
<a class="secondary" href="https://github.com/twoGiants/func-console">GitHub Repository</a>
43+
<a class="secondary" href="https://github.com/twoGiants/func-console/pkgs/container/console-functions-plugin">Container Registry</a>
44+
</div>
45+
</div>
46+
47+
<div class="card">
48+
<h2>plugin.yaml</h2>
49+
<div class="yaml-container">
50+
<p class="loading" id="yaml-loading">Loading...</p>
51+
<pre id="yaml-content" style="display:none"><code></code></pre>
52+
</div>
53+
</div>
54+
</div>
55+
<script>
56+
fetch('plugin.yaml')
57+
.then(r => r.text())
58+
.then(text => {
59+
document.getElementById('yaml-loading').style.display = 'none';
60+
const el = document.getElementById('yaml-content');
61+
el.style.display = 'block';
62+
el.querySelector('code').textContent = text;
63+
})
64+
.catch(() => {
65+
document.getElementById('yaml-loading').textContent = 'Failed to load plugin.yaml';
66+
});
67+
</script>
68+
</body>
69+
</html>

0 commit comments

Comments
 (0)