Skip to content

Commit 9c70659

Browse files
notandynotandy
committed
Initital commit
1 parent feafdb7 commit 9c70659

17 files changed

Lines changed: 4588 additions & 43 deletions

File tree

‎.dockerignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
node_modules
3+
docs/.vitepress/dist
4+
docs/.vitepress/cache

‎.editorconfig‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
indent_size = 2
7+
indent_style = space
8+
insert_final_newline = false
9+
max_line_length = 120
10+
tab_width = 4
11+
ij_continuation_indent_size = 8
12+
ij_formatter_off_tag = @formatter:off
13+
ij_formatter_on_tag = @formatter:on
14+
ij_formatter_tags_enabled = true
15+
ij_smart_tabs = false
16+
ij_visual_guides =
17+
ij_wrap_on_typing = false

‎.github/workflows/static.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Deploy VitePress site to Pages
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["main"]
7+
pull_request:
8+
types: [ assigned, opened, synchronize, reopened ]
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
build:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- name: Checkout
29+
uses: actions/checkout@v4
30+
- name: Setup Node
31+
uses: actions/setup-node@v4
32+
with:
33+
node-version: 24
34+
cache: npm # or pnpm / yarn
35+
- name: Setup Pages
36+
uses: actions/configure-pages@v5
37+
- name: Install dependencies
38+
run: npm ci # or pnpm install / yarn install / bun install
39+
- name: Build with VitePress
40+
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: docs/.vitepress/dist
45+
if: github.event_name != 'pull_request' # Skip upload on PRs
46+
47+
# Deployment job
48+
deploy:
49+
if: github.event_name != 'pull_request' # Skip deployment on PRs
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
needs: build
54+
runs-on: ubuntu-latest
55+
name: Deploy
56+
steps:
57+
- name: Deploy to GitHub Pages
58+
id: deployment
59+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
docs/.vitepress/dist
3+
docs/.vitepress/cache
4+
bin

‎Dockerfile‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SPDX-FileCopyrightText: SAP SE or an SAP affiliate company
2+
# SPDX-License-Identifier: Apache-2.0
3+
FROM node:24-alpine
4+
WORKDIR /app
5+
COPY package*.json ./
6+
RUN npm install
7+
EXPOSE 5173
8+
CMD ["npm", "run", "docs:dev", "--", "--host=0.0.0.0"]

‎README.md‎

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,35 @@
11
<!--
2-
# SPDX-FileCopyrightText: Copyright 2024 SAP SE or an SAP affiliate company and cobaltcore-dev contributors
2+
# SPDX-FileCopyrightText: Copyright 2025 SAP SE or an SAP affiliate company and cobaltcore-dev contributors
33
#
44
# SPDX-License-Identifier: Apache-2.0
55
-->
66

7-
# SAP Repository Template
8-
9-
Default templates for SAP open source repositories, including LICENSE, .reuse/dep5, Code of Conduct, etc... All repositories on github.com/SAP will be created based on this template.
10-
11-
## To-Do
12-
13-
In case you are the maintainer of a new SAP open source project, these are the steps to do with the template files:
14-
15-
- Check if the default license (Apache 2.0) also applies to your project. A license change should only be required in exceptional cases. If this is the case, please change the [license file](LICENSE).
16-
- Enter the correct metadata for the REUSE tool. See our [wiki page](https://wiki.one.int.sap/wiki/display/ospodocs/Using+the+Reuse+Tool+of+FSFE+for+Copyright+and+License+Information) for details how to do it. You can find an initial REUSE.toml file to build on. Please replace the parts inside the single angle quotation marks < > by the specific information for your repository and be sure to run the REUSE tool to validate that the metadata is correct.
17-
- Adjust the contribution guidelines (e.g. add coding style guidelines, pull request checklists, different license if needed etc.)
18-
- Add information about your project to this README (name, description, requirements etc). Especially take care for the <your-project> placeholders - those ones need to be replaced with your project name. See the sections below the horizontal line and [our guidelines on our wiki page](https://wiki.one.int.sap/wiki/pages/viewpage.action?pageId=3564976048#GuidelinesforGitHubHealthfiles(Readme,Contributing,CodeofConduct)-Readme.md) what is required and recommended.
19-
- Remove all content in this README above and including the horizontal line ;)
20-
21-
***
22-
23-
# Our new open source project
7+
# CobaltCore Documentation
248

259
## About this project
2610

27-
*Insert a short description of your project here...*
11+
This is the official CobalCore documentation.
2812

2913
## Requirements and Setup
3014

31-
*Insert a short description what is required to get your project running...*
15+
### Docker Compose
16+
17+
$ docker compose up
18+
19+
to bring up a auto-refreshable developoment version of the documentation.
20+
The documentation is accessible via [http://localhost:5173/]().
3221

3322
## Support, Feedback, Contributing
3423

35-
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/<your-project>/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
24+
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cobaltcore-dev/docs/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
3625

3726
## Security / Disclosure
38-
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/SAP/<your-project>/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
27+
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cobaltcore-dev/.github/blob/main/SECURITY.md) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
3928

4029
## Code of Conduct
4130

42-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
31+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
4332

4433
## Licensing
4534

46-
Copyright (20xx-)20xx SAP SE or an SAP affiliate company and <your-project> contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/<your-project>).
35+
Copyright 2025 SAP SE or an SAP affiliate company and CobaltCore contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cobaltcore-dev/docs).

‎REUSE.toml‎

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
1+
# SPDX-FileCopyrightText: SAP SE or an SAP affiliate company
2+
# SPDX-License-Identifier: Apache-2.0
13
version = 1
2-
SPDX-PackageName = "<YOUR-REPO-NAME>"
3-
SPDX-PackageSupplier = "<YOUR-CONTACT (MAIL ADDRESS ETC.)>"
4-
SPDX-PackageDownloadLocation = "<https://github.com/sap/YOUR-REPO-NAME>"
5-
SPDX-PackageComment = "The code in this project may include calls to APIs (\"API Calls\") of\n SAP or third-party products or services developed outside of this project\n (\"External Products\").\n \"APIs\" means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products,or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project's code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
4+
SPDX-PackageName = "Documentation for CobaltCore"
5+
SPDX-PackageDownloadLocation = "https://github.com/cobaltcore-dev/docs"
66

77
[[annotations]]
8-
path = "<YOUR-FILE-OR-FOLDER-LIST>"
9-
precedence = "aggregate"
10-
SPDX-FileCopyrightText = "<YEARS-RELEVANT-FOR-YOUR-PROJECT> SAP SE or an SAP affiliate company and <YOUR-PROJECT-NAME> contributors"
8+
path = [
9+
"package*.json",
10+
".github/CODEOWNERS",
11+
".github/renovate.json",
12+
".gitignore",
13+
".dockerignore",
14+
".editorconfig",
15+
"docs/.vitepress/**"
16+
]
17+
SPDX-FileCopyrightText = "SAP SE or an SAP affiliate company"
1118
SPDX-License-Identifier = "Apache-2.0"
12-
13-
[[annotations]]
14-
path = "<THIRD-PARTY-FILE-OR-FOLDER-LIST>"
15-
precedence = "aggregate"
16-
SPDX-FileCopyrightText = "<COPYRIGHT-OF-THIRD-PARTY-CODE>"
17-
SPDX-License-Identifier = "<LICENSE-OF-THIRD-PARTY-CODE>"
18-
19-
[[annotations]]
20-
path = "<ANOTHER-THIRD-PARTY-FILE-OR-FOLDER-LIST>"
21-
precedence = "aggregate"
22-
SPDX-FileCopyrightText = "<COPYRIGHT-OF-ANOTHER-THIRD-PARTY-CODE>"
23-
SPDX-License-Identifier = "<LICENSE-OF-ANOTHER- THIRD-PARTY-CODE>"

‎docker-compose.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SPDX-FileCopyrightText: SAP SE or an SAP affiliate company
2+
# SPDX-License-Identifier: Apache-2.0
3+
services:
4+
vitepress:
5+
build: .
6+
ports:
7+
- "5173:5173" # Map container port 5173 to host port 5173
8+
volumes:
9+
- ./docs:/app/docs # Mount your local project directory into the container

‎docs/.vitepress/config.mts‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
import { defineConfig } from 'vitepress'
2+
import { withMermaid } from "vitepress-plugin-mermaid";
3+
4+
5+
// https://vitepress.dev/reference/site-config
6+
export default withMermaid(defineConfig({
7+
title: "CobaltCore",
8+
description: "Opinionated OpenStack distribution that builds upon IronCore’s foundation to support non-cloud-native workloads",
9+
head: [['link', { rel: 'icon', href: 'https://raw.githubusercontent.com/cobaltcore-dev/.github/refs/heads/main/assets/Logo_Cobalt_Core_background_white.svg' }]],
10+
themeConfig: {
11+
// https://vitepress.dev/reference/default-theme-config
12+
nav: [
13+
{ text: 'Home', link: '/' },
14+
{ text: 'Architecture', link: '/architecture' }
15+
],
16+
17+
editLink: {
18+
pattern: 'https://github.com/cobaltcore-dev/.github/blob/main/docs/:path',
19+
text: 'Edit this page on GitHub'
20+
},
21+
22+
footer: {
23+
copyright: `Copyright ${new Date().getFullYear()} SAP SE or an SAP affiliate company and cobaltcore-dev contributors.`
24+
},
25+
26+
logo: { src: 'https://raw.githubusercontent.com/cobaltcore-dev/.github/refs/heads/main/assets/Logo_Cobalt_Core_background_white.svg', width: 24, height: 24 },
27+
28+
search: {
29+
provider: 'local'
30+
},
31+
32+
sidebar: [
33+
{
34+
text: 'Contents',
35+
items: [
36+
{ text: 'Architecture', link: '/architecture' },
37+
{ text: 'API Reference', link: '/api' }
38+
]
39+
}
40+
],
41+
42+
socialLinks: [
43+
{ icon: 'github', link: 'https://github.com/cobaltcore-dev' }
44+
]
45+
}
46+
}))

‎docs/.vitepress/theme/custom.css‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
:root {
2+
--vp-home-hero-name-color: transparent;
3+
--vp-home-hero-name-background: -webkit-linear-gradient(
4+
120deg,
5+
#e30909 30%,
6+
#0a9ae8
7+
);
8+
--vp-home-hero-image-background-image: linear-gradient(
9+
-45deg,
10+
#e30909 50%,
11+
#0a9ae8 50%
12+
);
13+
--vp-home-hero-image-filter: blur(44px);
14+
}
15+
16+
@media (min-width: 640px) {
17+
:root {
18+
--vp-home-hero-image-filter: blur(56px);
19+
}
20+
}
21+
22+
@media (min-width: 960px) {
23+
:root {
24+
--vp-home-hero-image-filter: blur(68px);
25+
}
26+
}
27+
28+
.VPHero .VPImage {
29+
filter: drop-shadow(-2px 4px 6px rgba(0, 0, 0, 0.2));
30+
padding: 18px;
31+
}
32+
33+
/* used in reference/default-theme-search */
34+
img[src='/search.png'] {
35+
width: 100%;
36+
aspect-ratio: 1 / 1;
37+
}

0 commit comments

Comments
 (0)