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

Permalink to chapter JSON Mapping Rules in schemas/json/README.md #247

Closed
BirgitBoss opened this issue Nov 23, 2022 · 7 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@BirgitBoss
Copy link
Collaborator

https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json#json-mapping-rules
does not link to chapter JSON Mapping rule but is identical to
https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json

Used in Spec Part 1 for referencing to mapping rules

@BirgitBoss BirgitBoss added the documentation Improvements or additions to documentation label Nov 23, 2022
@s-heppner
Copy link
Collaborator

I think the link you were looking for, to link the the chapter Mapping Rules in the JSON-Readme is this: https://github.com/admin-shell-io/aas-specs/blob/master/schemas/json/README.md#mapping-rules

@s-heppner s-heppner changed the title label for chapter JSON Mapping Rules for linking in spec. Permalink to chapter JSON Mapping Rules in schemas/json/README.md Apr 5, 2023
@s-heppner
Copy link
Collaborator

s-heppner commented Apr 5, 2023

Considering, that the file behind the link will get upgraded with the new versions and you might want to actually permanentally link to the File released in https://github.com/admin-shell-io/aas-specs/releases/tag/v3.0.6, I'd suggest using this link: https://github.com/admin-shell-io/aas-specs/blob/37e4492a82c37040a395923ad4c74901835bb3c6/schemas/json/README.md#mapping-rules, since it will permanentally link to the state of the file at the time of the Release.

@s-heppner
Copy link
Collaborator

@BirgitBoss BirgitBoss added this to the V3.1 milestone Dec 12, 2023
@s-heppner
Copy link
Collaborator

I'm actually not sure what needs to be done here. It seems like originally, there's a link somewhere that reads:
https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json#json-mapping-rules
but does not link to the relevant section of the JSON Readme (as it was probably renamed at some point).

I've provided suggestions for links:

If you want to always link to the most up to date one, I'd use:
https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json#mapping-rules

If you want to reference the rules as they were at a specific release:
https://github.com/admin-shell-io/aas-specs/blob/v3.0.6/schemas/json/README.md#mapping-rules
(where v3.0.6 is the respective release tag)

Sadly, I do not know where that false link is located, so I'm unable to do anything else.

@BirgitBoss
Copy link
Collaborator Author

It is an important part of the specification and thus must be part of the release.

The file to be changed is mentioned in the title

@s-heppner
Copy link
Collaborator

Could you please provide a link to the location to be changed?
I've searched in the file: https://github.com/admin-shell-io/aas-specs/blob/master/schemas/json/README.md

and I'm unable to find the link https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json#json-mapping-rules there.

@BirgitBoss
Copy link
Collaborator Author

now part of specification itself, see #493. This issue is therefore closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants