Skip to content
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

prepare antora documentation #336

Closed
wants to merge 67 commits into from

Conversation

BirgitBoss
Copy link
Collaborator

  • new folder structure for documents
  • instead of includes use * xref: in nav.adoc
  • chapter structure updated

BirgitBoss and others added 30 commits December 20, 2023 15:16
The following changes were made:

* Introduce nav.adoc as entry point with includes

* Split Annex: into shared parts (UML, UML Templates, 
Back-Naur-Form, Bibliography, Terms & Definitions) 
and specific parts
 (ChangeLog, Concepts AAS, Metamodel with Inheritance, 
Requirements, Usage Metamodel)

* Extract Preamble from rest of document

* Within Preamble extract Conformance and Versioning and move to Shared Sections

* add index.adoc as start page for antora (preparation)
…ization of metamodel element "Reference" into separate files
…"General Rules".

So new file for embedded data specifications was created and
text was moved to original file again.
Figure embedded data spec was updated (note arrow between EmbeddedDataSpecification and DataSpecification)
+ updated figures for UML Annex (From E/A) +
fix that one figure was referenced twice
Now generated link in html works.
+
Note fixed
ot be displayed as html-link: fixed in examples
+ source made italic without bullet point +
added links to metamodel abbreviations
* Fix refs to AasReferableNonIdentifiables

* Rename "Sections" dir to "pages" as standard in Antora

* Rename "Sections" dir to "pages" as standard in Antora

* Move Annex dirs in pages dir

Annex should be a subdir of pages

* Fix include refs acc. to Antora

See https://docs.antora.org/antora/latest/page/include-a-page/

* Remove definition of imagesdir, as already done by Antora

* Fix xref macro reference

See: https://docs.antora.org/antora/latest/page/xref/

* Fix examples for valid model references

* Move images as they belong to IDTA-01xxx_UML.adoc

* Remove refs from Abbreviations table

* Fix all xrefs acc. to Antora

See: https://docs.antora.org/antora/latest/page/xref/

* Add example ref to an image

---------

Co-authored-by: zrgt <garmaev@gmx.de>
 (one table instead of two for classes and enumerations)
+
new table row for metamodel ID
+ add metamodel IDs to Normative Part
- update UML template for table
- update metamodel element ID if it uses elements with type "Identifier" or inherits from Referable (change type of idShort)
+ updates in changelog for Referable/idShort et.al.
changed from include to * xref: for antora
was renamed to IDTA-01001-Metamodel.adoc
pages/sharedAnnex resp.
pages/includes resp.
@BirgitBoss BirgitBoss requested a review from zrgt January 31, 2024 12:41
now use antora for generation
relax grammar for data specification IDs
do not introduce idShort for Data Specifications (revert change)
@zrgt
Copy link
Collaborator

zrgt commented Feb 1, 2024

There are some commits which exist in IDTA-01001-3-1_working, but not in BiBo/IDTA-01001-3-1_working:

That's why we have conflicts which we should resolve. @BirgitBoss we can ignore most of them as the same was already done in other commits in BiBo/IDTA-01001-3-1_working. But what about the last two commits: 9465ab1 ff25818 ?

@BirgitBoss
Copy link
Collaborator Author

BirgitBoss commented Feb 1, 2024

There are some commits which exist in IDTA-01001-3-1_working, but not in BiBo/IDTA-01001-3-1_working:

* [9465ab1](https://github.com/admin-shell-io/aas-specs/commit/9465ab1f94749e04271a63ea5899d522c0c83d21) Correct AASd-002 Birgit Boss* 26.01.2024 18:11

* [ff25818](https://github.com/admin-shell-io/aas-specs/commit/ff25818696adef7d6d3acbd229784ba983567924) semanticId of specificAssetId with name "globalAssetId" [Constraint AASd-116 globalAssetId semanticId for SpecificAssetId #298](https://github.com/admin-shell-io/aas-specs/issues/298) Birgit Boss 18.12.2023 14:47

That's why we have conflicts which we should resolve. @BirgitBoss we can ignore most of them as the same was already done in other commits in BiBo/IDTA-01001-3-1_working. But what about the last two commits: 9465ab1 ff25818 ?

Thank you for checking

The two last commits are also already contained (although AASd-002 is not yet in the final version, we are still in discussion). So my impression we can overwrite everything with this PR?

BirgitBoss added a commit that referenced this pull request Feb 2, 2024
BirgitBoss added a commit that referenced this pull request Feb 2, 2024
@BirgitBoss
Copy link
Collaborator Author

conflicts resolved with #337

@BirgitBoss BirgitBoss closed this Feb 2, 2024
@BirgitBoss BirgitBoss deleted the BiBo/IDTA-01001-3-1_working branch February 2, 2024 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants