-
Notifications
You must be signed in to change notification settings - Fork 15
Restructure documentation #811
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
base: main
Are you sure you want to change the base?
Conversation
- restructure java docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure to also update any changed xrefs to java-aspect-tooling.adoc for sections that have moved. For example in samm-cli.adoc
line 200 there is xref:java-aspect-tooling.adoc#databricks-type-mapping[Databricks type mapping]
which needs to be changed to xref:java-code-generation.adoc#databricks-type-mapping[Databricks type mapping]
. There may be others.
documentation/developer-guide/modules/tooling-guide/pages/java-aas-mapping.adoc
Outdated
Show resolved
Hide resolved
documentation/developer-guide/modules/tooling-guide/pages/java-aas-mapping.adoc
Outdated
Show resolved
Hide resolved
:page-partial: | ||
|
||
[[mapping-aas]] | ||
= Mapping Aspect Models to Asset Administration Shell (AAS) Submodel Templates |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section should be moved to an own top-level topic (outside of the Java APIs section), because it is not Java-specific.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that we have a dedicated top-level section on Java APIs, the content of the current "Using Java Static Meta Classes" section (i.e. everything in documentation/modules/static-metaclasses) should be moved here.
- Create a new page
modules/tooling-guide/pages/java-static-meta-classes.adoc
that contains the contents ofmodules/static-metaclasses/pages/*.adoc
(in the order index, basic-usage, advanced-usage). Header levels might need to be adjusted. - Add page-aliases to the new .adoc to make sure that links don't break when people try to use bookmarks
- Add a corresponding entry here in nav.adoc
- Remove the static-metaclasses module
Description
Update java docs.
Fixes #803
Type of change
Checklist:
Additional notes