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 documentation to AsciiDoc #273

Merged
merged 58 commits into from
Jan 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
e897927
Add initial set of AsciiDoc files, converted from HTML/XML
kriegaex Jun 29, 2021
98cd1e6
Fix some AsciiDoc links (WIP)
kriegaex Jul 13, 2021
8eda7b8
Fix more AsciiDoc links and code blocks (WIP)
kriegaex Jul 16, 2021
0e20cb9
More AsciiDoc improvements, mostly about code formatting (WIP)
kriegaex Jul 16, 2021
17c6e39
Finish AsciiDoc improvements in ADK Developer's Notebook (WIP)
kriegaex Jul 17, 2021
dac0874
Improve release notes formatting
kriegaex Jul 19, 2021
9913cb6
More AsciiDoc formatting improvements (WIP)
kriegaex Jul 19, 2021
f9da594
Remove outdated JDeveloper links from AsciiDocs
kriegaex Jul 20, 2021
c506bde
Globally replace HTTP links to eclipse.org by HTTPS
kriegaex Jul 23, 2021
b908c3d
Globally fix spelling error "dependancy/dependancies"
kriegaex Jul 23, 2021
6bf9f32
AsciiDoc: updates in main index and FAQ (WIP)
kriegaex Jul 24, 2021
948c292
Remove all references to AOSD, but mention Spring
kriegaex Aug 10, 2021
ad67210
Experimentally add asciidoctor-maven-plugin to 'docs' module
kriegaex Jan 8, 2022
ffee77b
Rename '*GuideDB' directories to their actual HTML site target names
kriegaex Jan 8, 2022
bd20470
Add README-198.adoc, README-199.adoc
kriegaex Oct 9, 2021
e972f66
Merge branch 'master' into docs-to-asciidoc
kriegaex Jan 2, 2024
4cadfae
Add asciidoc release notes up to 1.9.21
kriegaex Jan 2, 2024
30c4498
Move main documentation index for website to root directory
kriegaex Jan 3, 2024
7705fb2
Fix most xref/link URLs in main documentation index
kriegaex Jan 3, 2024
9da5e38
Remove 'imagesdir' from Asciidoctor Maven config
kriegaex Jan 3, 2024
90f75b5
Remove references and docs about obsolete tools
kriegaex Jan 3, 2024
48e722d
Adjust design overview docs to other multi-page docs
kriegaex Jan 3, 2024
77b56b8
Fix/add more links for multi-page docs
kriegaex Jan 3, 2024
d7eca7e
Delete 50+ XML DocBook resource files
kriegaex Jan 4, 2024
1c9fd47
Bulk-rename release read-me files to version numbers with dots
kriegaex Jan 4, 2024
d887c2d
Move docs examples directory two levels up
kriegaex Jan 4, 2024
6cc1372
Move quick reference DOC/PDF files to separate directory
kriegaex Jan 4, 2024
d15b28d
Move release notes README-*.adoc to separate directory
kriegaex Jan 4, 2024
f1d0e88
Fix referenced images in README-1.6.7
kriegaex Jan 4, 2024
817bee7
Move JavaVersionCompatibility.md to release directory
kriegaex Jan 4, 2024
5ff09e7
Rename JavaVersionCompatibility.md to .adoc
kriegaex Jan 4, 2024
f3ce5cf
Change syntax in JavaVersionCompatibility.adoc to asciidoc
kriegaex Jan 4, 2024
0325a2e
Link to Java version compatibility matrix from main docs page
kriegaex Jan 4, 2024
b1b9275
Reformat asciidoc source for main docs page
kriegaex Jan 4, 2024
3c741e8
Move main license and readme files to docs root directory
kriegaex Jan 4, 2024
571d060
Move compiler-weaver.adoc up one directory level
kriegaex Jan 4, 2024
88b8a8c
Adjust image links in compiler-weaver.adoc
kriegaex Jan 4, 2024
478ec1c
Rename Visio files for images used in compiler-weaver.adoc
kriegaex Jan 4, 2024
3e016c0
Move progguide images to subfolder
kriegaex Jan 4, 2024
9cecda4
Delete some unused images from docs
kriegaex Jan 4, 2024
577550d
Move image used in IDE.md to images subfolder
kriegaex Jan 4, 2024
bca24eb
Fix warning in Asciidoctor Maven by JRuby version bump
kriegaex Jan 4, 2024
b716946
README.md: Beautify link to Maven Central
kriegaex Jan 4, 2024
294632d
Fix some broken/invalid ADOC links
kriegaex Jan 4, 2024
86cfebc
Rename docs GIF to PNG
kriegaex Jan 5, 2024
fdb35dd
Replace docs GIFs by PNGs
kriegaex Jan 5, 2024
8ebb469
Asciidoc: Create PDFs from multi-page guides
kriegaex Jan 5, 2024
7392146
Rename doc generation profiles, making Asciidoctor the default
kriegaex Jan 5, 2024
3b55fb9
Minor changes in IDE.md
kriegaex Jan 5, 2024
39a53b9
Bugfix: AspectJ installer extracts text files as US-ASCII
kriegaex Jan 5, 2024
9e47dc0
Docs: Create separate CSS files, do not embed into HTML
kriegaex Jan 6, 2024
bbd7013
Add runtime and weaver API javadocs to installer again
kriegaex Jan 6, 2024
31a52d2
Add local Maven site to 'distributionManagement'
kriegaex Jan 6, 2024
9775595
Remove obsolete DocBook build config in favour of Asciidoctor
kriegaex Jan 6, 2024
e655647
Rename readme-lib-module.html to .adoc
kriegaex Jan 6, 2024
db97607
Replace HTML content of readme-lib-module.adoc by asciidoc
kriegaex Jan 6, 2024
e67a0d9
CI build: fix "create docs" step
kriegaex Jan 6, 2024
0c6dcf7
Fix docs links to example source code
kriegaex Jan 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ jobs:
aspectjtools/target/flattened-pom.xml

