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.

Sign up for GitHub

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

Jump to bottom

Fix broken xrefs and JSON examples in docs #448

Merged
merged 7 commits into from
Jul 16, 2024
Merged

Fix broken xrefs and JSON examples in docs #448

merged 7 commits into from
Jul 16, 2024

Conversation

zrgt
Copy link
Collaborator

@zrgt zrgt commented Jul 5, 2024 •
edited
Loading

  • Fixed broken xrefs
  • Added explicit block_ids to sections used in xrefs
  • Fixed JSON examples
  • Added file extension to xrefs, where it was missing
  • Renamed Introduction.adoc to introduction.adoc
    to be consistent with other files

zrgt added 6 commits July 6, 2024 00:30
@zrgt
Rename Introduction.adoc to introduction.adoc
f8fa3ff
@zrgt
Add file extension to xrefs
469d2fa 
Antora xref should always have a file extension; skipping the extension '.adoc' is deprecated from Antora 3.0 onwards
@zrgt
Fix JSON examples
d54267e 
" was missing
@zrgt
Add explicit block_ids to sections
67c6bd5
@zrgt
Fix xrefs
b250408 
some xrefs were not resolvable, as paths were wrong. In this commmit we fixed the paths.
@zrgt
Add explicit block_ids to sections
50a7385
@zrgt zrgt requested a review from BirgitBoss July 5, 2024 23:01
@zrgt zrgt changed the title Fix broken xrefs and JSON examples Fix broken xrefs and JSON examples in documentation Jul 5, 2024
BirgitBoss
BirgitBoss requested changes Jul 6, 2024
View reviewed changes
Copy link
Collaborator

@BirgitBoss BirgitBoss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you remove blanks bevor . ?
I would say end. Go on and not end.Go on

@zrgt zrgt changed the title Fix broken xrefs and JSON examples in documentation Fix broken xrefs and JSON examples in docs Jul 9, 2024
@zrgt
Copy link
Collaborator Author

zrgt commented Jul 9, 2024

@BirgitBoss This was done automatically by my IDE. I've now put them back in.

@zrgt zrgt requested a review from BirgitBoss July 9, 2024 09:37
@zrgt zrgt requested review from BirgitBoss and removed request for BirgitBoss July 16, 2024 09:47
@BirgitBoss BirgitBoss merged commit 35cceca into IDTA-01001-3-1_working Jul 16, 2024
2 of 3 checks passed
BirgitBoss
BirgitBoss reviewed Jul 16, 2024
View reviewed changes
Copy link
Collaborator

@BirgitBoss BirgitBoss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved

@zrgt zrgt deleted the IgGa/EditorialChanges branch July 19, 2024 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BirgitBoss BirgitBoss BirgitBoss requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zrgt @BirgitBoss