Port the site documentation from APT to Markdown - #297
Open
slachiewicz wants to merge 2 commits into
Open
Conversation
A pure rename, so that git records it and `git log --follow` and `git blame` still reach the history of each page after the conversion that follows. The content is still APT at this point and the site does not build between the two commits.
Straight port with no content change:
- ASF license header becomes a single block HTML comment
- ${project.name} stays the H1, so the file remains a .vm
- <<<code>>> becomes backticks, <<bold>> becomes **bold**
- {{{url}text}} becomes [text](url)
Generated site output is unchanged apart from <b> rendering as <strong>.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Converts the site documentation under
src/site/aptto Markdown. APT is a format onlyDoxia understands; Markdown is already supported by
maven-site-pluginout of the box,so no POM change is needed.
Converted with
doxia-converterand then cleaned up by hand:<<<code>>>becomesbackticks,
<<bold>>becomes**bold**,{{{url}text}}becomes[text](url), and theASF licence header becomes a single block HTML comment. The page interpolates Velocity
properties, so it stays a
.md.vm.The change is split into two commits: a pure rename, so that
git log --followandgit blamestill reach the page's history, and then the conversion itself. Please mergeor rebase rather than squash, or the rename is collapsed and that history is lost again.
Verified by building the site before and after the change and comparing the generated
page: the visible text and the link targets are unchanged.
Part of the wider migration tracked in
apache/maven-doxia-converter#139