- name: Create docs
run: ./mvnw -B --file pom.xml -DskipTests process-resources -pl docs -P create-docs
run: ./mvnw -B --file pom.xml -DskipTests package -pl docs -P create-docs

- name: Attach docs to build
uses: actions/upload-artifact@v3
Expand Down
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,10 @@ bin/
/lib/provisioned.marker
/lib/ant/
/lib/commons/
/lib/docbook/
/lib/jarjar/
/lib/jdtcore-aj/
/lib/junit/
/lib/regexp/
/lib/saxon/

# AspectJ core dumps
ajcore.*.txt
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ Ensure you run this with a JDK - the more recent the better since some tests wil
* [Setting up a development environment](docs/developer/IDE.md)
* [Getting started with AspectJ](https://www.eclipse.org/aspectj/doc/released/progguide/starting.html)
* [Programming Guide](https://www.eclipse.org/aspectj/doc/released/progguide/index.html)
* [READMEs for each version of AspectJ](docs/dist/doc)
* [AspectJ Java version compatibility](docs/dist/doc/JavaVersionCompatibility.md)
* [READMEs for each version of AspectJ](docs/release)
* [AspectJ Java version compatibility](docs/release/JavaVersionCompatibility.adoc)

## Documentation for AspectJ developers

Expand All @@ -55,4 +55,4 @@ Ensure you run this with a JDK - the more recent the better since some tests wil

## Maven releases

AspectJ is published to maven central under the `org.aspectj` groupID: https://search.maven.org/search?q=g:org.aspectj
AspectJ is published to Maven Central under [group ID `org.aspectj`](https://search.maven.org/search?q=g:org.aspectj).
47 changes: 0 additions & 47 deletions ajde/AJDE.jpx

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public ErrorDialog(Frame owner, String title, Throwable throwable, String messag
String exceptionName = "<unknown exception>";
if (throwable != null) exceptionName = throwable.getClass().getName();
this.error_label1.setText("Exception: " + exceptionName);
this.error_label2.setText("If you can't fix it, please submit a bug to http://dev.eclipse.org/bugs");
this.error_label2.setText("If you can't fix it, please submit a bug to https://dev.eclipse.org/bugs");
this.stackTrace_textArea.setText("Message: " + message + '\n' + "Stack trace: " + details);
this.setSize(420, 330);
this.setLocationRelativeTo(owner);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ public class OptionsFrame extends JFrame {
"conforming to the Open Source Definition.\n\n" +
"For support or for more information about the AspectJ\n" +
"project or the license, visit the project home page at\n" +
" http://eclipse.org/aspectj\n\n" +
" https://eclipse.org/aspectj\n\n" +
"If you find a bug (not solved by the documentation in the\n" +
"Development Environment Guide available with this release,\n" +
"any release notes, or the bug database), please submit steps\n" +
"to reproduce the bug (using the IDE component) at:\n" +
" http://bugs.eclipse.org/bugs/enter_bug.cgi?product=AspectJ";
" https://bugs.eclipse.org/bugs/enter_bug.cgi?product=AspectJ";

private JTabbedPane main_tabbedPane = new JTabbedPane();
private JPanel button_panel = new JPanel();
Expand Down
28 changes: 28 additions & 0 deletions aspectjrt/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,34 @@
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy-javadoc-to-dist</id>
<phase>package</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<!--
Skip, if javadoc generation is also meant to be skipped, which is the default unless the 'release'
profile is active or the property is overridden manually to be false. See property definitions in parent
POM for default case and release profile.
-->
<skip>${maven.javadoc.skip}</skip>
<outputDirectory>${project.basedir}/../aj-build/dist/docs/doc/runtime-api</outputDirectory>
<resources>
<resource>
<directory>${project.build.directory}/apidocs</directory>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>

<!-- Caveat: Attaching the flattened POM needs packaging=jar, so do not use packaging=pom for this module -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
Expand Down
28 changes: 28 additions & 0 deletions aspectjweaver/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,34 @@
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy-javadoc-to-dist</id>
<phase>package</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<!--
Skip, if javadoc generation is also meant to be skipped, which is the default unless the 'release'
profile is active or the property is overridden manually to be false. See property definitions in parent
POM for default case and release profile.
-->
<skip>${maven.javadoc.skip}</skip>
<outputDirectory>${project.basedir}/../aj-build/dist/docs/doc/weaver-api</outputDirectory>
<resources>
<resource>
<directory>${project.build.directory}/apidocs</directory>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>

<!-- Caveat: Attaching the flattened POM needs packaging=jar, so do not use packaging=pom for this module -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
Expand Down
4 changes: 2 additions & 2 deletions build/products/aspectj/install/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ <h2 align="center">Installer for AspectJ 9 Development Kit<sup><small>TM</small>
<p align="center">Version ${build.version.long} built on ${build.date}</p>
<p>This installs the complete AspectJ 9 Development Kit (AJDK) distribution, with
the compiler, aspect libraries, structure browser, ant tasks,
documentation, and examples.
documentation, and examples.
This distribution is covered by the Eclipse Public License v 2.0 (see
https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt).
<p>
For IDE integrations or source code, see the project home page at
http://eclipse.org/aspectj</p>
https://eclipse.org/aspectj</p>


<p>${copyright.allRights.from1998}</p>
Expand Down
4 changes: 2 additions & 2 deletions build/products/tools/install/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ <h2 align="center">Installer for AspectJ(TM) Compiler and Core Tools</h2>
<p>
This is a binary only release of tools made available under
the Eclipse Public License.
For more information on the license or to download the source code,
see http://eclipse.org/aspectj</p>
For more information on the license or to download the source code,
see https://eclipse.org/aspectj</p>
<p>${copyright.allRights.from1998}</p>
<p></p>

Expand Down
Loading
Loading