Skip to content

Commit

Permalink
- 4.0.2
Browse files Browse the repository at this point in the history
- restructure documentation
  • Loading branch information
conapi-stefan committed Jul 26, 2024
1 parent 4c1a363 commit b362a56
Show file tree
Hide file tree
Showing 31 changed files with 130 additions and 53 deletions.
5 changes: 3 additions & 2 deletions docs/docs/changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
sidebar_label: '📝 Changelog'
sidebar_position: 7
description: Changelogs for the latest releases
keywords: [changelog]
hide_table_of_contents: true
Expand All @@ -10,7 +9,9 @@ hide_table_of_contents: true

Below are the changelogs for the latest releases of the Message Manager:


4.0.2 - 2024-07-26
- Allow Security Protocol selection for Kafka connections
- Updated documentation structure

4.0.1 - 2024-07-24
- Show improved error messages for class loading issues and link to the documentation
Expand Down
8 changes: 0 additions & 8 deletions docs/docs/faqs/faqs.mdx

This file was deleted.

11 changes: 11 additions & 0 deletions docs/docs/faqs/support.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# How To Get Support?

Customers with an active subscription can reach our support team via:
- Email: [support@conapi.at](mailto:support@conapi.at)
- Web: [https://conapi.at/support](https://conapi.at/support)

:::info

If you are evaluating (during the 30 days trial) the software and have questions, feel free to reach out to us.

:::
7 changes: 7 additions & 0 deletions docs/docs/features/01-multibroker.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_label: 'Multi-Broker Support'
---

# Multi-Broker Connectivity

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
12 changes: 12 additions & 0 deletions docs/docs/features/02-queuebrowser.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Queue Browser

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)

- broker selection
- queue list and filter
- message view (refresh, delete, save/export)
- drag and drop (if supported by the broker)
- search
- message details, including: headers, properties, content
see also:
- [Message Viewer](./message.mdx)
3 changes: 3 additions & 0 deletions docs/docs/features/03-topicsubscriber.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Topic Subscriber

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 3 additions & 0 deletions docs/docs/features/04-messagesender.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Message Sender

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 3 additions & 0 deletions docs/docs/features/importexport.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Import/Export of Messages

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
5 changes: 5 additions & 0 deletions docs/docs/features/message.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Message Viewer

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)

Common for queue browser and topic subscriber
3 changes: 1 addition & 2 deletions docs/docs/intro.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
sidebar_label: '💻 Introduction'
sidebar_position: 1
description: Message Manager
keywords: [introduction, intro, message]
---

# Message Manager Introduction

Coming soon...
Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 3 additions & 0 deletions docs/docs/setup/01-overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Overview

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 3 additions & 0 deletions docs/docs/setup/02-settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Settings

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 3 additions & 0 deletions docs/docs/setup/activemq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Apache ActiveMQ

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 3 additions & 0 deletions docs/docs/setup/aws.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AWS SQS/SNS

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 3 additions & 0 deletions docs/docs/setup/kafka.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Apache Kafka

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
8 changes: 0 additions & 8 deletions docs/docs/setup/setup.mdx

This file was deleted.

3 changes: 3 additions & 0 deletions docs/docs/setup/solace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Solace PubSub+ / Solace JMS

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 3 additions & 0 deletions docs/docs/setup/sonic.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Aurea Messenger / SonicMQ

Documentation coming soon... ask us meanwhile: [support@conapi.at](mailto:support@conapi.at)
3 changes: 0 additions & 3 deletions docs/docs/troubleshooting/howto-classloadingissue.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
sidebar_label: 'How To Fix Class Loading Issues'
---
import ReactPlayer from 'react-player'
import useBaseUrl from '@docusaurus/useBaseUrl';

Expand Down
8 changes: 0 additions & 8 deletions docs/docs/troubleshooting/troubleshooting.mdx

This file was deleted.

1 change: 1 addition & 0 deletions docs/run.cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npm run start
50 changes: 43 additions & 7 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,56 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
mmSidebar: [{type: 'autogenerated', dirName: '.'}],
// mmSidebar: [{type: 'autogenerated', dirName: '.'}],

// But you can create a sidebar manually
/*
tutorialSidebar: [

mmSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
label: '🌉 Setup',
items: [
{
type: "autogenerated",
dirName: "setup",
//exclude: ["index"]
}
],
},
{
type: 'category',
label: '🪄 Features',
items: [
{
type: "autogenerated",
dirName: "features",
}
],
},
{
type: 'category',
label: '🛠️ Troubleshooting',
items: [
{
type: "autogenerated",
dirName: "troubleshooting",
}
],
},
{
type: 'category',
label: '❓FAQs',
items: [
{
type: "autogenerated",
dirName: "faqs"
}
],
},
'changelog'
],
*/

};

export default sidebars;
4 changes: 2 additions & 2 deletions docs/src/components/HomepageFeatures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import Heading from '@theme/Heading';
import styles from './styles.module.css';

const FeatureList = [
{
/* {
title: 'Easy to Use',
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
description: (
Expand Down Expand Up @@ -32,7 +32,7 @@ const FeatureList = [
be extended while reusing the same header and footer.
</>
),
},
},*/
];

function Feature({Svg, title, description}) {
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function HomepageHeader() {
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Docusaurus Tutorial - 5min ⏱️
Introduction - 5min ⏱️
</Link>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
group=nl.queuemanager
version=4.0.1
version=4.0.2
description='Message Manager'
mmbuild=dev
org.gradle.console=verbose
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ public static synchronized String getVersion() {
return VERSION;
}

public static final String VERSION = "4.0.1";
public static final String VERSION = "4.0.2";
//public static final String SUFFIX = "${suffix}";
public static final String BUILD_TIMESTAMP = "Wed Jul 24 16:09:36 CEST 2024";
public static final String BUILD_ID = "4.0.1";
public static final String BUILD_TIMESTAMP = "Fri Jul 26 16:00:00 CEST 2024";
public static final String BUILD_ID = "4.0.2";
}
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ private void runApplication(){

alert.setHeaderText("Update required");
alert.setContentText("Application is not up-to-date, update now?");

//TODO: would be nice to show a changelog here
alert.getButtonTypes().setAll(updateAndLaunch, skipAndLaunch, alwaysAndLaunch);
result = alert.showAndWait();
if(result.get() == alwaysAndLaunch){
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ public static synchronized String getVersion() {
return VERSION;
}

public static final String VERSION = "4.0.1";
public static final String VERSION = "4.0.2";
//public static final String SUFFIX = "${suffix}";
public static final String BUILD_TIMESTAMP = "Wed Jul 24 16:09:36 CEST 2024";
public static final String BUILD_ID = "4.0.1";
public static final String BUILD_TIMESTAMP = "Fri Jul 26 16:00:00 CEST 2024";
public static final String BUILD_ID = "4.0.2";
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ public static synchronized String getVersion() {
return VERSION;
}

public static final String VERSION = "4.0.1";
public static final String VERSION = "4.0.2";
//public static final String SUFFIX = "${suffix}";
public static final String BUILD_TIMESTAMP = "Wed Jul 24 16:09:36 CEST 2024";
public static final String BUILD_ID = "4.0.1";
public static final String BUILD_TIMESTAMP = "Fri Jul 26 15:59:53 CEST 2024";
public static final String BUILD_ID = "4.0.2";
}
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ private String getHTML() {
" \n" +
" <ul>\n" +
" <li>Email: <a href=\"mailto:support@conapi.at\">support@conapi.at</a></li>\n" +
" <li>Web Form: <a href=\"https://www.conapi.at/support/\">https://www.conapi.at/support/</a></li>\n" +
" <li>Web: <a href=\"https://www.conapi.at/support/\">https://www.conapi.at/support/</a></li>\n" +
" </ul>\n" +
"</div>";
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ private String getHTML() {
" <li>Licensed Plugins/Features:\n"+
" <ul><li>Copyright (c) 2024 conapi GmbH. All rights reserved.</li><li>Licensed under conapi GmbH terms of use.</li></ul></li>\n" +
" </ul>\n" +
" <p>Documentation: <a href=\"https://conapi-oss.github.io/messagemanager\">https://conapi-oss.github.io/messagemanager</a></p>\n" +
" <p>Website: <a href=\"https://www.conapi.at/message-manager\">https://www.conapi.at/message-manager</a></p>\n" +

"</div>";

//TODO"Documentation: <a href='https://www.conapi.at/message-manager/documentation'>https://www.conapi.at/message-manager/documentation</a><br/>"+
Expand Down

0 comments on commit b362a56

Please sign in to comment.