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

Convert xdoc (without parsing) to Markdown #621

Merged
merged 8 commits into from
Jan 4, 2025

Conversation

Bukama
Copy link
Contributor

@Bukama Bukama commented Jan 2, 2025

After by tests of HTTP meta properties (see results DOXIASITETOOLS-358) I converted all of those xdoc files to Markdown where no parsing/calculation happens. We can do this when we have a parser for this.

Please note

General

  • HTTP standard about meta tag for author (<meta name="author" content="name of author">) does not define an attribute for the email of the author. The content of those (like in mojo-api-specification.xml is not converted regardless of xdoc or markdown).

In the articles.md:

I did the following changes

  • updated or removed links to buy the books,
  • updated the link to the video
  • changed the divs to a table for a more similar layout and because inside of divs not markdown is possible and I didn't want to copy all HTML.

I did not

  • updated the articles list, even that there a tons of not-exists-anymore or unsafe (http instead of https) links,
  • added the text and video of Karl Heinz (see Added Video Link. #324)

Simply because I realized that it's far more than transformation then. I would like to update the list and add Karl Heinz's video and other articles and videos to the list in a separate PR (pr an updated 324).

In the mojo-api-specification.md

  • I moved the sentence about Maven 4 to the top, similar to the "multi module guide" and added Maven 3 to the tile
  • I did not converted the commented out code, which is not rendered by the xdoc converter at the moment too, so no content loss here

In the repository.index.md
I did copy the image map, because I'm not happy yet with my plantUML image. Therefore I also moved the .odgfiles.

In the scm.md
I added table headers and created own tables for each section (on live there are partly filled table rows used as in between headers).

@Bukama Bukama marked this pull request as draft January 2, 2025 20:34
@Bukama
Copy link
Contributor Author

Bukama commented Jan 2, 2025

Converted to draft, because I remembered that I wanted to add the JIRA links for the plugins (instead)

Bukama added 7 commits January 3, 2025 22:16
Added Maven 3 to title
Not converting content that is not shown in rendered site anymore
* Diagram not converted to PUML yet, cause I'm not that happy with my first tries
@Bukama Bukama marked this pull request as ready for review January 3, 2025 21:18
@Bukama
Copy link
Contributor Author

Bukama commented Jan 3, 2025

Added issue links and rebased after master's changes. Ready for review.


## Maven Sources Overview

![Maven Sources: Site](maven-sources/site.svg)
Copy link
Member

Choose a reason for hiding this comment

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

Next issue for markdown ... in version generated from xdoc we have <object ...> in output html.
With img tag links in svg are not working ...

@kwin @michael-o can you look?

Copy link
Member

Choose a reason for hiding this comment

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

ok, I see we can add a html code to markdown ... so should be
<object ..../> as in old document version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated:
Note Manual

tags needed to align the images below each other. Without them they were all next to each other

Manuall <p> tags needed to align the images below each other
@slachiewicz slachiewicz added documentation Improvements or additions to documentation maintenance labels Jan 4, 2025
Copy link
Member

@slachiewicz slachiewicz left a comment

Choose a reason for hiding this comment

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

Good to go, we can improve later

@slachiewicz slachiewicz merged commit 32de595 into apache:master Jan 4, 2025
1 check passed
@Bukama Bukama deleted the convertxdoc branch January 4, 2025 16:45
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 maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants