Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Required steps:

## Security Model

**Authoritative Reference**: See [docs/user-manual/threat-model.adoc](docs/user-manual/threat-model.adoc) for the complete threat model including trust boundaries, adversary model, security properties provided/not provided, and triage dispositions.
**Authoritative Reference**: See [our threat model](docs/user-manual/modules/ROOT/pages/threat-model.adoc) for the complete threat model including trust boundaries, adversary model, security properties provided/not provided, and triage dispositions.

### Security Review Checklist
When reviewing code changes:
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Artemis is a project of the [Apache Software Foundation](https://apache.org) and

Before reporting a vulnerability please ensure:

- It falls within the scope of our [threat model](docs/user-manual/threat-model.adoc).
- It falls within the scope of our [threat model](docs/user-manual/modules/ROOT/pages/threat-model.adoc).
- It has not already been reported. Existing advisories are enumerated on [our website](https://artemis.apache.org/components/artemis/security).

To report a new vulnerability please follow the [ASF vulnerability reporting process](https://security.apache.org/report/).
Expand Down
34 changes: 34 additions & 0 deletions artemis-website/docs-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
site:
title: Apache Artemis
url: https://artemis.apache.org
start_page: user-manual::index.adoc
content:
sources:
- url: ..
branches: [HEAD]
start_path: docs/user-manual
- url: ..
branches: [HEAD]
start_path: docs/hacking-guide
- url: ..
branches: [HEAD]
start_path: docs/migration-guide
ui:
bundle:
url: https://github.com/jbertram/artemis-antora-ui/releases/download/0.1/ui-bundle.zip
antora:
extensions:
- require: '@antora/lunr-extension'
index_latest_only: true
index_by_heading: true
asciidoc:
attributes:
sectnums: ''
project-name-full: Apache Artemis
project-name-full-url: apache-artemis
project-name-short: Artemis
project-version: ${project-version}
log4j-version: ${log4j-version}
artemis-console-version: ${artemis-console-version}
output:
dir: target/site
331 changes: 49 additions & 282 deletions artemis-website/pom.xml

Large diffs are not rendered by default.

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
6 changes: 6 additions & 0 deletions docs/hacking-guide/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: hacking-guide
title: Hacking Guide
version: ~ # version is essentially ignored since we always just deploy the latest
start_page: ROOT:index.adoc
nav:
- modules/ROOT/nav.adoc
Binary file removed docs/hacking-guide/images/favicon.png
Binary file not shown.
12 changes: 0 additions & 12 deletions docs/hacking-guide/index.adoc

This file was deleted.

8 changes: 8 additions & 0 deletions docs/hacking-guide/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
* xref:code.adoc[Code Conventions]
* xref:building.adoc[Building]
* xref:tests.adoc[Tests]
* xref:code-coverage-report.adoc[Code Coverage Report]
* xref:validating-releases.adoc[Validating Releases]
* xref:maintainers.adoc[Maintainers]
* xref:history.adoc[History]
* xref:notice.adoc[Legal Notice]
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,8 @@ From the `artemis-website` module run:
----
$ mvn -Prelease package
----
This will build the user manual (both HTML & PDF), migration guide, hacking guide, & JavaDocs.
Output will be placed in the `target/classes/user-manual`, `target/classes/migration-guide`, `target/classes/hacking-guide`, and `target/apidocs` directories respectively.

Generating the user manual's PDF adds almost a minute to the build so this can be skipped using `-DskipWebsitePdfGeneration`.
This will build the JavaDoc, user manual, migration guide, & hacking guide.
JavaDoc output will be placed in the `target/apidocs` directory and the rest will be put into the `target/site` directory.

== Offline

Expand Down
1 change: 1 addition & 0 deletions docs/hacking-guide/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This hacking guide outlines how developers can get involved in contributing to the {project-name-full} project.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ $ mvn -Pdev install
----
== Commit Messages

Please ensure the commit messages follow the 50/72 format as described xref:_code.adoc#commitMessageDetails[here].
Please ensure the commit messages follow the 50/72 format as described xref:code.adoc#commitMessageDetails[here].
This format follows the recommendation from the https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project[official Git book].

== Configuring Git repositories
Expand Down
6 changes: 6 additions & 0 deletions docs/migration-guide/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: migration-guide

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Rather than integrating this I'd be thinking instead about removing it.

Its not updated. Tooling it references is not maintained. Its a different project now. Although a copy is on the site, the site does not link to it at all (the dir is mentioned once in the hacking-guide) so its only available by redirect from old links. The version on the site was published with gitbook, which we havent used for several years (is this the third docs build change since then?).

title: Migration Guide
version: ~ # version is essentially ignored since we always just deploy the latest
start_page: ROOT:index.adoc
nav:
- modules/ROOT/nav.adoc
Binary file removed docs/migration-guide/images/favicon.png
Binary file not shown.
15 changes: 0 additions & 15 deletions docs/migration-guide/index.adoc

This file was deleted.

11 changes: 11 additions & 0 deletions docs/migration-guide/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
* xref:preface.adoc[Preface]
* xref:key-differences.adoc[Key Differences]
* xref:configuration.adoc[Configuration]
* xref:connectors.adoc[Connectors]
* xref:destinations.adoc[Destinations]
* xref:virtual-topics.adoc[Virtual Topics]
* xref:authentication.adoc[Authentication]
* xref:authorization.adoc[Authorization]
* xref:ssl.adoc[SSL]
* xref:message-store.adoc[Message Store]
* xref:notice.adoc[Legal Notice]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Destinations

We already talked about addressing differences between ActiveMQ and {project-name-short} in the xref:README.adoc[introduction].
We already talked about addressing differences between ActiveMQ and {project-name-short} in the xref:preface.adoc[preface].
Now let's dig into the details and see how to configure JMS queues and topics.
It's important to note here that both brokers are configured by default to _auto-create_ destinations requested by clients, which is preferred behavior for many use cases.
This is configured using authorization security policies, so we will cover this topic in the later sections of this manual.
Expand Down
1 change: 1 addition & 0 deletions docs/migration-guide/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This guide outlines how users can migrate an existing ActiveMQ broker installation to {project-name-short}.
11 changes: 0 additions & 11 deletions docs/resources/README.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/resources/font-awesome/css/LICENSE-font-awesome-css.txt

This file was deleted.

Loading