Skip to content

Commit 7a16e07

Browse files
committed
Migrated Docusaurus from version 2 to 3 (#10).
1 parent 70c0464 commit 7a16e07

10 files changed

Lines changed: 14059 additions & 8107 deletions

File tree

‎jamopp.doc/docs/development/workflow.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ For the development of the extended JaMoPP, we base the workflow on the Gitflow
44

55
1. While the `main` branch hosts the source code of all releases with Git tags, all changes are primarily merged into the (default) `develop` branch.
66
1. For every bug, feature, release, and other issue, a [GitHub issue](https://github.com/MDSD-Tools/TheExtendedJavaModelParserAndPrinter/issues) needs to be created.
7-
1. For the resolution of an issue (except releases), there should be a separate feature branch, usually branched from the current `develop` branch, with the name `<issue number>_<meaningful_short_issue_description_with_words_separated_by_underscores>`. Please consider the `CHANGELOG.md` and this documentation, and update them if necessary.
7+
1. For the resolution of an issue (except releases), there should be a separate feature branch, usually branched from the current `develop` branch, with the name `<issue_number>_<meaningful_short_issue_description_with_words_separated_by_underscores>`. Please consider the `CHANGELOG.md` and this documentation, and update them if necessary.
88
1. If the changes are ready for merging, a pull request needs to be created for meging the feature branch into the `develop` branch. It is reviewed by at least one person. After all comments and issues within the pull request are resolved and the pull request is approved, it is merged, closing the pull request and corresponding GitHub issue.
99
1. For a release:
1010
1. The following parts should be adapted on the `develop` branch:

‎jamopp.doc/docs/getting-started/advanced_features.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ classDiagram
159159

160160
Compared to the first visualization without the `calc` method, the model now includes the method. As a consequence, the parameters, return type (`typeReference` in the actual model), and the statements of the method are also represented with corresponding model elements. In particular, the `AdditiveExpression` for the addition of `a` and `b` contains `IdentifierReference` elements signaling that identifiers are present at this position in the Java code. The actual referenced elements (the method parameters) can be accessed via the `target` EMF reference.
161161

162-
:::caution
162+
:::warning
163163
The term `Reference` has a double meaning here:
164164

165165
1. It refers to identifiers (referencing types, fields, methods, ...) in Java code which are usually represented by `Reference` elements in the Java meta-model.

‎jamopp.doc/docs/getting-started/first_steps.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: First Steps
77

88
This document provides a minimal tutorial on how to use the extended JaMoPP to create your first models from Java code.
99

10-
:::caution
10+
:::warning
1111
This tutorial assumes that you are familiar with the Eclipse Modeling Framework (EMF). In case you want more information about EMF or Eclipse, we provide a [list of external resources and tutorials](./resources).
1212
:::
1313

@@ -65,7 +65,7 @@ packageElement.getNamespaces().add(packageName);
6565
cu.getClassifiers().get(0).setPackage(packageElement);
6666
```
6767

68-
:::caution
68+
:::warning
6969
The created package element must be contained within a `Resource`. For simplicity, we left this part out.
7070
:::
7171

‎jamopp.doc/docs/getting-started/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Additionally, there is the following nightly P2 update site which provides artif
2121

2222
* [Nightly P2 Update Site](https://updatesite.mdsd.tools/extended-java-model-parser-and-printer/nightly/)
2323

24-
:::caution
24+
:::warning
2525

2626
The nightly update site can have different requirements (e.g., on the minimum Java version) compared to the latest release. So, before using it, please check the [`CHANGELOG` on the `develop` branch](https://github.com/MDSD-Tools/TheExtendedJavaModelParserAndPrinter/blob/develop/CHANGELOG.md) for the latest changes.
2727

‎jamopp.doc/docs/guides/printing.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ void print(JavaRoot root, Path file);
1717

1818
The first method prints the source code for the given root element into the `OutputStream`. Similarly, the second method prints the source code for an arbitrary model element into an `OutputStream`. At last, the third method prints the source code for a root element into a file, given by a `Path`. The printed source code is not pretty printed.
1919

20-
:::caution
20+
:::warning
2121
The printer assumes that the given models are valid.
2222
:::

‎jamopp.doc/docs/guides/resolution.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The extended JaMoPP provides three variants to resolve the references between di
1111

1212
Due to technical issues, the first variant is currently not available.
1313

14-
:::caution
14+
:::warning
1515
The corresponding class (`JaMoPPJDTParser`) is still included in the artifacts. However, it only returns empty models.
1616
:::
1717

@@ -29,7 +29,7 @@ When using the [`JaMoPPJDTSingleFileParser`](./parsing.md), the second variant i
2929

3030
During parsing, the second variant creates a proxy object for every reference. The generated proxy URI has the format &lt;`Base URI`&gt;`/EMFTEXT_INTERNAL_URI_FRAGMENT_`&lt;`counter`&gt;`_`&lt;`identifier`&gt; where `Base URI` equals the URI of the model in which the proxy object is located, `counter` is the value of a proxy object counter incremented for every proxy object, and `identifier` is the identifier in the Java source code pointing to the actual Java element. In addition, the second variant stores the context of the proxy object independently from the models, including, for instance, the container of the proxy object or the reference for which the proxy object is set.
3131

32-
:::caution
32+
:::warning
3333
If Java models with proxy objects are saved on disk, the proxy objects' context is not stored. As a result, if such models are loaded again in a new process, the context is not available, and the proxy objects can potentially be not resolved.
3434
:::
3535

‎jamopp.doc/docusaurus.config.js‎

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
// @ts-check
22
// Note: type annotations allow type checking and IDEs autocompletion
33

4-
const lightCodeTheme = require('prism-react-renderer/themes/github');
5-
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
4+
const { themes } = require('prism-react-renderer');
5+
const lightCodeTheme = themes.github;
6+
const darkCodeTheme = themes.dracula;
67

78
/** @type {import('@docusaurus/types').Config} */
89
const config = {
@@ -14,19 +15,22 @@ const config = {
1415
url: 'https://mdsd-tools.github.io',
1516
// Set the /<baseUrl>/ pathname under which your site is served
1617
// For GitHub pages deployment, it is often '/<projectName>/'
17-
baseUrl: '/',
18+
baseUrl: '/TheExtendedJavaModelParserAndPrinter/',
1819

1920
// GitHub pages deployment config.
2021
// If you aren't using GitHub pages, you don't need these.
2122
organizationName: 'MDSD-Tools', // Usually your GitHub org/user name.
2223
projectName: 'TheExtendedJavaModelParserAndPrinter', // Usually your repo name.
2324

2425
onBrokenLinks: 'throw',
25-
onBrokenMarkdownLinks: 'warn',
2626

2727
markdown: {
28-
mermaid: true
28+
mermaid: true,
29+
hooks: {
30+
onBrokenMarkdownLinks: 'warn'
31+
}
2932
},
33+
trailingSlash: false,
3034
themes: ['@docusaurus/theme-mermaid'],
3135

3236
// Even if you don't use internalization, you can use this field to set useful
@@ -92,15 +96,6 @@ const config = {
9296
footer: {
9397
style: 'dark',
9498
links: [
95-
{
96-
title: 'Docs',
97-
items: [
98-
{
99-
label: 'Documentation',
100-
to: '/docs/intro',
101-
},
102-
],
103-
},
10499
{
105100
title: 'More',
106101
items: [
@@ -115,7 +110,7 @@ const config = {
115110
],
116111
},
117112
],
118-
copyright: `Copyright © 2023 Modelling for Continuous Software Engineering (MCSE) group, Institute of Information Security and Dependability (KASTEL), Karlsruhe Institute of Technology (KIT).`,
113+
copyright: `Copyright © 2023-2025 Modelling for Continuous Software Engineering (MCSE) group, Institute of Information Security and Dependability (KASTEL), Karlsruhe Institute of Technology (KIT).`,
119114
},
120115
prism: {
121116
theme: lightCodeTheme,

0 commit comments

Comments
 (0)