Skip to content

Commit 83f5841

Browse files
committed
added new files
1 parent bdbe41b commit 83f5841

File tree

7 files changed

+131
-32
lines changed

7 files changed

+131
-32
lines changed

.github/workflows/build-and-deploy.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.

.github/workflows/build.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
with:
14+
fetch-depth: 0
15+
16+
- name: Setup Node.js
17+
uses: actions/setup-node@v3
18+
with:
19+
node-version: '18'
20+
cache: 'npm'
21+
22+
- name: Install dependencies
23+
run: npm ci
24+
25+
- name: Build site
26+
run: npm run build
27+
28+
- name: Deploy to GitHub Pages
29+
uses: peaceiris/actions-gh-pages@v3
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
publish_dir: ./build/site
33+
publish_branch: gh-pages
34+
commit_message: "docs: update documentation"

.nojekyll

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
3+

antora-playbook.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
site:
2+
title: Industrial Digital Twin Documentation
3+
url: https://industrialdigitaltwin.io
4+
start_page: home::index.adoc
5+
6+
content:
7+
sources:
8+
- url: .
9+
branches: [ HEAD ]
10+
start_path: .
11+
components:
12+
- name: home
13+
start_page: index.adoc
14+
- url: https://github.com/admin-shell-io/aas-specifications.git
15+
branches: [ main ]
16+
start_path: modules/ROOT/pages
17+
components:
18+
- name: aas-specifications
19+
start_page: index.adoc
20+
- url: https://github.com/admin-shell-io/idta-submodel-templates.git
21+
branches: [ main ]
22+
start_path: docs
23+
components:
24+
- name: submodel-templates
25+
start_page: index.adoc
26+
27+
ui:
28+
bundle:
29+
url: https://github.com/admin-shell-io/aas-specs-antora-ui/releases/latest/download/ui-bundle.zip
30+
snapshot: true
31+
supplemental_files:
32+
- path: .nojekyll
33+
- path: CNAME
34+
35+
asciidoc:
36+
attributes:
37+
xrefstyle: short
38+
page-layout: home
39+
sectids: true

index.adoc

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
= Industrial Digital Twin Documentation
2+
:page-layout: home
3+
:!sectids:
4+
5+
[.lead]
6+
Welcome to the Industrial Digital Twin Association (IDTA) documentation portal. This site provides comprehensive documentation for the Asset Administration Shell (AAS) specifications and submodel templates.
7+
8+
== Documentation Components
9+
10+
* xref:aas-specifications:index.adoc[Asset Administration Shell Specifications] - Core specifications and standards
11+
* xref:submodel-templates:index.adoc[Submodel Templates] - Industry-specific templates and examples
12+
13+
== About IDTA
14+
15+
The Industrial Digital Twin Association (IDTA) is dedicated to developing and maintaining the Asset Administration Shell (AAS) specification and related standards for industrial digital twins. Our mission is to create a standardized approach to digital twins in industry.
16+
17+
== Getting Started
18+
19+
To get started with the documentation:
20+
21+
1. Begin with the AAS specifications to understand the core concepts
22+
2. Explore the submodel templates for your specific industry needs
23+
3. Review the implementation guides and examples
24+
4. Join our community for support and collaboration
25+
26+
== Contributing
27+
28+
We welcome contributions to our documentation. Please visit our GitHub repositories to learn more about contributing:
29+
30+
* https://github.com/admin-shell-io/aas-specifications[Asset Administration Shell Specifications]
31+
* https://github.com/admin-shell-io/idta-submodel-templates[Submodel Templates]
32+
33+
== Support
34+
35+
For questions and support:
36+
37+
* Join our community discussions
38+
* Report issues on GitHub
39+
* Contact us through our website

index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,13 +209,13 @@ <h2>Welcome to Industrial Digital Twin Documentation</h2>
209209
<div class="card">
210210
<h2>AAS Specifications</h2>
211211
<p>Comprehensive documentation for the Asset Administration Shell specifications, including metamodel, API specifications, and more.</p>
212-
<a href="https://admin-shell-io.github.io/aas-specifications/" class="button">View Documentation</a>
212+
<a href="aas-specifications/" class="button">View Documentation</a>
213213
</div>
214214

215215
<div class="card">
216216
<h2>Submodel Templates</h2>
217217
<p>Standardized submodel templates for implementing the Asset Administration Shell in various industrial contexts.</p>
218-
<a href="https://admin-shell-io.github.io/idta-submodel-templates/" class="button">View Documentation</a>
218+
<a href="idta-submodel-templates/" class="button">View Documentation</a>
219219
</div>
220220
</div>
221221
</main>

package.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"name": "idta-documentation",
3+
"version": "1.0.0",
4+
"description": "Industrial Digital Twin Association Documentation Portal",
5+
"private": true,
6+
"scripts": {
7+
"build": "antora antora-playbook.yml",
8+
"start": "npx http-server build/site"
9+
},
10+
"dependencies": {
11+
"@antora/cli": "^3.1.2",
12+
"@antora/site-generator-default": "^3.1.2"
13+
}
14+
}

0 commit comments

Comments
 (0)