Skip to content

docs: move documentation from ix to ix-docs #1883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
May 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
contact_links:
- name: Bug report or feature request for the official iX documentation
url: https://github.com/siemens/ix-docs/issues
about: Please use this link to report bugs or request features related to the official iX documentation.

- name: Support Question 🤔
url: https://community.siemens.com/c/ix/
about: This issue tracker is not for support questions. Please post your question to the Siemens Community Forum.
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/docs_bug_report.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A pull request can only be merged if all of these conditions are met (where appl
- [ ] 🦮 Accessibility (a11y) features were implemented
- [ ] 🗺️ Internationalization (i18n) - no hard coded strings
- [ ] 📲 Responsiveness - components handle viewport changes and content overflow gracefully
- [ ] 📄 Documentation was reviewed/updated (`pnpm run docs`)
- [ ] 📄 Documentation was reviewed/updated [siemens/ix-docs](https://github.com/siemens/ix-docs)
- [ ] 🧪 Unit tests were added/updated and pass (`pnpm test`)
- [ ] 📸 Visual regression tests were added/updated and pass ([Guide](https://github.com/siemens/ix/blob/main/CONTRIBUTING.md#visual-regression-testing))
- [ ] 🧐 Static code analysis passes (`pnpm lint`)
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ jobs:
- name: Lint
run: pnpm lint

- name: Documentation
uses: actions/upload-artifact@v4
with:
name: documentation-${{ github.run_attempt }}
path: ./packages/documentation/build

visual-testing-core:
needs: [build]
timeout-minutes: 10
Expand Down
38 changes: 0 additions & 38 deletions .github/workflows/deploy-gh-2.7-pages.yml

This file was deleted.

36 changes: 0 additions & 36 deletions .github/workflows/deploy-gh-pages.yml

This file was deleted.

105 changes: 0 additions & 105 deletions .github/workflows/deploy-preview.yml

This file was deleted.

19 changes: 6 additions & 13 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,26 +61,19 @@ jobs:
- uses: ./.github/workflows/actions/turbo

- name: Build
run: pnpm build --cache-dir=.turbo --filter \!documentation
run: pnpm build --cache-dir=.turbo

- name: Lint
run: pnpm lint

- name: Check for local development changes
run: ./scripts/lint-build.sh

build-docs:
needs: [changes, build]
if: ${{ needs.changes.outputs.docs_any_changed == 'true' || github.event.pull_request.user.login == 'dependabot[bot]' }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- uses: ./.github/workflows/actions/turbo

- name: Build
run: pnpm build --cache-dir=.turbo --filter documentation
- name: Documentation
uses: actions/upload-artifact@v4
with:
name: documentation-${{ github.run_attempt }}
path: ./packages/documentation/build

visual-testing-core:
if: ${{ needs.changes.outputs.core_any_changed == 'true' || github.event.pull_request.user.login == 'dependabot[bot]' }}
Expand Down
19 changes: 3 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,9 @@ docker run -v $(pwd):/work/ -w /work -it mcr.microsoft.com/playwright:v1.50.0-no

### Modify and preview documentation

1. Run `pnpm start --filter documentation` from within the `root` directory.
2. Locate the docs to modify inside `/packages/documentation/docs/`.
The documentation source is maintained in a separate repository: [siemens/ix-docs](https://github.com/siemens/ix-docs). This repository contains all relevant markdown files and Figma assets.

If you need to update only the preview or code examples, you can do so by following the instructions in the next section.

#### Preview and example code

Expand All @@ -236,20 +237,6 @@ These packages contain playground applications to explore and test the respectiv
The preview source code for the documentation is also located inside the `x-test-app`'s. (`src/preview-examples`)
These preview-examples will be translated to markdown files and get copied into `./packages/documentation/docs/auto-generated/previews`.

#### Figma integration

> You need to have access to the internal figma library

To see all image references it is necessary to create a personal access token (https://www.figma.com/developers/api#access-tokens).

Store the token as environment variable "FIGMA_API_TOKEN" or in the .env file inside project root.

Serve documentation [locally](http://localhost:3000/siemens-ix/)

```sh
pnpm start --filter=documentation
```

### Submit Pull Request

1. [Create a new pull request](https://github.com/siemens/ix/compare) with the `main` branch as the `base`. You may need to click on `compare across forks` to find your changes.
Expand Down
32 changes: 1 addition & 31 deletions packages/documentation/.gitignore
Original file line number Diff line number Diff line change
@@ -1,31 +1 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*


static/demo/v*/angular
static/demo/v*/html
static/demo/v*/react
static/demo/v*/vue
static/demo/v*/preview
static/usage


docs/autogenerated
build/
42 changes: 3 additions & 39 deletions packages/documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,5 @@
# Website
# Documentation for Siemens Industrial Experience

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
> The documentation and all of it's markdown files where moved to [https://github.com/siemens/ix-docs](https://github.com/siemens/ix-docs).

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
This package contains the artifacts for uploading the preview examples of the test-apps.
3 changes: 0 additions & 3 deletions packages/documentation/babel.config.js

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading