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

Migrate site to markdown? #725

Closed
jarmoniuk opened this issue Sep 28, 2022 · 3 comments
Closed

Migrate site to markdown? #725

jarmoniuk opened this issue Sep 28, 2022 · 3 comments

Comments

@jarmoniuk
Copy link
Contributor

jarmoniuk commented Sep 28, 2022 •
edited

Just an idea. Should we migrate the site to markdown? Easier to maintain imho, plus it's compatible with github and many tools including builtin plugin in IntelliJ

https://illegalexception.schlichtherle.de/maven/2013/06/17/how-to-use-markdown-syntax-with-the-maven-site-plugin/
@sultan
Copy link
Contributor

sultan commented Sep 29, 2022

other projects like TomEE use asciidoc, but Markdown is a bit simpler to use and generate html. no dependencies on jbake or the kind. difficulty arised trying migrating all the pages... and not loose content.

maintaining the docs with any LML has been a breeze for me these past months.
MD has almost no entry cost for accustomed github users.

@slawekjaranowski
Copy link
Member

We can do it - please one document per one PR.

By the way content should be verified if is still valid and corresponding to current implementations ... 😄

  • .vm files is only needed if we have properties in document

  • instead of # for headers - we can use

Header level 1
===========

Header level 2 
--------------

jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 3, 2022
@jarmoniuk
mojohaus#725: Migrating index.apt to markdown
13b35b7
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 3, 2022
@jarmoniuk
mojohaus#725: Migrating index.apt to markdown
4627a9c
@pzygielo pzygielo mentioned this issue Oct 3, 2022
Merged
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 3, 2022
@jarmoniuk
mojohaus#725: Migrating index.apt to markdown
0cbdb8e
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 4, 2022
@jarmoniuk
mojohaus#725: Migrating index.apt to markdown
b889583
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 6, 2022
@jarmoniuk
mojohaus#725: Migrating Usage to markdown
a10ab36
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 6, 2022
@jarmoniuk
mojohaus#725: Migrating Usage to markdown
2d63929
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 6, 2022
@jarmoniuk
mojohaus#725: Migrating Usage to markdown
273bb8b
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 6, 2022
@jarmoniuk
mojohaus#725: Migrating Version Rules to markdown
bca641f
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 6, 2022
@jarmoniuk
mojohaus#725: Migrating Version Rules to markdown
613c740
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 7, 2022
@jarmoniuk
mojohaus#725: Migrating FAQ to markdown
d0d6cd6
slawekjaranowski pushed a commit that referenced this issue Oct 7, 2022
@jarmoniuk @slawekjaranowski
#725: Migrating index.apt to markdown
3063fd0
slachiewicz pushed a commit that referenced this issue Oct 7, 2022
@jarmoniuk @slachiewicz
#725: Migrating FAQ to markdown
3b57415
slachiewicz pushed a commit that referenced this issue Oct 7, 2022
@jarmoniuk @slachiewicz
#725: Migrating Version Rules to markdown
736f87b
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 8, 2022
@jarmoniuk
mojohaus#725: Migrating Usage to markdown
d4833dd
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 9, 2022
@jarmoniuk
mojohaus#725 Migrating "Advancing dependency versions" to Markdown
924f308
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 9, 2022
@jarmoniuk
mojohaus#725: Migrating Usage to markdown
d6e248f
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 9, 2022
@jarmoniuk
mojohaus#725: Migrating Usage to markdown
b057275
slawekjaranowski pushed a commit that referenced this issue Oct 9, 2022
@jarmoniuk @slawekjaranowski
#725: Migrating Usage to markdown
3e1278d
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 10, 2022
@jarmoniuk
mojohaus#725: Migrating Compare dependency versions
ed8526d
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 10, 2022
@jarmoniuk
mojohaus#725: Migrating display-dependency-updates.apt
6cb0842
slawekjaranowski pushed a commit that referenced this issue Oct 10, 2022
@jarmoniuk @slawekjaranowski
#725 Migrating "Advancing dependency versions" to Markdown
021e437
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 10, 2022
@jarmoniuk
mojohaus#725: Migrating the plugin dependency updates example + corre…
a2235ac 
…cting a typo in the "author" metadata
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 10, 2022
@jarmoniuk
mojohaus#725: Migrating Compare dependency versions
d8f6809
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 10, 2022
@jarmoniuk
mojohaus#725: Migrating display-dependency-updates.apt
ccb7e1c
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 10, 2022
@jarmoniuk
mojohaus#725: Migrating display-dependency-updates.apt
3496206
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 10, 2022
@jarmoniuk
mojohaus#725: Migrating display-dependency-updates.apt
1ef364c
slawekjaranowski pushed a commit that referenced this issue Oct 10, 2022
@jarmoniuk @slawekjaranowski
#725: Migrating Compare dependency versions
2c16f8e
slawekjaranowski pushed a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 12, 2022
@jarmoniuk @slawekjaranowski
mojohaus#725: Migrating display-dependency-updates.apt
0d15da8
slawekjaranowski pushed a commit that referenced this issue Oct 12, 2022
@jarmoniuk @slawekjaranowski
#725: Migrating display-dependency-updates.apt
8a21578
slawekjaranowski pushed a commit that referenced this issue Oct 14, 2022
@jarmoniuk @slawekjaranowski
#725: Migrating the plugin dependency updates example + correcting a …
c206f78 
…typo in the "author" metadata
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 21, 2022
@jarmoniuk
mojohaus#725: Migrate display-property-updates.apt to Markdown
dc49a01
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 21, 2022
@jarmoniuk
mojohaus#725: Migrate display-property-updates.apt to Markdown
4a910be
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 22, 2022
@jarmoniuk
mojohaus#725: Migrating Lock Snapshots to Markdown
8a018db
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 22, 2022
@jarmoniuk
mojohaus#725: Migrating Resolve Ranges to Markdown
089119c
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 22, 2022
@jarmoniuk
mojohaus#725: Migrating Set to Markdown
b850f89
slachiewicz pushed a commit that referenced this issue Oct 22, 2022
@jarmoniuk @slachiewicz
#725: Migrating Resolve Ranges to Markdown
61f7411
slachiewicz pushed a commit that referenced this issue Oct 22, 2022
@jarmoniuk @slachiewicz
#725: Migrate display-property-updates.apt to Markdown
8ee15b7
slachiewicz pushed a commit that referenced this issue Oct 22, 2022
@jarmoniuk @slachiewicz
#725: Migrating Lock Snapshots to Markdown
32345e2
slachiewicz pushed a commit that referenced this issue Oct 22, 2022
@jarmoniuk @slachiewicz
#725: Migrating Set to Markdown
27a9b5f
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 23, 2022
@jarmoniuk
mojohaus#725: Migrate Recording Changes to Markdown
19bbb7b
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 23, 2022
@jarmoniuk
mojohaus#725: Migrate Set Aggregator to Markdown
60ad08d
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 23, 2022
@jarmoniuk
mojohaus#725: Migrate Unlock Snapshots to Markdown
23107a3
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 23, 2022
@jarmoniuk
mojohaus#725: Migrate Update Child Modules to Markdown
fc1568d
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 23, 2022
@jarmoniuk
mojohaus#725: Migrate Update Parent to Markdown
8bbbd0e
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 23, 2022
@jarmoniuk
mojohaus#725: Migrate Update Properties to Markdown
a4701e3
jarmoniuk added a commit to jarmoniuk/versions-maven-plugin that referenced this issue Oct 23, 2022
@jarmoniuk
mojohaus#725: Migrate Use Releases to Markdown
172e15c
slachiewicz pushed a commit that referenced this issue Oct 26, 2022
@jarmoniuk @slachiewicz
#725: Migrate Update Properties to Markdown
a3f0515
slachiewicz pushed a commit that referenced this issue Oct 26, 2022
@jarmoniuk @slachiewicz
#725: Migrate Use Releases to Markdown
abc2e97
slachiewicz pushed a commit that referenced this issue Oct 26, 2022
@jarmoniuk @slachiewicz
#725: Migrate Update Child Modules to Markdown
f793fe1
slachiewicz pushed a commit that referenced this issue Oct 26, 2022
@jarmoniuk @slachiewicz
#725: Migrate Unlock Snapshots to Markdown
b3ae892
slachiewicz pushed a commit that referenced this issue Oct 26, 2022
@jarmoniuk @slachiewicz
#725: Migrate Update Parent to Markdown
07fcf53
slachiewicz pushed a commit that referenced this issue Oct 26, 2022
@jarmoniuk @slachiewicz
#725: Migrate Recording Changes to Markdown
98a002f
slachiewicz pushed a commit that referenced this issue Oct 26, 2022
@jarmoniuk @slachiewicz
#725: Migrate Set Aggregator to Markdown
cdd2446
@jarmoniuk
Copy link
Contributor Author

@slawekjaranowski @slachiewicz I think this can be closed 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jarmoniuk @slawekjaranowski @sultan @slachiewicz